org.apache.shiro.crypto.hash.format
Enum ProvidedHashFormat

java.lang.Object
  extended by java.lang.Enum<ProvidedHashFormat>
      extended by org.apache.shiro.crypto.hash.format.ProvidedHashFormat
All Implemented Interfaces:
Serializable, Comparable<ProvidedHashFormat>

public enum ProvidedHashFormat
extends Enum<ProvidedHashFormat>

An enum representing Shiro's default provided HashFormat implementations.

Since:
1.2

Enum Constant Summary
BASE64
          Value representing the Base64Format implementation.
HEX
          Value representing the HexFormat implementation.
SHIRO1
          Value representing the Shiro1CryptFormat implementation.
 
Method Summary
static ProvidedHashFormat byId(String id)
           
static ProvidedHashFormat valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ProvidedHashFormat[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

HEX

public static final ProvidedHashFormat HEX
Value representing the HexFormat implementation.


BASE64

public static final ProvidedHashFormat BASE64
Value representing the Base64Format implementation.


SHIRO1

public static final ProvidedHashFormat SHIRO1
Value representing the Shiro1CryptFormat implementation.

Method Detail

values

public static ProvidedHashFormat[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (ProvidedHashFormat c : ProvidedHashFormat.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static ProvidedHashFormat valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

byId

public static ProvidedHashFormat byId(String id)


Copyright © 2004-2014 The Apache Software Foundation. All Rights Reserved.