org.restlet.resource
Class StringRepresentation

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

public class StringRepresentation
extends StreamRepresentation

Represents an Unicode string that can be converted to any character set supported by Java.

Author:
Jerome Louvel

Field Summary
 
Fields inherited from class org.restlet.resource.Representation
UNKNOWN_SIZE
 
Constructor Summary
StringRepresentation(java.lang.CharSequence text)
          Constructor.
StringRepresentation(java.lang.CharSequence text, Language language)
          Constructor.
StringRepresentation(java.lang.CharSequence text, MediaType mediaType)
          Constructor.
StringRepresentation(java.lang.CharSequence text, MediaType mediaType, Language language)
          Constructor.
StringRepresentation(java.lang.CharSequence text, MediaType mediaType, Language language, CharacterSet characterSet)
          Constructor.
 
Method Summary
 java.io.InputStream getStream()
          Returns a stream with the representation's content.
 java.lang.String getText()
          Converts the representation to a string value.
 void release()
          Closes and releases the input stream.
 void setCharacterSet(CharacterSet characterSet)
          Sets the character set or null if not applicable.
 void setText(java.lang.String text)
          Sets the string value.
protected  void updateSize()
          Updates the expected size according to the current string value.
 void write(java.io.OutputStream outputStream)
          Writes the representation to a byte stream.
 
Methods inherited from class org.restlet.resource.StreamRepresentation
getChannel, getReader, write, write
 
Methods inherited from class org.restlet.resource.Representation
checkDigest, checkDigest, computeDigest, createEmpty, exhaust, getAvailableSize, getDigest, getDownloadName, getExpirationDate, getModificationDate, getRange, getSize, getTag, isAvailable, isDownloadable, isTransient, setAvailable, setDigest, setDownloadable, setDownloadName, setExpirationDate, setModificationDate, setRange, setSize, setTag, setTransient
 
Methods inherited from class org.restlet.resource.Variant
getCharacterSet, getEncodings, getIdentifier, getLanguages, getMediaType, setEncodings, setIdentifier, setIdentifier, setLanguages, setMediaType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StringRepresentation

public StringRepresentation(java.lang.CharSequence text)
Constructor. The following metadata are used by default: "text/plain" media type, no language and the ISO-8859-1 character set.

Parameters:
text - The string value.

StringRepresentation

public StringRepresentation(java.lang.CharSequence text,
                            Language language)
Constructor. The following metadata are used by default: "text/plain" media type, no language and the ISO-8859-1 character set.

Parameters:
text - The string value.
language - The language.

StringRepresentation

public StringRepresentation(java.lang.CharSequence text,
                            MediaType mediaType)
Constructor. The following metadata are used by default: no language and the ISO-8859-1 character set.

Parameters:
text - The string value.
mediaType - The media type.

StringRepresentation

public StringRepresentation(java.lang.CharSequence text,
                            MediaType mediaType,
                            Language language)
Constructor. The following metadata are used by default: ISO-8859-1 character set.

Parameters:
text - The string value.
mediaType - The media type.
language - The language.

StringRepresentation

public StringRepresentation(java.lang.CharSequence text,
                            MediaType mediaType,
                            Language language,
                            CharacterSet characterSet)
Constructor.

Parameters:
text - The string value.
mediaType - The media type.
language - The language.
characterSet - The character set.
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()
Description copied from class: Representation
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.

release

public void release()
Closes and releases the input stream.

Overrides:
release in class Representation

setCharacterSet

public void setCharacterSet(CharacterSet characterSet)
Description copied from class: Variant
Sets the character set or null if not applicable.

Overrides:
setCharacterSet in class Variant
Parameters:
characterSet - The character set or null if not applicable.

setText

public void setText(java.lang.String text)
Sets the string value.

Parameters:
text - The string value.

updateSize

protected void updateSize()
Updates the expected size according to the current string value.


write

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

Specified by:
write in class Representation
Parameters:
outputStream - The output stream.
Throws:
java.io.IOException


Copyright © 2005-2008 Noelios Technologies.