org.restlet.representation
Class StreamRepresentation
java.lang.Object
org.restlet.representation.Variant
org.restlet.representation.RepresentationInfo
org.restlet.representation.Representation
org.restlet.representation.StreamRepresentation
- Direct Known Subclasses:
- InputRepresentation, OutputRepresentation
public abstract class StreamRepresentation
- extends Representation
Representation based on a BIO stream.
- Author:
- Jerome Louvel
Method Summary |
java.nio.channels.ReadableByteChannel |
getChannel()
Returns a channel with the representation's content. |
java.io.Reader |
getReader()
Returns a characters reader with the representation's content. |
void |
write(java.nio.channels.WritableByteChannel writableChannel)
Writes the representation to a byte channel. |
void |
write(java.io.Writer writer)
Writes the representation to a characters writer. |
Methods inherited from class org.restlet.representation.Representation |
checkDigest, checkDigest, computeDigest, createEmpty, exhaust, getAvailableSize, getDigest, getDisposition, getDownloadName, getExpirationDate, getRange, getSize, getStream, getText, isAvailable, isDownloadable, isTransient, release, setAvailable, setDigest, setDisposition, setDownloadable, setDownloadName, setExpirationDate, setRange, setSize, setTransient, write |
Methods inherited from class org.restlet.representation.Variant |
createClientInfo, equals, getCharacterSet, getEncodings, getIdentifier, getLanguages, getLocationRef, getMediaType, includes, isCompatible, setCharacterSet, setEncodings, setIdentifier, setIdentifier, setLanguages, setLocationRef, setLocationRef, setMediaType, toString |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
StreamRepresentation
public StreamRepresentation(MediaType mediaType)
- Constructor.
- Parameters:
mediaType
- The media type.
getChannel
public java.nio.channels.ReadableByteChannel getChannel()
throws java.io.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:
java.io.IOException
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
write
public void write(java.nio.channels.WritableByteChannel writableChannel)
throws java.io.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:
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
Copyright © 2005-2013 Restlet S.A.S..