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 (contact@noelios.com)

Field Summary
 
Fields inherited from class org.restlet.resource.Variant
UNKNOWN_SIZE
 
Constructor Summary
StringRepresentation(CharSequence text)
          Constructor.
StringRepresentation(CharSequence text, Language language)
          Constructor.
StringRepresentation(CharSequence text, MediaType mediaType)
          Constructor.
StringRepresentation(CharSequence text, MediaType mediaType, Language language)
          Constructor.
StringRepresentation(CharSequence text, MediaType mediaType, Language language, CharacterSet characterSet)
          Constructor.
 
Method Summary
 InputStream getStream()
          Returns a stream with the representation's content.
 String getText()
          Converts the representation to a string value.
 void setText(String text)
          Sets the string value.
protected  void updateSize()
          Updates the expected size according to the current string value.
 void write(OutputStream outputStream)
          Writes the representation to a byte stream.
 
Methods inherited from class org.restlet.resource.StreamRepresentation
getChannel, write
 
Methods inherited from class org.restlet.resource.Representation
isAvailable, isTransient, setAvailable, setTransient
 
Methods inherited from class org.restlet.resource.Variant
getCharacterSet, getEncodings, getExpirationDate, getIdentifier, getLanguages, getMediaType, getModificationDate, getSize, getTag, setCharacterSet, setExpirationDate, setIdentifier, setIdentifier, setMediaType, setModificationDate, setSize, setTag
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StringRepresentation

public StringRepresentation(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(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(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(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(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 InputStream getStream()
                      throws IOException
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()
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.

setText

public void setText(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(OutputStream outputStream)
           throws IOException
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:
IOException


Copyright © 2005-2007 Noelios Consulting.