|
||||||||||
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
@NotThreadSafe public class NStringEntity
A simple, self contained, repeatable non-blocking entity that retrieves
its content from a String
object.
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)
Creates a StringEntity with the specified content and charset. |
|
NStringEntity(String s,
ContentType contentType)
Creates a NStringEntity with the specified content and content type. |
|
NStringEntity(String s,
String charset)
Creates a NStringEntity with the specified content and charset. |
Method Summary | |
---|---|
static NStringEntity |
create(String string)
Creates a StringEntity with the specified content and charset. |
static NStringEntity |
create(String string,
ContentType contentType)
Creates a NStringEntity with the specified content and content type. |
static NStringEntity |
create(String string,
String charset)
Creates a StringEntity with the specified content and charset. |
void |
finish()
Notification that any resources allocated for writing can be released. |
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 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 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 |
---|
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, ContentType contentType) throws UnsupportedEncodingException
s
- content to be used. Not null
.contentType
- content type to be used. May be null
, in which case the default
MIME type HTTP.PLAIN_TEXT_TYPE
i.e. "text/plain" and the default charset
HTTP.DEFAULT_CONTENT_CHARSET
i.e. "ISO-8859-1" are assumed.
IllegalArgumentException
- if the string parameter is null
UnsupportedEncodingException
- if the charset specified in the CotnentType
is not supported.public NStringEntity(String s, String charset) throws UnsupportedEncodingException
HTTP.PLAIN_TEXT_TYPE
i.e. "text/plain".
s
- content to be used. Not null
.charset
- character set to be used. May be null
, in which case the default
is HTTP.DEFAULT_CONTENT_CHARSET
i.e. "ISO-8859-1"
IllegalArgumentException
- if the string parameter is null
UnsupportedEncodingException
- if the charset is not supported.public NStringEntity(String s) throws UnsupportedEncodingException
HTTP.DEFAULT_CONTENT_CHARSET
i.e. "ISO-8859-1". The mime type defaults to
HTTP.PLAIN_TEXT_TYPE
i.e. "text/plain".
s
- content to be used. Not null
.
IllegalArgumentException
- if the string parameter is null
UnsupportedEncodingException
- if the default HTTP charset is not supported.Method Detail |
---|
public static NStringEntity create(String string, ContentType contentType)
string
- content to be used. Not null
.contentType
- content type to be used. May be null
, in which case the default
MIME type HTTP.PLAIN_TEXT_TYPE
i.e. "text/plain" and the default charset
HTTP.DEFAULT_CONTENT_CHARSET
i.e. "ISO-8859-1" are assumed.
IllegalArgumentException
- if the string parameter is null or if the charset
specified in the CotnentType is not supported.public static NStringEntity create(String string, String charset)
HTTP.PLAIN_TEXT_TYPE
i.e. "text/plain".
string
- content to be used. Not null
.charset
- character set to be used. May be null
, in which case the default
is HTTP.DEFAULT_CONTENT_CHARSET
i.e. "ISO-8859-1"
IllegalArgumentException
- if the string parameter is null or if the charset
specified in the CotnentType is not supported.public static NStringEntity create(String string)
HTTP.DEFAULT_CONTENT_CHARSET
i.e. "ISO-8859-1". The mime type defaults to
HTTP.PLAIN_TEXT_TYPE
i.e. "text/plain".
string
- content to be used. Not null
.
IllegalArgumentException
- if the string parameter is nullpublic 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
. Self-contained entities should return
false
. Wrapping entities should delegate this call
to the wrapped entity.
isStreaming
in interface HttpEntity
true
if the entity content is streamed,
false
otherwisepublic InputStream getContent()
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
HttpEntity.isRepeatable()
public void writeTo(OutputStream outstream) throws 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
IOException
- if an I/O error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |