1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, 13 * software distributed under the License is distributed on an 14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 * KIND, either express or implied. See the License for the 16 * specific language governing permissions and limitations 17 * under the License. 18 */ 19 package org.apache.shiro.crypto.hash.format; 20 21 import org.apache.shiro.crypto.hash.Hash; 22 23 /** 24 * A {@code HashFormat} is able to format a {@link Hash} instance into a well-defined formatted String. 25 * <p/> 26 * Note that not all HashFormat algorithms are reversible. That is, they can't be parsed and reconstituted to the 27 * original Hash instance. The traditional <a href="http://en.wikipedia.org/wiki/Crypt_(Unix)"> 28 * Unix crypt(3)</a> is one such format. 29 * <p/> 30 * The formats that <em>are</em> reversible however will be represented as {@link ParsableHashFormat} instances. 31 * 32 * @see ParsableHashFormat 33 * 34 * @since 1.2 35 */ 36 public interface HashFormat { 37 38 /** 39 * Returns a formatted string representing the specified Hash instance. 40 * 41 * @param hash the hash instance to format into a String. 42 * @return a formatted string representing the specified Hash instance. 43 */ 44 String format(Hash hash); 45 }