org.apache.http.util
Class EntityUtils

java.lang.Object
  org.apache.http.util.EntityUtils

public final class EntityUtils
extends Object

Static helpers for dealing with HttpEntitys.

Since:

4.0

Version:

$Revision: 744533 $

Method Summary

static String	getContentCharSet(HttpEntity entity) Obtains character set of the entity, if known.
static byte[]	toByteArray(HttpEntity entity) Read the contents of an entity and return it as a byte array.
static String	toString(HttpEntity entity) Read the contents of an entity and return it as a String.
static String	toString(HttpEntity entity, String defaultCharset) Get the entity content as a String, using the provided default character set if none is found in the entity.

Methods inherited from class java.lang.Object

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

Method Detail

toByteArray

public static byte[] toByteArray(HttpEntity entity)
                          throws IOException

Read the contents of an entity and return it as a byte array.

Parameters:

entity -

Returns:

byte array containing the entity content. May be empty; never null.

Throws:

IOException - if an error occurs reading the input stream

IllegalArgumentException - if entity is null or if content length > Integer.MAX_VALUE

getContentCharSet

public static String getContentCharSet(HttpEntity entity)
                                throws ParseException

Obtains character set of the entity, if known.

Parameters:

entity - must not be null

Returns:

the character set, or null if not found

Throws:

ParseException - if header elements cannot be parsed

IllegalArgumentException - if entity is null

toString

public static String toString(HttpEntity entity,
                              String defaultCharset)
                       throws IOException,
                              ParseException

Get the entity content as a String, using the provided default character set if none is found in the entity. If defaultCharset is null, the default "ISO-8859-1" is used.

Parameters:

entity - must not be null

defaultCharset - character set to be applied if none found in the entity

Returns:

the entity content as a String

Throws:

ParseException - if header elements cannot be parsed

IllegalArgumentException - if entity is null or if content length > Integer.MAX_VALUE

IOException - if an error occurs reading the input stream

toString

public static String toString(HttpEntity entity)
                       throws IOException,
                              ParseException

Read the contents of an entity and return it as a String. The content is converted using the character set from the entity (if any), failing that, "ISO-8859-1" is used.

Parameters:

entity -

Returns:

String containing the content.

Throws:

ParseException - if header elements cannot be parsed

IllegalArgumentException - if entity is null or if content length > Integer.MAX_VALUE

IOException - if an error occurs reading the input stream