001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *     http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing,
013     * software distributed under the License is distributed on an
014     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     * KIND, either express or implied.  See the License for the
016     * specific language governing permissions and limitations
017     * under the License.
018     */
019    package org.apache.shiro.crypto.hash.format;
020    
021    import org.apache.shiro.crypto.hash.Hash;
022    
023    /**
024     * A {@code ParsableHashFormat} is able to parse a formatted string and convert it into a {@link Hash} instance.
025     * <p/>
026     * This interface exists to represent {@code HashFormat}s that can offer two-way conversion
027     * (Hash -&gt; String, String -&gt; Hash) capabilities.  Some HashFormats, such as many {@link ModularCryptFormat}s
028     * (like Unix Crypt(3)) only support one way conversion and therefore wouldn't implement this interface.
029     *
030     * @see Shiro1CryptFormat
031     *
032     * @since 1.2
033     */
034    public interface ParsableHashFormat extends HashFormat {
035    
036        /**
037         * Parses the specified formatted string and returns the corresponding Hash instance.
038         *
039         * @param formatted the formatted string representing a Hash.
040         * @return the corresponding Hash instance.
041         */
042        Hash parse(String formatted);
043    }