Package org.restlet.representation

Class InputRepresentation

java.lang.Object

org.restlet.representation.Variant

org.restlet.representation.RepresentationInfo

org.restlet.representation.Representation

org.restlet.representation.StreamRepresentation

org.restlet.representation.InputRepresentation

Direct Known Subclasses:

ByteArrayRepresentation

public class InputRepresentation
extends StreamRepresentation

Transient representation based on a BIO input stream.

Author:

Jerome Louvel

Field Summary

Fields inherited from class org.restlet.representation.Representation

UNKNOWN_SIZE

Constructor Summary

Constructors

Constructor	Description
InputRepresentation(InputStream inputStream)	Constructor.
InputRepresentation(InputStream inputStream, MediaType mediaType)	Constructor.
InputRepresentation(InputStream inputStream, MediaType mediaType, long expectedSize)	Constructor.

Method Summary

Modifier and Type	Method	Description
InputStream	getStream()	Returns a stream with the representation's content.
String	getText()	Note that this method relies on getStream().
void	release()	Closes and releases the input stream.
void	setStream(InputStream stream)	Sets the input stream to use.
void	write(OutputStream outputStream)	Writes the representation to a byte stream.

Methods inherited from class org.restlet.representation.StreamRepresentation

getReader, write

Methods inherited from class org.restlet.representation.Representation

append, exhaust, getAvailableSize, getDigest, getDisposition, getExpirationDate, getRange, getSize, hasKnownSize, isAvailable, isEmpty, isTransient, setAvailable, setDigest, setDisposition, setExpirationDate, 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, hashCode, includes, isCompatible, setCharacterSet, setEncodings, setLanguages, setLocationRef, setLocationRef, setMediaType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

InputRepresentation

public InputRepresentation(InputStream inputStream)

Constructor.

Parameters:

inputStream - The representation's stream.

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 Details

getStream

public InputStream getStream()
                      throws 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:

IOException

getText

public String getText()
               throws IOException

Note that this method relies on 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

setStream

public void setStream(InputStream stream)

Sets the input stream to use.

Parameters:

stream - The input stream to use.

write

public void write(OutputStream outputStream)
           throws 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.

Note that the class implementing this method shouldn't flush or close the given OutputStream after writing to it as this will be handled by the Restlet connectors automatically.

Specified by:

write in class Representation

Parameters:

outputStream - The output stream.

Throws:

IOException