|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.restlet.gwt.resource.Variant
org.restlet.gwt.resource.Representation
public abstract class Representation
Current or intended state of a resource. The content of a representation can
be retrieved several times if there is a stable and accessible source, like a
local file or a string. When the representation is obtained via a temporary
source like a network socket, its content can only be retrieved once. The
"transient" and "available" properties are available to help you figure out
those aspects at runtime.
For performance purpose, it is essential that a minimal overhead occurs upon
initialization. The main overhead must only occur during invocation of
content processing methods (write, getStream, getChannel and toString).
"REST components perform actions on a resource by using a representation to
capture the current or intended state of that resource and transferring that
representation between components. A representation is a sequence of bytes,
plus representation metadata to describe those bytes. Other commonly used but
less precise names for a representation include: document, file, and HTTP
message entity, instance, or variant." Roy T. Fielding
Field Summary | |
---|---|
static long |
UNKNOWN_SIZE
Indicates that the size of the representation can't be known in advance. |
Constructor Summary | |
---|---|
Representation()
Default constructor. |
|
Representation(MediaType mediaType)
Constructor. |
Method Summary | |
---|---|
static Representation |
createEmpty()
Returns a new empty representation with no content. |
java.lang.String |
getDownloadName()
Returns the suggested download file name for this representation. |
java.util.Date |
getExpirationDate()
Returns the future date when this representation expire. |
java.util.Date |
getModificationDate()
Returns the last date when this representation was modified. |
long |
getSize()
Returns the size in bytes if known, UNKNOWN_SIZE (-1) otherwise. |
Tag |
getTag()
Returns the tag. |
abstract java.lang.String |
getText()
Converts the representation to a string value. |
boolean |
isAvailable()
Indicates if some fresh content is available, without having to actually call one of the content manipulation method like getStream() that would actually consume it. |
boolean |
isDownloadable()
Indicates if the representation is downloadable which means that it can be obtained via a download dialog box. |
boolean |
isTransient()
Indicates if the representation's content is transient, which means that it can be obtained only once. |
void |
release()
Releases the representation's content and all associated objects like sockets, channels or files. |
void |
setAvailable(boolean available)
Indicates if some fresh content is available. |
void |
setDownloadable(boolean downloadable)
Indicates if the representation is downloadable which means that it can be obtained via a download dialog box. |
void |
setDownloadName(java.lang.String fileName)
Set the suggested download file name for this representation. |
void |
setExpirationDate(java.util.Date expirationDate)
Sets the future date when this representation expire. |
void |
setModificationDate(java.util.Date modificationDate)
Sets the last date when this representation was modified. |
void |
setSize(long expectedSize)
Sets the expected size in bytes if known, -1 otherwise. |
void |
setTag(Tag tag)
Sets the tag. |
void |
setTransient(boolean isTransient)
Indicates if the representation's content is transient. |
Methods inherited from class org.restlet.gwt.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 |
Field Detail |
---|
public static final long UNKNOWN_SIZE
Constructor Detail |
---|
public Representation()
public Representation(MediaType mediaType)
mediaType
- The media type.Method Detail |
---|
public static Representation createEmpty()
public java.lang.String getDownloadName()
public java.util.Date getExpirationDate()
public java.util.Date getModificationDate()
public long getSize()
public Tag getTag()
public abstract java.lang.String getText()
public boolean isAvailable()
public boolean isDownloadable()
public boolean isTransient()
public void release()
public void setAvailable(boolean available)
available
- True if some fresh content is available.public void setDownloadable(boolean downloadable)
downloadable
- True if the representation's content is downloadable.public void setDownloadName(java.lang.String fileName)
fileName
- The suggested file name.public void setExpirationDate(java.util.Date expirationDate)
expirationDate
- The expiration date.public void setModificationDate(java.util.Date modificationDate)
modificationDate
- The modification date.public void setSize(long expectedSize)
expectedSize
- The expected size in bytes if known, -1 otherwise.public void setTag(Tag tag)
tag
- The tag.public void setTransient(boolean isTransient)
isTransient
- True if the representation's content is transient.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |