Package com.nimbusds.jose

Class CompressionAlgorithm

  • All Implemented Interfaces:
    Serializable
    @Immutable
public final class CompressionAlgorithm
extends Object
implements Serializable
    Compression algorithm name, represents the zip header parameter in JSON Web Encryption (JWE) objects. This class is immutable.

    Includes a constant for the standard DEFLATE compression algorithm:

    Additional compression algorithm names can be defined using the constructor.

    Version:
    2013-01-15
    Author:
    Vladimir Dzhuvinov
    See Also:
    Serialized Form

    • Field Detail

      • DEF

        public static final CompressionAlgorithm DEF
        DEFLATE Compressed Data Format Specification version 1.3, as described in RFC 1951.

    • Constructor Detail

      • CompressionAlgorithm

        public CompressionAlgorithm​(String name)
        Creates a new compression algorithm with the specified name.
        Parameters:
        name - The compression algorithm name. Must not be null.

    • Method Detail

      • getName

        public String getName()
        Gets the name of this compression algorithm.
        Returns:
        The compression algorithm name.

      • hashCode

        public int hashCode()
        Overrides Object.hashCode().
        Overrides:
        hashCode in class Object
        Returns:
        The object hash code.

      • equals

        public boolean equals​(Object object)
        Overrides Object.equals().
        Overrides:
        equals in class Object
        Parameters:
        object - The object to compare to.
        Returns:
        true if the objects have the same value, otherwise false.

      • toString

        public String toString()
        Returns the string representation of this compression algorithm.
        Overrides:
        toString in class Object
        Returns:
        The string representation.
        See Also:
        getName()

      • toJSONString

        public String toJSONString()
        Returns the JSON string representation of this compression algorithm.
        Returns:
        The JSON string representation.