org.restlet.representation
Class CharacterRepresentation

java.lang.Object
  org.restlet.representation.Variant
      org.restlet.representation.RepresentationInfo
          org.restlet.representation.Representation
              org.restlet.representation.CharacterRepresentation

Direct Known Subclasses:

ReaderRepresentation, StringRepresentation, WriterRepresentation

public abstract class CharacterRepresentation
extends Representation

Representation based on a BIO character stream.

Author:

Jerome Louvel

Field Summary

Fields inherited from class org.restlet.representation.Representation

UNKNOWN_SIZE

Constructor Summary

CharacterRepresentation(MediaType mediaType)
Constructor.

Method Summary

ReadableByteChannel	getChannel() Returns a channel with the representation's content.
InputStream	getStream() Returns a stream with the representation's content.
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.representation.Representation

append, exhaust, getAvailableSize, getDigest, getDisposition, getExpirationDate, getRange, getReader, getRegistration, getSize, getText, hasKnownSize, isAvailable, isEmpty, isSelectable, isTransient, release, setAvailable, setDigest, setDisposition, setExpirationDate, setListener, setRange, setSize, setTransient, write

Methods inherited from class org.restlet.representation.RepresentationInfo

getModificationDate, getTag, setModificationDate, setTag

Methods inherited from class org.restlet.representation.Variant

createClientInfo, equals, getCharacterSet, getEncodings, getLanguages, getLocationRef, getMediaType, includes, isCompatible, setCharacterSet, setEncodings, setLanguages, setLocationRef, setLocationRef, setMediaType, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CharacterRepresentation

public CharacterRepresentation(MediaType mediaType)

Constructor.

Parameters:

mediaType - The media type.

Method Detail

getChannel

public ReadableByteChannel getChannel()
                               throws IOException

Description copied from class: Representation

Returns a channel with the representation's content. If it is supported by a file, a read-only instance of FileChannel is returned.
This method is ensured to return a fresh channel for each invocation unless it is a transient representation, in which case null is returned.

Specified by:

getChannel in class Representation

Returns:

A channel with the representation's content.

Throws:

IOException

getStream

public InputStream getStream()
                      throws IOException

Description copied from class: Representation

Returns a stream with the representation's content. This method is ensured to return a fresh stream for each invocation unless it is a transient representation, in which case null is returned.

Specified by:

getStream in class Representation

Returns:

A stream with the representation's content.

Throws:

IOException

write

public void write(OutputStream outputStream)
           throws IOException

Description copied from class: Representation

Writes the representation to a byte stream. This method is ensured to write the full content for each invocation unless it is a transient representation, in which case an exception is thrown.

Note that the class implementing this method shouldn't flush or close the given OutputStream after writing to it as this will be handled by the Restlet connectors automatically. However, if outputStream is wrapped with an object which is Flushable such as a OutputStreamWriter make sure the wrapping object is flushed before the method returns.

Specified by:

write in class Representation

Parameters:

outputStream - The output stream.

Throws:

IOException

write

public void write(WritableByteChannel writableChannel)
           throws IOException

Description copied from class: Representation

Writes the representation to a byte channel. This method is ensured to write the full content for each invocation unless it is a transient representation, in which case an exception is thrown.

Specified by:

write in class Representation

Parameters:

writableChannel - A writable byte channel.

Throws:

IOException