org.restlet.resource
Class WritableRepresentation
java.lang.Object
org.restlet.resource.Variant
org.restlet.resource.Representation
org.restlet.resource.ChannelRepresentation
org.restlet.resource.WritableRepresentation
public abstract class WritableRepresentation
- extends ChannelRepresentation
Representation based on a writable NIO byte channel. This class is a good
basis to write your own representations, especially for the dynamic and large
ones.
For this you just need to create a subclass and override the abstract
Representation.write(WritableByteChannel) method. This method will later be
called back by the connectors when the actual representation's content is
needed.
- Author:
- Jerome Louvel
Method Summary |
java.nio.channels.ReadableByteChannel |
getChannel()
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. |
void |
release()
Calls parent's implementation. |
abstract void |
write(java.nio.channels.WritableByteChannel writableChannel)
Writes the representation to a byte channel. |
Methods inherited from class org.restlet.resource.Representation |
checkDigest, checkDigest, computeDigest, createEmpty, exhaust, getAvailableSize, getDigest, getDownloadName, getExpirationDate, getModificationDate, getRange, getSize, getTag, getText, isAvailable, isDownloadable, isTransient, setAvailable, setDigest, setDownloadable, setDownloadName, setExpirationDate, setModificationDate, setRange, setSize, setTag, setTransient |
Methods inherited from class org.restlet.resource.Variant |
getCharacterSet, getEncodings, getIdentifier, getLanguages, getMediaType, setCharacterSet, setEncodings, setIdentifier, setIdentifier, setLanguages, setMediaType |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
WritableRepresentation
public WritableRepresentation(MediaType mediaType)
- Constructor.
- Parameters:
mediaType
- The representation's 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
release
public void release()
- Calls parent's implementation.
- Overrides:
release
in class Representation
write
public abstract 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-2008 Noelios Technologies.