org.restlet.client.representation
Class InputRepresentation

java.lang.Object
  extended by org.restlet.client.representation.Variant
      extended by org.restlet.client.representation.RepresentationInfo
          extended by org.restlet.client.representation.Representation
              extended by org.restlet.client.representation.StreamRepresentation
                  extended by org.restlet.client.representation.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.client.representation.Representation
UNKNOWN_SIZE
 
Constructor Summary
InputRepresentation(java.io.InputStream inputStream)
          Constructor.
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()
          Note that this method relies on getStream().
 void release()
          Closes and releases the input stream.
 void setStream(java.io.InputStream stream)
          Sets the input stream to use.
 
Methods inherited from class org.restlet.client.representation.StreamRepresentation
getReader
 
Methods inherited from class org.restlet.client.representation.Representation
createEmpty, exhaust, getAvailableSize, getDisposition, getDownloadName, getExpirationDate, getRange, getSize, isAvailable, isDownloadable, isTransient, setAvailable, setDisposition, setDownloadable, setDownloadName, setExpirationDate, setRange, setSize, setTransient
 
Methods inherited from class org.restlet.client.representation.RepresentationInfo
getModificationDate, getTag, setModificationDate, setTag
 
Methods inherited from class org.restlet.client.representation.Variant
createClientInfo, equals, getCharacterSet, getEncodings, getIdentifier, getLanguages, getLocationRef, getMediaType, includes, isCompatible, setCharacterSet, setEncodings, setIdentifier, setIdentifier, setLanguages, setLocationRef, setLocationRef, setMediaType, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

InputRepresentation

public InputRepresentation(java.io.InputStream inputStream)
Constructor.

Parameters:
inputStream - The representation's stream.

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
Note that this method relies on getStream(). This stream is closed once fully read.

Specified by:
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.


Copyright © 2005-2011 Noelios Technologies.