Package org.restlet.engine.application

Class DecodeRepresentation

java.lang.Object
org.restlet.representation.Variant
org.restlet.representation.RepresentationInfo
org.restlet.representation.Representation
org.restlet.util.WrapperRepresentation
org.restlet.engine.application.DecodeRepresentation
public class DecodeRepresentation extends WrapperRepresentation
Representation that decodes a wrapped representation if its encoding is supported. If at least one encoding of the wrapped representation is not supported, then the wrapped representation is not decoded.
Author:
Jerome Louvel

  • Constructor Details

    • DecodeRepresentation

      public DecodeRepresentation(Representation wrappedRepresentation)
      Constructor.
      Parameters:
      wrappedRepresentation - The wrapped representation.

  • Method Details

    • getSupportedEncodings

      public static List<Encoding> getSupportedEncodings()
      Returns the list of supported encodings.
      Returns:
      The list of supported encodings.

    • getAvailableSize

      public long getAvailableSize()
      Description copied from class: Representation
      Returns the size effectively available. This returns the same value as Representation.getSize() if no range is defined, otherwise it returns the size of the range using Range.getSize().
      Overrides:
      getAvailableSize in class WrapperRepresentation
      Returns:
      The available size.

    • getEncodings

      public List<Encoding> getEncodings()
      Returns the encodings applied to the entity.
      Overrides:
      getEncodings in class WrapperRepresentation
      Returns:
      The encodings applied to the entity.

    • getReader

      public Reader getReader() throws IOException
      Description copied from class: Representation
      Returns a character reader with the representation's content. This method is ensured to return a fresh reader for each invocation unless it is a transient representation, in which case null is returned. If the representation has no character set defined, the system's default one will be used.
      Overrides:
      getReader in class WrapperRepresentation
      Returns:
      A reader with the representation's content.
      Throws:
      IOException

    • getSize

      public long getSize()
      Returns the size in bytes of the decoded representation if known, UNKNOWN_SIZE (-1) otherwise.
      Overrides:
      getSize in class WrapperRepresentation
      Returns:
      The size in bytes if known, UNKNOWN_SIZE (-1) otherwise.
      See Also:

    • getStream

      public InputStream getStream() throws IOException
      Returns a stream with the representation's content.
      Overrides:
      getStream in class WrapperRepresentation
      Returns:
      A stream with the representation's content.
      Throws:
      IOException

    • getText

      public String getText() throws IOException
      Converts the representation to a string value. Be careful when using this method as the conversion of large content to a string fully stored in memory can result in OutOfMemoryErrors being thrown.
      Overrides:
      getText in class WrapperRepresentation
      Returns:
      The representation as a string value.
      Throws:
      IOException

    • isDecoding

      public boolean isDecoding()
      Indicates if the decoding can happen.
      Returns:
      True if the decoding can happen.

    • write

      public void write(OutputStream outputStream) throws IOException
      Writes the representation to a byte stream.
      Overrides:
      write in class WrapperRepresentation
      Parameters:
      outputStream - The output stream.
      Throws:
      IOException