org.restlet.resource
Class ReaderRepresentation

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.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.resource.Representation
UNKNOWN_SIZE
 
Constructor Summary
ReaderRepresentation(java.io.Reader reader, MediaType mediaType)
          Constructor.
ReaderRepresentation(java.io.Reader reader, MediaType mediaType, long expectedSize)
          Constructor.
 
Method Summary
 java.io.Reader getReader()
          Returns a characters reader with the representation's content.
 java.lang.String getText()
          Converts the representation to a string value.
 void release()
          Closes and releases the input stream.
 void setReader(java.io.Reader reader)
          Sets the reader to use.
 void write(java.io.Writer writer)
          Writes the representation to a characters writer.
 
Methods inherited from class org.restlet.resource.CharacterRepresentation
getChannel, getStream, write, write
 
Methods inherited from class org.restlet.resource.Representation
checkDigest, checkDigest, computeDigest, createEmpty, exhaust, getAvailableSize, getDigest, getDownloadName, getExpirationDate, getModificationDate, getRange, getSize, getTag, 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
 

Constructor Detail

ReaderRepresentation

public ReaderRepresentation(java.io.Reader reader,
                            MediaType mediaType)
Constructor.

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

ReaderRepresentation

public ReaderRepresentation(java.io.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 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

getText

public java.lang.String getText()
                         throws java.io.IOException
Description copied from class: Representation
Converts the representation to a string value. Be careful when using this method as the conversion of large content to a string fully stored in memory can result in OutOfMemoryErrors being thrown.

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

release

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

Overrides:
release in class Representation

setReader

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

Parameters:
reader - The reader to use.

write

public void write(java.io.Writer writer)
           throws java.io.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.

Specified by:
write in class Representation
Parameters:
writer - The characters writer.
Throws:
java.io.IOException


Copyright © 2005-2008 Noelios Technologies.