|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.http.entity.AbstractHttpEntity
org.apache.http.entity.StringEntity
public class StringEntity
A self contained, repeatable entity that obtains its content from
a String
.
Field Summary | |
---|---|
protected byte[] |
content
|
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)
|
|
StringEntity(java.lang.String s,
java.lang.String mimeType,
java.lang.String charset)
|
Method Summary | |
---|---|
java.lang.Object |
clone()
|
java.io.InputStream |
getContent()
Returns a content stream of the entity. |
long |
getContentLength()
Tells the length of the content, if known. |
boolean |
isRepeatable()
Tells if the entity is capable of producing its data more than once. |
boolean |
isStreaming()
Tells that this entity is not streaming. |
void |
writeTo(java.io.OutputStream outstream)
Writes the entity content out 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 |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final byte[] content
Constructor Detail |
---|
public StringEntity(java.lang.String s, java.lang.String mimeType, java.lang.String charset) throws java.io.UnsupportedEncodingException
java.io.UnsupportedEncodingException
public StringEntity(java.lang.String s, java.lang.String charset) throws java.io.UnsupportedEncodingException
java.io.UnsupportedEncodingException
public StringEntity(java.lang.String s) throws java.io.UnsupportedEncodingException
java.io.UnsupportedEncodingException
Method Detail |
---|
public boolean isRepeatable()
HttpEntity
isRepeatable
in interface HttpEntity
public long getContentLength()
HttpEntity
getContentLength
in interface HttpEntity
Long.MAX_VALUE
,
a negative number is returned.public java.io.InputStream getContent() throws java.io.IOException
HttpEntity
Repeatable
entities are expected
to create a new instance of InputStream
for each invocation
of this method and therefore can be consumed multiple times.
Entities that are not repeatable
are expected
to return the same InputStream
instance and therefore
may not be consumed more than once.
IMPORTANT: Please note all entity implementations must ensure that
all allocated resources are properly deallocated after
the InputStream.close()
method is invoked.
getContent
in interface HttpEntity
java.io.IOException
- if the stream could not be createdHttpEntity.isRepeatable()
public void writeTo(java.io.OutputStream outstream) throws java.io.IOException
HttpEntity
IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.
writeTo
in interface HttpEntity
outstream
- the output stream to write entity content to
java.io.IOException
- if an I/O error occurspublic boolean isStreaming()
isStreaming
in interface HttpEntity
false
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |