|
||||||||||
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.nio.entity.NStringEntity
public class NStringEntity
A simple, self contained, repeatable non-blocking entity that retrieves
its content from a String
object.
AsyncNHttpServiceHandler
Field Summary | |
---|---|
protected ByteBuffer |
buffer
|
protected byte[] |
content
|
Fields inherited from class org.apache.http.entity.AbstractHttpEntity |
---|
chunked, contentEncoding, contentType |
Constructor Summary | |
---|---|
NStringEntity(String s)
|
|
NStringEntity(String s,
String charset)
|
Method Summary | |
---|---|
void |
finish()
Notification that any resources allocated for writing can be released. |
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 of producing its data more than once. |
boolean |
isStreaming()
Tells whether this entity depends on an underlying stream. |
void |
produceContent(ContentEncoder encoder,
IOControl ioctrl)
Notification that content should be written to the encoder. |
void |
writeTo(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 |
Methods inherited from interface org.apache.http.HttpEntity |
---|
consumeContent, getContentEncoding, getContentType, isChunked |
Field Detail |
---|
protected final byte[] content
protected final ByteBuffer buffer
Constructor Detail |
---|
public NStringEntity(String s, String charset) throws UnsupportedEncodingException
UnsupportedEncodingException
public NStringEntity(String s) throws UnsupportedEncodingException
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 void finish()
ProducingNHttpEntity
finish
in interface ProducingNHttpEntity
public void produceContent(ContentEncoder encoder, IOControl ioctrl) throws IOException
ProducingNHttpEntity
IOControl
instance passed as a parameter to the method can be
used to suspend output events if the entity is temporarily unable to
produce more content.
When all content is finished, this MUST call ContentEncoder.complete()
.
Failure to do so could result in the entity never being written.
produceContent
in interface ProducingNHttpEntity
encoder
- content encoder.ioctrl
- I/O control of the underlying connection.
IOException
public boolean isStreaming()
HttpEntity
true
until the
content has been consumed, false
afterwards.
Self-contained entities should return false
.
Wrapping entities should delegate this call to the wrapped entity.
getContent
has been read to EOF,
or after consumeContent
has been called.
If a streamed entity can not detect whether the stream has been
read to EOF, it should return true
until
consumeContent
is called.
isStreaming
in interface HttpEntity
true
if the entity content is streamed and
not yet consumed, false
otherwisepublic InputStream getContent()
HttpEntity
repeatable
will throw an exception if this method is called multiple times.
getContent
in interface HttpEntity
public void writeTo(OutputStream outstream) throws IOException
HttpEntity
writeTo
in interface HttpEntity
outstream
- the output stream to write entity content to
IOException
- if an I/O error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |