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
Method Summary |
java.nio.channels.ReadableByteChannel |
getChannel()
Returns a channel 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.nio.channels.WritableByteChannel writableChannel)
Writes the representation to a byte channel. |
Methods inherited from class org.restlet.representation.Representation |
checkDigest, checkDigest, computeDigest, createEmpty, exhaust, getAvailableSize, getDigest, getDisposition, getDownloadName, getExpirationDate, getRange, getReader, getSize, 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 |
CharacterRepresentation
public CharacterRepresentation(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
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.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
Copyright © 2005-2013 Restlet S.A.S..