Package org.restlet.representation

Class ChannelRepresentation

java.lang.Object

org.restlet.representation.Variant

org.restlet.representation.RepresentationInfo

org.restlet.representation.Representation

org.restlet.representation.ChannelRepresentation

Direct Known Subclasses:

ReadableRepresentation, WritableRepresentation

public abstract class ChannelRepresentation
extends Representation

Representation based on a NIO byte channel.

Author:

Jerome Louvel

Field Summary

Fields inherited from class org.restlet.representation.Representation

UNKNOWN_SIZE

Constructor Summary

Constructors

Constructor	Description
ChannelRepresentation(MediaType mediaType)	Constructor.

Method Summary

Modifier and Type	Method	Description
java.io.Reader	getReader()	Returns a characters reader with the representation's content.
java.io.InputStream	getStream()	Returns a stream with the representation's content.
void	write(java.io.OutputStream outputStream)	Writes the representation to a byte stream.
void	write(java.io.Writer writer)	Writes the representation to a characters writer.

Methods inherited from class org.restlet.representation.Representation

append, exhaust, getAvailableSize, getChannel, getDigest, getDisposition, getExpirationDate, getRange, getSize, getText, hasKnownSize, isAvailable, isEmpty, isTransient, release, setAvailable, setDigest, setDisposition, setExpirationDate, 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, hashCode, includes, isCompatible, setCharacterSet, setEncodings, setLanguages, setLocationRef, setLocationRef, setMediaType, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelRepresentation

public ChannelRepresentation(MediaType mediaType)

Constructor.

Parameters:

mediaType - The media type.

Method Detail

getReader

public java.io.Reader getReader()
                         throws java.io.IOException

Description copied from class: Representation

Returns a characters 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.

Specified by:

getReader in class Representation

Returns:

A reader with the representation's content.

Throws:

java.io.IOException

getStream

public java.io.InputStream getStream()
                              throws java.io.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:

java.io.IOException

write

public void write(java.io.OutputStream outputStream)
           throws java.io.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.

Specified by:

write in class Representation

Parameters:

outputStream - The output stream.

Throws:

java.io.IOException

write

public void write(java.io.Writer writer)
           throws java.io.IOException

Description copied from class: Representation

Writes the representation to a characters writer. 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 Writer after writing to it as this will be handled by the Restlet connectors automatically.

Specified by:

write in class Representation

Parameters:

writer - The characters writer.

Throws:

java.io.IOException