com.noelios.restlet.application
Class EncodeRepresentation

java.lang.Object
  extended by org.restlet.resource.Variant
      extended by org.restlet.resource.Representation
          extended by org.restlet.util.WrapperRepresentation
              extended by com.noelios.restlet.application.EncodeRepresentation

public class EncodeRepresentation
extends WrapperRepresentation

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

Author:
Jerome Louvel (contact@noelios.com)

Field Summary
 
Fields inherited from class org.restlet.resource.Variant
UNKNOWN_SIZE
 
Constructor Summary
EncodeRepresentation(Encoding encoding, Representation wrappedRepresentation)
          Constructor.
 
Method Summary
 boolean canEncode()
          Indicates if the encoding can happen.
 ReadableByteChannel getChannel()
          Returns a readable byte channel.
 List<Encoding> getEncodings()
          Returns the applied encodings.
 long getSize()
          Returns the size in bytes of the encoded representation if known, UNKNOWN_SIZE (-1) otherwise.
 InputStream getStream()
          Returns a stream with the representation's content.
static List<Encoding> getSupportedEncodings()
          Returns the list of supported encodings.
 String getText()
          Converts the representation to a string value.
 void write(OutputStream outputStream)
          Writes the representation to a byte stream.
 void write(WritableByteChannel writableChannel)
          Writes the representation to a byte channel.
 
Methods inherited from class org.restlet.util.WrapperRepresentation
getCharacterSet, getExpirationDate, getIdentifier, getLanguages, getMediaType, getModificationDate, getTag, getWrappedRepresentation, isAvailable, isTransient, setAvailable, setCharacterSet, setExpirationDate, setIdentifier, setIdentifier, setMediaType, setModificationDate, setSize, setTag, setTransient
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EncodeRepresentation

public EncodeRepresentation(Encoding encoding,
                            Representation wrappedRepresentation)
Constructor.

Parameters:
encoding - Encoder algorithm.
wrappedRepresentation - The wrapped representation.
Method Detail

canEncode

public boolean canEncode()
Indicates if the encoding can happen.

Returns:
True if the encoding can happen.

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.

getEncodings

public List<Encoding> getEncodings()
Returns the applied encodings.

Overrides:
getEncodings in class WrapperRepresentation
Returns:
The applied encodings.

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

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

write

public void write(WritableByteChannel writableChannel)
           throws IOException
Writes the representation to a byte channel.

Overrides:
write in class WrapperRepresentation
Parameters:
writableChannel - A writable byte channel.
Throws:
IOException

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

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

getSupportedEncodings

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

Returns:
The list of supported encodings.


Copyright © 2005-2007 Noelios Technologies.