depends.org.apache.http.entity

类 StringEntity

java.lang.Object

depends.org.apache.http.entity.AbstractHttpEntity

depends.org.apache.http.entity.StringEntity

所有已实现的接口:

HttpEntity, java.lang.Cloneable

直接已知子类:

UrlEncodedFormEntity

@NotThreadSafe
public class StringEntity
extends AbstractHttpEntity
implements java.lang.Cloneable

A self contained, repeatable entity that obtains its content from a String.

从以下版本开始:

4.0

字段概要

字段

限定符和类型	字段和说明
protected byte[]	content

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

chunked, contentEncoding, contentType, OUTPUT_BUFFER_SIZE

构造器概要

构造器

构造器和说明
StringEntity(java.lang.String string) Creates a StringEntity with the specified content.
StringEntity(java.lang.String string, java.nio.charset.Charset charset) Creates a StringEntity with the specified content and charset.
StringEntity(java.lang.String string, ContentType contentType) Creates a StringEntity with the specified content and content category.
StringEntity(java.lang.String string, java.lang.String charset) Creates a StringEntity with the specified content and charset.
StringEntity(java.lang.String string, java.lang.String mimeType, java.lang.String charset) 已过时。 (4.1.3) use StringEntity(String, ContentType)

方法概要

方法

限定符和类型	方法和说明
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.

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

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

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

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

字段详细资料

content

protected final byte[] content

构造器详细资料

StringEntity

public StringEntity(java.lang.String string,
            ContentType contentType)
             throws java.nio.charset.UnsupportedCharsetException

Creates a StringEntity with the specified content and content category.

参数:

string - content to be used. Not null.

contentType - content category to be used. May be null, in which case the default MIME category ContentType.TEXT_PLAIN 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

从以下版本开始:

4.2

StringEntity

@Deprecated
public StringEntity(java.lang.String string,
                       java.lang.String mimeType,
                       java.lang.String charset)
             throws java.io.UnsupportedEncodingException

已过时。 (4.1.3) use StringEntity(String, ContentType)

Creates a StringEntity with the specified content, MIME category and charset

参数:

string - content to be used. Not null.

mimeType - MIME category to be used. May be null, in which case the default is HTTP.PLAIN_TEXT_TYPE i.e. "text/plain"

charset - character set to be used. May be null, in which case the default is HTTP.DEF_CONTENT_CHARSET i.e. "ISO-8859-1"

抛出:

java.io.UnsupportedEncodingException - If the named charset is not supported.

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

从以下版本开始:

4.1

StringEntity

public StringEntity(java.lang.String string,
            java.lang.String charset)
             throws java.nio.charset.UnsupportedCharsetException

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

StringEntity

public StringEntity(java.lang.String string,
            java.nio.charset.Charset charset)

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

抛出:

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

从以下版本开始:

4.2

StringEntity

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

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

参数:

string - 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()

从接口复制的说明: HttpEntity

Tells if the entity is capable of producing 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.

指定者:

isRepeatable 在接口中 HttpEntity

返回:

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.

getContent

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

从接口复制的说明: 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.

抛出:

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

另请参阅:

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

isStreaming

public boolean isStreaming()

Tells that this entity is not streaming.

指定者:

isStreaming 在接口中 HttpEntity

返回:

false

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

覆盖:

clone 在类中 java.lang.Object

抛出:

java.lang.CloneNotSupportedException