org.restlet.resource
Class InputRepresentation

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.InputRepresentation

public class InputRepresentation
extends StreamRepresentation

Transient representation based on a BIO input stream.

Author:
Jerome Louvel

Field Summary
 
Fields inherited from class org.restlet.resource.Representation
UNKNOWN_SIZE
 
Constructor Summary
InputRepresentation(java.io.InputStream inputStream, MediaType mediaType)
          Constructor.
InputRepresentation(java.io.InputStream inputStream, MediaType mediaType, long expectedSize)
          Constructor.
 
Method Summary
 java.io.InputStream getStream()
          Returns a stream 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 setStream(java.io.InputStream stream)
          Sets the input stream to use.
 void write(java.io.OutputStream outputStream)
          Writes the representation to a byte stream.
 
Methods inherited from class org.restlet.resource.StreamRepresentation
getChannel, getReader, 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

InputRepresentation

public InputRepresentation(java.io.InputStream inputStream,
                           MediaType mediaType)
Constructor.

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

InputRepresentation

public InputRepresentation(java.io.InputStream inputStream,
                           MediaType mediaType,
                           long expectedSize)
Constructor.

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

getStream

public java.io.InputStream getStream()
                              throws java.io.IOException
Description copied from class: Representation
Returns a stream with the representation's content. This method is ensured to return a fresh stream for each invocation unless it is a transient representation, in which case null is returned.

Specified by:
getStream in class Representation
Returns:
A stream 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

setStream

public void setStream(java.io.InputStream stream)
Sets the input stream to use.

Parameters:
stream - The input stream to use.

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.

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


Copyright © 2005-2008 Noelios Technologies.