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 (contact@noelios.com)

Field Summary
 
Fields inherited from class org.restlet.resource.Variant
UNKNOWN_SIZE
 
Constructor Summary
InputRepresentation(InputStream inputStream, MediaType mediaType)
          Constructor.
InputRepresentation(InputStream inputStream, MediaType mediaType, long expectedSize)
          Constructor.
 
Method Summary
 InputStream getStream()
          Returns a stream with the representation's content.
 String getText()
          Converts the representation to a string value.
 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
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

InputRepresentation

public InputRepresentation(InputStream inputStream,
                           MediaType mediaType)
Constructor.

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

InputRepresentation

public InputRepresentation(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 InputStream getStream()
                      throws IOException
Returns a stream with the representation's content.

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

getText

public String getText()
               throws IOException
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:
IOException

write

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