org.apache.http.entity
Class StringEntity

java.lang.Object
  org.apache.http.entity.AbstractHttpEntity
      org.apache.http.entity.StringEntity

All Implemented Interfaces:

HttpEntity

public class StringEntity

extends AbstractHttpEntity

A self-contained entity obtaining content from a string.

Since:

4.0

Version:

$Revision: 496070 $

Author:

Oleg Kalnichevski

Field Summary

Fields inherited from class org.apache.http.entity.AbstractHttpEntity

chunked, contentEncoding, contentType

Constructor Summary

StringEntity(java.lang.String s)

StringEntity(java.lang.String s, java.lang.String charset)

Method Summary

java.io.InputStream	getContent() Creates a new InputStream object of the entity.
long	getContentLength() Tells the length of the content, if known.
boolean	isRepeatable() Tells if the entity is capable to produce its data more than once.
boolean	isStreaming() Tells that this entity is not streaming.
void	writeTo(java.io.OutputStream outstream) Writes the entity content to the output stream.

Methods inherited from class org.apache.http.entity.AbstractHttpEntity

consumeContent, getContentEncoding, getContentType, isChunked, setChunked, setContentEncoding, setContentEncoding, setContentType, setContentType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StringEntity

public StringEntity(java.lang.String s,
                    java.lang.String charset)
             throws java.io.UnsupportedEncodingException

StringEntity

public StringEntity(java.lang.String s)
             throws java.io.UnsupportedEncodingException

Method Detail

isRepeatable

public boolean isRepeatable()

Description copied from interface: HttpEntity

Tells if the entity is capable to produce its data more than once. A repeatable entity's getContent() and writeTo(OutputStream) methods can be called more than once whereas a non-repeatable entity's can not.

Returns:

true if the entity is repeatable, false otherwise.

getContentLength

public long getContentLength()

Description copied from interface: HttpEntity

Tells the length of the content, if known.

Returns:

the number of bytes of the content, or a negative number if unknown. If the content length is known but exceeds Long.MAX_VALUE, a negative number is returned.

getContent

public java.io.InputStream getContent()
                               throws java.io.IOException

Description copied from interface: HttpEntity

Creates a new InputStream object of the entity. It is a programming error to return the same InputStream object more than once. Entities that are not repeatable will throw an exception if this method is called multiple times.

Returns:

a new input stream that returns the entity data.

Throws:

java.io.IOException - if the stream could not be created

writeTo

public void writeTo(java.io.OutputStream outstream)
             throws java.io.IOException

Description copied from interface: HttpEntity

Writes the entity content to the output stream.

Parameters:

outstream - the output stream to write entity content to

Throws:

java.io.IOException - if an I/O error occurs

isStreaming

public boolean isStreaming()

Tells that this entity is not streaming.

Returns:

false