org.restlet.resource
Class OutputRepresentation

java.lang.Object
  extended by org.restlet.resource.Variant
      extended by org.restlet.resource.Representation
          extended by org.restlet.resource.StreamRepresentation
              extended by org.restlet.resource.OutputRepresentation
Direct Known Subclasses:
ObjectRepresentation, TransformRepresentation, XmlRepresentation

public abstract class OutputRepresentation
extends StreamRepresentation

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

Author:
Jerome Louvel (contact@noelios.com)

Field Summary
 
Fields inherited from class org.restlet.resource.Variant
UNKNOWN_SIZE
 
Constructor Summary
OutputRepresentation(MediaType mediaType)
          Constructor.
OutputRepresentation(MediaType mediaType, long expectedSize)
          Constructor.
 
Method Summary
 InputStream getStream()
          Returns a stream with the representation's content.
abstract  void write(OutputStream outputStream)
          Writes the representation to a byte stream.
 
Methods inherited from class org.restlet.resource.StreamRepresentation
getChannel, write
 
Methods inherited from class org.restlet.resource.Representation
getText, isAvailable, isTransient, setAvailable, setTransient
 
Methods inherited from class org.restlet.resource.Variant
getCharacterSet, getEncodings, getExpirationDate, getIdentifier, getLanguages, getMediaType, getModificationDate, getSize, getTag, setCharacterSet, setExpirationDate, setIdentifier, setIdentifier, setMediaType, setModificationDate, setSize, setTag
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OutputRepresentation

public OutputRepresentation(MediaType mediaType)
Constructor.

Parameters:
mediaType - The representation's mediaType.

OutputRepresentation

public OutputRepresentation(MediaType mediaType,
                            long expectedSize)
Constructor.

Parameters:
mediaType - The representation's mediaType.
expectedSize - The expected input stream size.
Method Detail

getStream

public InputStream getStream()
                      throws IOException
Returns a stream with the representation's content. Internally, it uses a writer thread and a pipe stream.

Specified by:
getStream in class Representation
Returns:
A stream with the representation's content.
Throws:
IOException

write

public abstract void write(OutputStream outputStream)
                    throws IOException
Writes the representation to a byte stream.

Specified by:
write in class Representation
Parameters:
outputStream - The output stream.
Throws:
IOException


Copyright © 2005-2007 Noelios Consulting.