depends.org.apache.http.nio.entity

类 NStringEntity

java.lang.Object

depends.org.apache.http.entity.AbstractHttpEntity

depends.org.apache.http.nio.entity.NStringEntity

所有已实现的接口:

HttpEntity, HttpAsyncContentProducer, ProducingNHttpEntity, java.io.Closeable, java.lang.AutoCloseable

@NotThreadSafe
public class NStringEntity
extends AbstractHttpEntity
implements HttpAsyncContentProducer, ProducingNHttpEntity

A simple, self contained, repeatable non-blocking entity that retrieves its content from a String object.

从以下版本开始:

4.0

字段概要

字段

限定符和类型	字段和说明
protected java.nio.ByteBuffer	buffer 已过时。 (4.2)
protected byte[]	content 已过时。 (4.2)

从类继承的字段 depends.org.apache.http.entity.AbstractHttpEntity

chunked, contentEncoding, contentType, OUTPUT_BUFFER_SIZE

构造器概要

构造器

构造器和说明
NStringEntity(java.lang.String s) Creates a NStringEntity with the specified content.
NStringEntity(java.lang.String s, java.nio.charset.Charset charset) Creates a NStringEntity with the specified content and charset.
NStringEntity(java.lang.String s, ContentType contentType) Creates a NStringEntity with the specified content and content category.
NStringEntity(java.lang.String s, java.lang.String charset) Creates a NStringEntity with the specified content and charset.

方法概要

方法

限定符和类型	方法和说明
void	close()
void	finish() 已过时。 (4.2) use close()
java.io.InputStream	getContent() Returns a content stream of the entity.
long	getContentLength() Tells the length of the content, if known.
boolean	isRepeatable() Determines whether or not this producer is capable of producing its content more than once.
boolean	isStreaming() Tells whether this entity depends on an underlying stream.
void	produceContent(ContentEncoder encoder, IOControl ioctrl) Invoked to write out a chunk of content to the ContentEncoder.
void	writeTo(java.io.OutputStream outstream) Writes the entity content out to the output stream.

从类继承的方法 depends.org.apache.http.entity.AbstractHttpEntity

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

从类继承的方法 java.lang.Object

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

从接口继承的方法 depends.org.apache.http.HttpEntity

consumeContent, getContentEncoding, getContentType, isChunked

字段详细资料

content

@Deprecated
protected final byte[] content

已过时。 (4.2)

buffer

@Deprecated
protected final java.nio.ByteBuffer buffer

已过时。 (4.2)

构造器详细资料

NStringEntity

public NStringEntity(java.lang.String s,
             ContentType contentType)

Creates a NStringEntity with the specified content and content category.

参数:

s - content to be used. Not null.

contentType - content category to be used. May be null, in which case ContentType.TEXT_PLAIN is assumed.

抛出:

java.lang.IllegalArgumentException - if the string parameter is null

从以下版本开始:

4.2

NStringEntity

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

Creates a NStringEntity with the specified content and charset. The MIME category defaults to "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.DEF_CONTENT_CHARSET is assumed

抛出:

java.lang.IllegalArgumentException - if the string parameter is null

java.nio.charset.UnsupportedCharsetException - Thrown when the named charset is not available in this instance of the Java virtual machine

java.io.UnsupportedEncodingException

NStringEntity

public NStringEntity(java.lang.String s,
             java.nio.charset.Charset charset)

Creates a NStringEntity with the specified content and charset. The MIME category defaults to "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.DEF_CONTENT_CHARSET is assumed

抛出:

java.lang.IllegalArgumentException - if the string parameter is null

从以下版本开始:

4.2

NStringEntity

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

Creates a NStringEntity with the specified content. The content category defaults to ContentType.TEXT_PLAIN.

参数:

s - content to be used. Not null.

抛出:

java.lang.IllegalArgumentException - if the string parameter is null

java.io.UnsupportedEncodingException - if the default HTTP charset is not supported.

方法详细资料

isRepeatable

public boolean isRepeatable()

从接口复制的说明: HttpAsyncContentProducer

Determines whether or not this producer is capable of producing its content more than once. Repeatable content producers are expected to be able to recreate their content even after having been closed.

指定者:

isRepeatable 在接口中 HttpEntity

指定者:

isRepeatable 在接口中 HttpAsyncContentProducer

返回:

true if the entity is repeatable, false otherwise.

getContentLength

public long getContentLength()

从接口复制的说明: HttpEntity

Tells the length of the content, if known.

指定者:

getContentLength 在接口中 HttpEntity

返回:

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.

close

public void close()

指定者:

close 在接口中 java.io.Closeable

指定者:

close 在接口中 java.lang.AutoCloseable

从以下版本开始:

4.2

finish

@Deprecated
public void finish()

已过时。 (4.2) use close()

Notification that any resources tlb for writing can be released.

指定者:

finish 在接口中 ProducingNHttpEntity

produceContent

public void produceContent(ContentEncoder encoder,
                  IOControl ioctrl)
                    throws java.io.IOException

从接口复制的说明: HttpAsyncContentProducer

Invoked to write out a chunk of content to the ContentEncoder. The IOControl interface can be used to suspend output event notifications if the entity is temporarily unable to produce more content.

When all content is finished, the producer MUST call ContentEncoder.complete(). Failure to do so may cause the entity to be incorrectly delimited.

Please note that the ContentEncoder object is not thread-safe and should only be used within the context of this method call. The IOControl object can be shared and used on extension thread to resume output event notifications when more content is made available.

指定者:

produceContent 在接口中 HttpAsyncContentProducer

指定者:

produceContent 在接口中 ProducingNHttpEntity

参数:

encoder - content encoder.

ioctrl - I/O control of the underlying connection.

抛出:

java.io.IOException

isStreaming

public boolean isStreaming()

从接口复制的说明: HttpEntity

Tells whether this entity depends on an underlying stream. Streamed entities that read data directly from the socket should return true. Self-contained entities should return false. Wrapping entities should delegate this call to the wrapped entity.

指定者:

isStreaming 在接口中 HttpEntity

返回:

true if the entity content is streamed, false otherwise

getContent

public java.io.InputStream getContent()

从接口复制的说明: HttpEntity

Returns a content stream of the entity. 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 tlb resources are properly deallocated after the InputStream.close() method is invoked.

指定者:

getContent 在接口中 HttpEntity

返回:

content stream of the entity.

另请参阅:

HttpEntity.isRepeatable()

writeTo

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

从接口复制的说明: HttpEntity

Writes the entity content out to the output stream.

IMPORTANT: Please note all entity implementations must ensure that all tlb resources are properly deallocated when this method returns.

指定者:

writeTo 在接口中 HttpEntity

参数:

outstream - the output stream to write entity content to

抛出:

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