Restlet Framework 2.2 Snapshot
OSGi Environments

org.restlet.representation
Class ReaderRepresentation

java.lang.Object
  extended by org.restlet.representation.Variant
      extended by org.restlet.representation.RepresentationInfo
          extended by org.restlet.representation.Representation
              extended by org.restlet.representation.CharacterRepresentation
                  extended by org.restlet.representation.ReaderRepresentation

public class ReaderRepresentation
extends CharacterRepresentation

Transient representation based on a BIO characters reader.

Author:
Jerome Louvel

Field Summary
 
Fields inherited from class org.restlet.representation.Representation
UNKNOWN_SIZE
 
Constructor Summary
ReaderRepresentation(Reader reader)
          Constructor.
ReaderRepresentation(Reader reader, MediaType mediaType)
          Constructor.
ReaderRepresentation(Reader reader, MediaType mediaType, long expectedSize)
          Constructor.
 
Method Summary
 Reader getReader()
          Returns a characters reader with the representation's content.
 String getText()
          Note that this method relies on CharacterRepresentation.getStream().
 void release()
          Closes and releases the input stream.
 void setReader(Reader reader)
          Sets the reader to use.
 void write(Writer writer)
          Writes the representation to a characters writer.
 
Methods inherited from class org.restlet.representation.CharacterRepresentation
getChannel, getStream, write, write
 
Methods inherited from class org.restlet.representation.Representation
append, exhaust, getAvailableSize, getDigest, getDisposition, getExpirationDate, getRange, getRegistration, getSize, hasKnownSize, isAvailable, isEmpty, isSelectable, isTransient, setAvailable, setDigest, setDisposition, setExpirationDate, setListener, setRange, setSize, setTransient
 
Methods inherited from class org.restlet.representation.RepresentationInfo
getModificationDate, getTag, setModificationDate, setTag
 
Methods inherited from class org.restlet.representation.Variant
createClientInfo, equals, getCharacterSet, getEncodings, getLanguages, getLocationRef, getMediaType, includes, isCompatible, setCharacterSet, setEncodings, setLanguages, setLocationRef, setLocationRef, setMediaType, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ReaderRepresentation

public ReaderRepresentation(Reader reader)
Constructor.

Parameters:
reader - The representation's stream.

ReaderRepresentation

public ReaderRepresentation(Reader reader,
                            MediaType mediaType)
Constructor.

Parameters:
reader - The representation's stream.
mediaType - The representation's media type.

ReaderRepresentation

public ReaderRepresentation(Reader reader,
                            MediaType mediaType,
                            long expectedSize)
Constructor.

Parameters:
reader - The representation's stream.
mediaType - The representation's media type.
expectedSize - The expected reader size in bytes.
Method Detail

getReader

public Reader getReader()
                 throws 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:
IOException

getText

public String getText()
               throws IOException
Note that this method relies on CharacterRepresentation.getStream(). This stream is closed once fully read.

Overrides:
getText in class Representation
Returns:
The representation as a string value.
Throws:
IOException

release

public void release()
Closes and releases the input stream.

Overrides:
release in class Representation

setReader

public void setReader(Reader reader)
Sets the reader to use.

Parameters:
reader - The reader to use.

write

public void write(Writer writer)
           throws 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:
IOException

Restlet Framework 2.2 Snapshot
OSGi Environments

Copyright © 2005-2014 Restlet.