Package org.apache.shiro.crypto.hash.format

Interface HashFormat

All Known Subinterfaces:
ModularCryptFormat, ParsableHashFormat
All Known Implementing Classes:
Base64Format, HexFormat, Shiro1CryptFormat, Shiro2CryptFormat
public interface HashFormat
A HashFormat is able to format a Hash instance into a well-defined formatted String.

Note that not all HashFormat algorithms are reversible. That is, they can't be parsed and reconstituted to the original Hash instance.

The formats that are reversible however will be represented as ParsableHashFormat instances.

Since:
1.2
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    format(Hash hash)
    Returns a formatted string representing the specified Hash instance.

  • Method Details

    • format

      String format(Hash hash)
      Returns a formatted string representing the specified Hash instance.
      Parameters:
      hash - the hash instance to format into a String.
      Returns:
      a formatted string representing the specified Hash instance.
      Throws:
      NullPointerException - if given parameter hash is null.