Package org.apache.http.entity
Class ContentType
- java.lang.Object
-
- org.apache.http.entity.ContentType
-
- All Implemented Interfaces:
Serializable
@Contract(threading=IMMUTABLE) public final class ContentType extends Object implements Serializable
Content type information consisting of a MIME type and an optional charset.This class makes no attempts to verify validity of the MIME type. The input parameters of the
create(String, String)
method, however, may not contain characters<">, <;>, <,>
reserved by the HTTP specification.- Since:
- 4.2
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static ContentType
APPLICATION_ATOM_XML
static ContentType
APPLICATION_FORM_URLENCODED
static ContentType
APPLICATION_JSON
static ContentType
APPLICATION_OCTET_STREAM
static ContentType
APPLICATION_SVG_XML
static ContentType
APPLICATION_XHTML_XML
static ContentType
APPLICATION_XML
static ContentType
DEFAULT_BINARY
static ContentType
DEFAULT_TEXT
static ContentType
MULTIPART_FORM_DATA
static ContentType
TEXT_HTML
static ContentType
TEXT_PLAIN
static ContentType
TEXT_XML
static ContentType
WILDCARD
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ContentType
create(String mimeType)
Creates a new instance ofContentType
without a charset.static ContentType
create(String mimeType, String charset)
Creates a new instance ofContentType
.static ContentType
create(String mimeType, Charset charset)
Creates a new instance ofContentType
.static ContentType
create(String mimeType, NameValuePair... params)
Creates a new instance ofContentType
with the given parameters.static ContentType
get(HttpEntity entity)
ExtractsContent-Type
value fromHttpEntity
exactly as specified by theContent-Type
header of the entity.static ContentType
getByMimeType(String mimeType)
ReturnsContent-Type
for the given MIME type.Charset
getCharset()
static ContentType
getLenient(HttpEntity entity)
ExtractsContent-Type
value fromHttpEntity
.static ContentType
getLenientOrDefault(HttpEntity entity)
ExtractsContent-Type
value fromHttpEntity
or returns the default valueDEFAULT_TEXT
if not explicitly specified or incorrect (could not be parsed).String
getMimeType()
static ContentType
getOrDefault(HttpEntity entity)
ExtractsContent-Type
value fromHttpEntity
or returns the default valueDEFAULT_TEXT
if not explicitly specified.String
getParameter(String name)
static ContentType
parse(String s)
Parses textual representation ofContent-Type
value.String
toString()
Generates textual representation of this content type which can be used as the value of aContent-Type
header.ContentType
withCharset(String charset)
Creates a new instance with this MIME type and the given Charset name.ContentType
withCharset(Charset charset)
Creates a new instance with this MIME type and the given Charset.ContentType
withParameters(NameValuePair... params)
Creates a new instance with this MIME type and the given parameters.
-
-
-
Field Detail
-
APPLICATION_ATOM_XML
public static final ContentType APPLICATION_ATOM_XML
-
APPLICATION_FORM_URLENCODED
public static final ContentType APPLICATION_FORM_URLENCODED
-
APPLICATION_JSON
public static final ContentType APPLICATION_JSON
-
APPLICATION_OCTET_STREAM
public static final ContentType APPLICATION_OCTET_STREAM
-
APPLICATION_SVG_XML
public static final ContentType APPLICATION_SVG_XML
-
APPLICATION_XHTML_XML
public static final ContentType APPLICATION_XHTML_XML
-
APPLICATION_XML
public static final ContentType APPLICATION_XML
-
MULTIPART_FORM_DATA
public static final ContentType MULTIPART_FORM_DATA
-
TEXT_HTML
public static final ContentType TEXT_HTML
-
TEXT_PLAIN
public static final ContentType TEXT_PLAIN
-
TEXT_XML
public static final ContentType TEXT_XML
-
WILDCARD
public static final ContentType WILDCARD
-
DEFAULT_TEXT
public static final ContentType DEFAULT_TEXT
-
DEFAULT_BINARY
public static final ContentType DEFAULT_BINARY
-
-
Method Detail
-
getMimeType
public String getMimeType()
-
getCharset
public Charset getCharset()
-
toString
public String toString()
Generates textual representation of this content type which can be used as the value of aContent-Type
header.
-
create
public static ContentType create(String mimeType, Charset charset)
Creates a new instance ofContentType
.- Parameters:
mimeType
- MIME type. It may not benull
or empty. It may not contain characters<">, <;>, <,>
reserved by the HTTP specification.charset
- charset.- Returns:
- content type
-
create
public static ContentType create(String mimeType)
Creates a new instance ofContentType
without a charset.- Parameters:
mimeType
- MIME type. It may not benull
or empty. It may not contain characters<">, <;>, <,>
reserved by the HTTP specification.- Returns:
- content type
-
create
public static ContentType create(String mimeType, String charset) throws UnsupportedCharsetException
Creates a new instance ofContentType
.- Parameters:
mimeType
- MIME type. It may not benull
or empty. It may not contain characters<">, <;>, <,>
reserved by the HTTP specification.charset
- charset. It may not contain characters<">, <;>, <,>
reserved by the HTTP specification. This parameter is optional.- Returns:
- content type
- Throws:
UnsupportedCharsetException
- Thrown when the named charset is not available in this instance of the Java virtual machine
-
create
public static ContentType create(String mimeType, NameValuePair... params) throws UnsupportedCharsetException
Creates a new instance ofContentType
with the given parameters.- Parameters:
mimeType
- MIME type. It may not benull
or empty. It may not contain characters<">, <;>, <,>
reserved by the HTTP specification.params
- parameters.- Returns:
- content type
- Throws:
UnsupportedCharsetException
- Since:
- 4.4
-
parse
public static ContentType parse(String s) throws ParseException, UnsupportedCharsetException
Parses textual representation ofContent-Type
value.- Parameters:
s
- text- Returns:
- content type
- Throws:
ParseException
- if the given text does not represent a validContent-Type
value.UnsupportedCharsetException
- Thrown when the named charset is not available in this instance of the Java virtual machine
-
get
public static ContentType get(HttpEntity entity) throws ParseException, UnsupportedCharsetException
ExtractsContent-Type
value fromHttpEntity
exactly as specified by theContent-Type
header of the entity. Returnsnull
if not specified.- Parameters:
entity
- HTTP entity- Returns:
- content type
- Throws:
ParseException
- if the given text does not represent a validContent-Type
value.UnsupportedCharsetException
- Thrown when the named charset is not available in this instance of the Java virtual machine
-
getLenient
public static ContentType getLenient(HttpEntity entity)
ExtractsContent-Type
value fromHttpEntity
. Returnsnull
if not specified or incorrect (could not be parsed)..- Parameters:
entity
- HTTP entity- Returns:
- content type
- Since:
- 4.4
-
getOrDefault
public static ContentType getOrDefault(HttpEntity entity) throws ParseException, UnsupportedCharsetException
ExtractsContent-Type
value fromHttpEntity
or returns the default valueDEFAULT_TEXT
if not explicitly specified.- Parameters:
entity
- HTTP entity- Returns:
- content type
- Throws:
ParseException
- if the given text does not represent a validContent-Type
value.UnsupportedCharsetException
- Thrown when the named charset is not available in this instance of the Java virtual machine
-
getLenientOrDefault
public static ContentType getLenientOrDefault(HttpEntity entity) throws ParseException, UnsupportedCharsetException
ExtractsContent-Type
value fromHttpEntity
or returns the default valueDEFAULT_TEXT
if not explicitly specified or incorrect (could not be parsed).- Parameters:
entity
- HTTP entity- Returns:
- content type
- Throws:
ParseException
UnsupportedCharsetException
- Since:
- 4.4
-
getByMimeType
public static ContentType getByMimeType(String mimeType)
ReturnsContent-Type
for the given MIME type.- Parameters:
mimeType
- MIME type- Returns:
- content type or
null
if not known. - Since:
- 4.5
-
withCharset
public ContentType withCharset(Charset charset)
Creates a new instance with this MIME type and the given Charset.- Parameters:
charset
- charset- Returns:
- a new instance with this MIME type and the given Charset.
- Since:
- 4.3
-
withCharset
public ContentType withCharset(String charset)
Creates a new instance with this MIME type and the given Charset name.- Parameters:
charset
- name- Returns:
- a new instance with this MIME type and the given Charset name.
- Throws:
UnsupportedCharsetException
- Thrown when the named charset is not available in this instance of the Java virtual machine- Since:
- 4.3
-
withParameters
public ContentType withParameters(NameValuePair... params) throws UnsupportedCharsetException
Creates a new instance with this MIME type and the given parameters.- Parameters:
params
-- Returns:
- a new instance with this MIME type and the given parameters.
- Throws:
UnsupportedCharsetException
- Since:
- 4.4
-
-