org.restlet.resource
Class WriterRepresentation

java.lang.Object
  extended by org.restlet.resource.Variant
      extended by org.restlet.resource.Representation
          extended by org.restlet.resource.CharacterRepresentation
              extended by org.restlet.resource.WriterRepresentation

public abstract class WriterRepresentation
extends CharacterRepresentation

Representation based on a BIO characters writer. 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(Writer) method. This method will later be called back by the connectors when the actual representation's content is needed.

Author:
Jerome Louvel

Field Summary
 
Fields inherited from class org.restlet.resource.Representation
UNKNOWN_SIZE
 
Constructor Summary
WriterRepresentation(MediaType mediaType)
          Constructor.
WriterRepresentation(MediaType mediaType, long expectedSize)
          Constructor.
 
Method Summary
 java.io.Reader getReader()
          Returns a characters reader with the representation's content.
 void release()
          Calls parent's implementation.
 void write(java.io.OutputStream outputStream)
          Writes the representation to a byte stream.
 
Methods inherited from class org.restlet.resource.CharacterRepresentation
getChannel, getStream, write
 
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, write
 
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
 

Constructor Detail

WriterRepresentation

public WriterRepresentation(MediaType mediaType)
Constructor.

Parameters:
mediaType - The representation's mediaType.

WriterRepresentation

public WriterRepresentation(MediaType mediaType,
                            long expectedSize)
Constructor.

Parameters:
mediaType - The representation's mediaType.
expectedSize - The expected writer size in bytes.
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

release

public void release()
Calls parent's implementation.

Overrides:
release in class Representation

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.

Overrides:
write in class CharacterRepresentation
Parameters:
outputStream - The output stream.
Throws:
java.io.IOException


Copyright © 2005-2008 Noelios Technologies.