Package org.pgpainless.algorithm

Enum HashAlgorithm

    • Method Detail

      • values

        public static HashAlgorithm[] 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 (HashAlgorithm c : HashAlgorithm.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static HashAlgorithm valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • fromId

        @Nullable
public static HashAlgorithm fromId​(int id)
        Return the HashAlgorithm value that corresponds to the provided algorithm id. If an invalid algorithm id was provided, null is returned.
        Parameters:
        id - numeric id
        Returns:
        enum value

      • requireFromId

        @Nonnull
public static HashAlgorithm requireFromId​(int id)
        Return the HashAlgorithm value that corresponds to the provided algorithm id. If an invalid algorithm id was provided, throw a NoSuchElementException.
        Parameters:
        id - algorithm id
        Returns:
        enum value
        Throws:
        java.util.NoSuchElementException - in case of an unknown algorithm id

      • fromName

        @Nullable
public static HashAlgorithm fromName​(java.lang.String name)
        Return the HashAlgorithm value that corresponds to the provided name. If an invalid algorithm name was provided, null is returned.
        Parameters:
        name - text name
        Returns:
        enum value
        See Also:
        RFC4880: ยง9.4 Hash Algorithms for a list of algorithms and names.

      • getAlgorithmId

        public int getAlgorithmId()
        Return the numeric algorithm id of the hash algorithm.
        Returns:
        numeric id

      • getAlgorithmName

        public java.lang.String getAlgorithmName()
        Return the text name of the hash algorithm.
        Returns:
        text name