Package org.restlet.representation
Class WriterRepresentation
- java.lang.Object
-
- org.restlet.representation.Variant
-
- org.restlet.representation.RepresentationInfo
-
- org.restlet.representation.Representation
-
- org.restlet.representation.CharacterRepresentation
-
- org.restlet.representation.WriterRepresentation
-
public abstract class WriterRepresentation extends CharacterRepresentation
Representation based on a BIO characters writer. This class is a good basis to write your own representations, especially for the dynamic and large ones.
For this you just need to create a subclass and override the abstract Representation.write(Writer) method. This method will later be called back by the connectors when the actual representation's content is needed.- Author:
- Jerome Louvel
-
-
Field Summary
-
Fields inherited from class org.restlet.representation.Representation
UNKNOWN_SIZE
-
-
Constructor Summary
Constructors Constructor Description WriterRepresentation(MediaType mediaType)
Constructor.WriterRepresentation(MediaType mediaType, long expectedSize)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.io.Reader
getReader()
Returns a characters reader with the representation's content.-
Methods inherited from class org.restlet.representation.CharacterRepresentation
getChannel, getStream, write, write
-
Methods inherited from class org.restlet.representation.Representation
append, exhaust, getAvailableSize, getDigest, getDisposition, getExpirationDate, getRange, getRegistration, getSize, getText, hasKnownSize, isAvailable, isEmpty, isSelectable, isTransient, release, setAvailable, setDigest, setDisposition, setExpirationDate, setListener, setRange, setSize, setTransient, write
-
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
-
-
-
-
Constructor Detail
-
WriterRepresentation
public WriterRepresentation(MediaType mediaType)
Constructor.- Parameters:
mediaType
- The representation's mediaType.
-
WriterRepresentation
public WriterRepresentation(MediaType mediaType, long expectedSize)
Constructor.- Parameters:
mediaType
- The representation's mediaType.expectedSize
- The expected writer 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 classRepresentation
- Returns:
- A reader with the representation's content.
- Throws:
java.io.IOException
-
-