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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ContentType
static final ContentType
static final ContentType
static final ContentType
static final ContentType
static final ContentType
static final ContentType
static final ContentType
private final Charset
private static final Map
<String, ContentType> static final ContentType
static final ContentType
static final ContentType
static final ContentType
static final ContentType
static final ContentType
static final ContentType
static final ContentType
static final ContentType
private final String
static final ContentType
private final NameValuePair[]
private static final long
static final ContentType
static final ContentType
static final ContentType
static final ContentType
-
Constructor Summary
ConstructorsConstructorDescriptionContentType
(String mimeType, Charset charset) ContentType
(String mimeType, Charset charset, NameValuePair[] params) -
Method Summary
Modifier and TypeMethodDescriptionstatic ContentType
Creates a new instance ofContentType
without a charset.static ContentType
Creates a new instance ofContentType
.static ContentType
Creates a new instance ofContentType
.static ContentType
create
(String mimeType, NameValuePair... params) Creates a new instance ofContentType
with the given parameters.private static ContentType
create
(String mimeType, NameValuePair[] params, boolean strict) private static ContentType
create
(HeaderElement helem, boolean strict) 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.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).static ContentType
getOrDefault
(HttpEntity entity) ExtractsContent-Type
value fromHttpEntity
or returns the default valueDEFAULT_TEXT
if not explicitly specified.getParameter
(String name) static ContentType
Parses textual representation ofContent-Type
value.toString()
Generates textual representation of this content type which can be used as the value of aContent-Type
header.private static boolean
withCharset
(String charset) Creates a new instance with this MIME type and the given Charset name.withCharset
(Charset charset) Creates a new instance with this MIME type and the given Charset.withParameters
(NameValuePair... params) Creates a new instance with this MIME type and the given parameters.
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
APPLICATION_ATOM_XML
-
APPLICATION_FORM_URLENCODED
-
APPLICATION_JSON
-
APPLICATION_OCTET_STREAM
-
APPLICATION_SOAP_XML
-
APPLICATION_SVG_XML
-
APPLICATION_XHTML_XML
-
APPLICATION_XML
-
IMAGE_BMP
-
IMAGE_GIF
-
IMAGE_JPEG
-
IMAGE_PNG
-
IMAGE_SVG
-
IMAGE_TIFF
-
IMAGE_WEBP
-
MULTIPART_FORM_DATA
-
TEXT_HTML
-
TEXT_PLAIN
-
TEXT_XML
-
WILDCARD
-
CONTENT_TYPE_MAP
-
DEFAULT_TEXT
-
DEFAULT_BINARY
-
mimeType
-
charset
-
params
-
-
Constructor Details
-
ContentType
-
ContentType
ContentType(String mimeType, Charset charset, NameValuePair[] params)
-
-
Method Details
-
getMimeType
-
getCharset
-
getParameter
- Since:
- 4.3
-
toString
Generates textual representation of this content type which can be used as the value of aContent-Type
header. -
valid
-
create
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
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
-
create
-
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
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
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
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
ReturnsContent-Type
for the given MIME type.- Parameters:
mimeType
- MIME type- Returns:
- content type or
null
if not known. - Since:
- 4.5
-
withCharset
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
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
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
-