org.restlet.engine.application
Class EncodeRepresentation

java.lang.Object
  org.restlet.representation.Variant
      org.restlet.representation.RepresentationInfo
          org.restlet.representation.Representation
              org.restlet.util.WrapperRepresentation
                  org.restlet.engine.application.EncodeRepresentation

public class EncodeRepresentation
extends WrapperRepresentation

Content that encodes a wrapped content. Allows to apply only one encoding.

Author:

Jerome Louvel

Field Summary

Fields inherited from class org.restlet.representation.Representation

UNKNOWN_SIZE

Constructor Summary

EncodeRepresentation(Encoding encoding, Representation wrappedRepresentation)
Constructor.

Method Summary

boolean	canEncode() Indicates if the encoding can happen.
long	getAvailableSize() Returns the available size in bytes of the encoded representation if known, UNKNOWN_SIZE (-1) otherwise.
ReadableByteChannel	getChannel() Returns a readable byte channel.
List<Encoding>	getEncodings() Returns the applied encodings.
Reader	getReader()
long	getSize() Returns the size in bytes of the encoded representation if known, UNKNOWN_SIZE (-1) otherwise.
InputStream	getStream()
static List<Encoding>	getSupportedEncodings() Returns the list of supported encodings.
String	getText()
void	write(OutputStream outputStream)
void	write(WritableByteChannel writableChannel)
void	write(Writer writer)

Methods inherited from class org.restlet.util.WrapperRepresentation

exhaust, getCharacterSet, getDigest, getDisposition, getExpirationDate, getLanguages, getLocationRef, getMediaType, getModificationDate, getRange, getRegistration, getTag, getWrappedRepresentation, isAvailable, isSelectable, isTransient, release, setAvailable, setCharacterSet, setDigest, setDisposition, setEncodings, setExpirationDate, setLanguages, setLocationRef, setLocationRef, setMediaType, setModificationDate, setRange, setSize, setTag, setTransient

Methods inherited from class org.restlet.representation.Representation

append, hasKnownSize, isEmpty, setListener

Methods inherited from class org.restlet.representation.Variant

createClientInfo, equals, includes, isCompatible, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EncodeRepresentation

public EncodeRepresentation(Encoding encoding,
                            Representation wrappedRepresentation)

Constructor.

Parameters:

encoding - Encoder algorithm.

wrappedRepresentation - The wrapped representation.

Method Detail

getSupportedEncodings

public static List<Encoding> getSupportedEncodings()

Returns the list of supported encodings.

Returns:

The list of supported encodings.

canEncode

public boolean canEncode()

Indicates if the encoding can happen.

Returns:

True if the encoding can happen.

getAvailableSize

public long getAvailableSize()

Returns the available size in bytes of the encoded representation if known, UNKNOWN_SIZE (-1) otherwise.

Overrides:

getAvailableSize in class WrapperRepresentation

Returns:

The available size in bytes if known, UNKNOWN_SIZE (-1) otherwise.

getChannel

public ReadableByteChannel getChannel()
                               throws IOException

Returns a readable byte channel. If it is supported by a file a read-only instance of FileChannel is returned.

Overrides:

getChannel in class WrapperRepresentation

Returns:

A readable byte channel.

Throws:

IOException

getEncodings

public List<Encoding> getEncodings()

Returns the applied encodings.

Overrides:

getEncodings in class WrapperRepresentation

Returns:

The applied encodings.

getReader

public Reader getReader()
                 throws IOException

Overrides:

getReader in class WrapperRepresentation

Throws:

IOException

getSize

public long getSize()

Returns the size in bytes of the encoded representation if known, UNKNOWN_SIZE (-1) otherwise.

Overrides:

getSize in class WrapperRepresentation

Returns:

The size in bytes if known, UNKNOWN_SIZE (-1) otherwise.

getStream

public InputStream getStream()
                      throws IOException

Overrides:

getStream in class WrapperRepresentation

Throws:

IOException

getText

public String getText()
               throws IOException

Overrides:

getText in class WrapperRepresentation

Throws:

IOException

write

public void write(Writer writer)
           throws IOException

Overrides:

write in class WrapperRepresentation

Throws:

IOException

write

public void write(OutputStream outputStream)
           throws IOException

Overrides:

write in class WrapperRepresentation

Throws:

IOException

write

public void write(WritableByteChannel writableChannel)
           throws IOException

Overrides:

write in class WrapperRepresentation

Throws:

IOException