Package org.restlet.data

Class Encoding

java.lang.Object
org.restlet.data.Metadata
org.restlet.data.Encoding
public final class Encoding extends Metadata
Modifier of a representation's media type. Useful to apply compression without losing the identity of the underlying media type.
Author:
Jerome Louvel

  • Field Details

    • ALL

      public static final Encoding ALL
      All encodings acceptable.

    • COMPRESS

      public static final Encoding COMPRESS
      The common Unix file compression.

    • DEFLATE

      public static final Encoding DEFLATE
      The zlib format defined by RFC 1950 and 1951.

    • DEFLATE_NOWRAP

      public static final Encoding DEFLATE_NOWRAP
      The zlib format defined by RFC 1950 and 1951, without wrapping.

    • FREEMARKER

      public static final Encoding FREEMARKER
      The FreeMarker encoding.

    • GZIP

      public static final Encoding GZIP
      The GNU Zip encoding.

    • IDENTITY

      public static final Encoding IDENTITY
      The default (identity) encoding.

    • VELOCITY

      public static final Encoding VELOCITY
      The Velocity encoding.

    • ZIP

      public static final Encoding ZIP
      The Info-Zip encoding.

  • Constructor Details

    • Encoding

      public Encoding(String name)
      Constructor.
      Parameters:
      name - The name.

    • Encoding

      public Encoding(String name, String description)
      Constructor.
      Parameters:
      name - The name.
      description - The description.

  • Method Details

    • valueOf

      public static Encoding valueOf(String name)
      Returns the encoding associated to a name. If an existing constant exists then it is returned, otherwise a new instance is created.
      Parameters:
      name - The name.
      Returns:
      The associated encoding.

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class Metadata

    • getParent

      public Metadata getParent()
      Description copied from class: Metadata
      Returns the parent metadata if available or null.
      Specified by:
      getParent in class Metadata
      Returns:
      The parent metadata.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Metadata

    • includes

      public boolean includes(Metadata included)
      Indicates if a given encoding is included in the current one. The test is true if both encodings are equal or if the given encoding is within the range of the current one. For example, ALL includes all encodings. A null encoding is considered as included into the current one.

      Examples:

      • ALL.includes(COMPRESS) returns true
      • COMPRESS.includes(ALL) returns false
      Specified by:
      includes in class Metadata
      Parameters:
      included - The encoding to test for inclusion.
      Returns:
      True if the given encoding is included in the current one.
      See Also: