|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.http.entity.ContentType
@Contract(threading=IMMUTABLE) public final class ContentType
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.
Field Summary | |
---|---|
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 |
IMAGE_BMP
|
static ContentType |
IMAGE_GIF
|
static ContentType |
IMAGE_JPEG
|
static ContentType |
IMAGE_PNG
|
static ContentType |
IMAGE_SVG
|
static ContentType |
IMAGE_TIFF
|
static ContentType |
IMAGE_WEBP
|
static ContentType |
MULTIPART_FORM_DATA
|
static ContentType |
TEXT_HTML
|
static ContentType |
TEXT_PLAIN
|
static ContentType |
TEXT_XML
|
static ContentType |
WILDCARD
|
Method Summary | |
---|---|
static ContentType |
create(String mimeType)
Creates a new instance of ContentType without a charset. |
static ContentType |
create(String mimeType,
Charset charset)
Creates a new instance of ContentType . |
static ContentType |
create(String mimeType,
NameValuePair... params)
Creates a new instance of ContentType with the given parameters. |
static ContentType |
create(String mimeType,
String charset)
Creates a new instance of ContentType . |
static ContentType |
get(HttpEntity entity)
Extracts Content-Type value from HttpEntity exactly as
specified by the Content-Type header of the entity. |
static ContentType |
getByMimeType(String mimeType)
Returns Content-Type for the given MIME type. |
Charset |
getCharset()
|
static ContentType |
getLenient(HttpEntity entity)
Extracts Content-Type value from HttpEntity . |
static ContentType |
getLenientOrDefault(HttpEntity entity)
Extracts Content-Type value from HttpEntity or returns the default value
DEFAULT_TEXT if not explicitly specified or incorrect (could not be parsed). |
String |
getMimeType()
|
static ContentType |
getOrDefault(HttpEntity entity)
Extracts Content-Type value from HttpEntity or returns the default value
DEFAULT_TEXT if not explicitly specified. |
String |
getParameter(String name)
|
static ContentType |
parse(String s)
Parses textual representation of Content-Type value. |
String |
toString()
Generates textual representation of this content type which can be used as the value of a Content-Type header. |
ContentType |
withCharset(Charset charset)
Creates a new instance with this MIME type and the given Charset. |
ContentType |
withCharset(String charset)
Creates a new instance with this MIME type and the given Charset name. |
ContentType |
withParameters(NameValuePair... params)
Creates a new instance with this MIME type and the given parameters. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final ContentType APPLICATION_ATOM_XML
public static final ContentType APPLICATION_FORM_URLENCODED
public static final ContentType APPLICATION_JSON
public static final ContentType APPLICATION_OCTET_STREAM
public static final ContentType APPLICATION_SVG_XML
public static final ContentType APPLICATION_XHTML_XML
public static final ContentType APPLICATION_XML
public static final ContentType IMAGE_BMP
public static final ContentType IMAGE_GIF
public static final ContentType IMAGE_JPEG
public static final ContentType IMAGE_PNG
public static final ContentType IMAGE_SVG
public static final ContentType IMAGE_TIFF
public static final ContentType IMAGE_WEBP
public static final ContentType MULTIPART_FORM_DATA
public static final ContentType TEXT_HTML
public static final ContentType TEXT_PLAIN
public static final ContentType TEXT_XML
public static final ContentType WILDCARD
public static final ContentType DEFAULT_TEXT
public static final ContentType DEFAULT_BINARY
Method Detail |
---|
public String getMimeType()
public Charset getCharset()
public String getParameter(String name)
public String toString()
Content-Type
header.
toString
in class Object
public static ContentType create(String mimeType, Charset charset)
ContentType
.
mimeType
- MIME type. It may not be null
or empty. It may not contain
characters <">, <;>, <,>
reserved by the HTTP specification.charset
- charset.
public static ContentType create(String mimeType)
ContentType
without a charset.
mimeType
- MIME type. It may not be null
or empty. It may not contain
characters <">, <;>, <,>
reserved by the HTTP specification.
public static ContentType create(String mimeType, String charset) throws UnsupportedCharsetException
ContentType
.
mimeType
- MIME type. It may not be null
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.
UnsupportedCharsetException
- Thrown when the named charset is not available in
this instance of the Java virtual machinepublic static ContentType create(String mimeType, NameValuePair... params) throws UnsupportedCharsetException
ContentType
with the given parameters.
mimeType
- MIME type. It may not be null
or empty. It may not contain
characters <">, <;>, <,>
reserved by the HTTP specification.params
- parameters.
UnsupportedCharsetException
public static ContentType parse(String s) throws ParseException, UnsupportedCharsetException
Content-Type
value.
s
- text
ParseException
- if the given text does not represent a valid
Content-Type
value.
UnsupportedCharsetException
- Thrown when the named charset is not available in
this instance of the Java virtual machinepublic static ContentType get(HttpEntity entity) throws ParseException, UnsupportedCharsetException
Content-Type
value from HttpEntity
exactly as
specified by the Content-Type
header of the entity. Returns null
if not specified.
entity
- HTTP entity
ParseException
- if the given text does not represent a valid
Content-Type
value.
UnsupportedCharsetException
- Thrown when the named charset is not available in
this instance of the Java virtual machinepublic static ContentType getLenient(HttpEntity entity)
Content-Type
value from HttpEntity
. Returns null
if not specified or incorrect (could not be parsed)..
entity
- HTTP entity
public static ContentType getOrDefault(HttpEntity entity) throws ParseException, UnsupportedCharsetException
Content-Type
value from HttpEntity
or returns the default value
DEFAULT_TEXT
if not explicitly specified.
entity
- HTTP entity
ParseException
- if the given text does not represent a valid
Content-Type
value.
UnsupportedCharsetException
- Thrown when the named charset is not available in
this instance of the Java virtual machinepublic static ContentType getLenientOrDefault(HttpEntity entity) throws ParseException, UnsupportedCharsetException
Content-Type
value from HttpEntity
or returns the default value
DEFAULT_TEXT
if not explicitly specified or incorrect (could not be parsed).
entity
- HTTP entity
ParseException
UnsupportedCharsetException
public static ContentType getByMimeType(String mimeType)
Content-Type
for the given MIME type.
mimeType
- MIME type
null
if not known.public ContentType withCharset(Charset charset)
charset
- charset
public ContentType withCharset(String charset)
charset
- name
UnsupportedCharsetException
- Thrown when the named charset is not available in
this instance of the Java virtual machinepublic ContentType withParameters(NameValuePair... params) throws UnsupportedCharsetException
params
-
UnsupportedCharsetException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |