Package org.pgpainless.algorithm

Enum CompressionAlgorithm

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static CompressionAlgorithm fromId​(int id)
      Return the CompressionAlgorithm value that corresponds to the provided numerical id.
      int getAlgorithmId()
      Return the numerical algorithm tag corresponding to this compression algorithm.
      static CompressionAlgorithm valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static CompressionAlgorithm[] 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

    • Method Detail

      • values

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

      • valueOf

        public static CompressionAlgorithm 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

        public static CompressionAlgorithm fromId​(int id)
        Return the CompressionAlgorithm value that corresponds to the provided numerical id. If an invalid id is provided, null is returned.
        Parameters:
        id - id
        Returns:
        compression algorithm

      • getAlgorithmId

        public int getAlgorithmId()
        Return the numerical algorithm tag corresponding to this compression algorithm.
        Returns:
        id