Package org.apache.tika.mime

Class MediaType

java.lang.Object

org.apache.tika.mime.MediaType

All Implemented Interfaces:

Serializable, Comparable<MediaType>

public final class MediaType
extends Object
implements Comparable<MediaType>, Serializable

Internet media type.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static MediaType	APPLICATION_XML
static MediaType	APPLICATION_ZIP
static MediaType	EMPTY
static MediaType	OCTET_STREAM
static MediaType	TEXT_HTML
static MediaType	TEXT_PLAIN

Constructor Summary

Constructors

Constructor	Description
MediaType(String type, String subtype)
MediaType(String type, String subtype, Map<String,String> parameters)
MediaType(MediaType type, String name, String value)	Creates a media type by adding a parameter to a base type.
MediaType(MediaType type, Charset charset)	Creates a media type by adding the "charset" parameter to a base type.
MediaType(MediaType type, Map<String,String> parameters)

Method Summary

Modifier and Type	Method	Description
static MediaType	application(String type)
static MediaType	audio(String type)
int	compareTo(MediaType that)
boolean	equals(Object object)
MediaType	getBaseType()	Returns the base form of the MediaType, excluding any parameters, such as "text/plain" for "text/plain; charset=utf-8"
Map<String,String>	getParameters()	Returns an immutable sorted map of the parameters of this media type.
String	getSubtype()	Return the Sub-Type of the MediaType, such as "plain" for "text/plain"
String	getType()	Return the Type of the MediaType, such as "text" for "text/plain"
int	hashCode()
boolean	hasParameters()	Checks whether this media type contains parameters.
static MediaType	image(String type)
static MediaType	parse(String string)	Parses the given string to a media type.
static Set<MediaType>	set(String... types)	Convenience method that parses the given media type strings and returns an unmodifiable set that contains all the parsed types.
static Set<MediaType>	set(MediaType... types)	Convenience method that returns an unmodifiable set that contains all the given media types.
static MediaType	text(String type)
String	toString()
static MediaType	video(String type)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

OCTET_STREAM

public static final MediaType OCTET_STREAM

EMPTY

public static final MediaType EMPTY

TEXT_PLAIN

public static final MediaType TEXT_PLAIN

TEXT_HTML

public static final MediaType TEXT_HTML

APPLICATION_XML

public static final MediaType APPLICATION_XML

APPLICATION_ZIP

public static final MediaType APPLICATION_ZIP

Constructor Detail

MediaType

public MediaType(String type,
                 String subtype,
                 Map<String,String> parameters)

MediaType

public MediaType(String type,
                 String subtype)

MediaType

public MediaType(MediaType type,
                 Map<String,String> parameters)

MediaType

public MediaType(MediaType type,
                 String name,
                 String value)

Creates a media type by adding a parameter to a base type.

Parameters:

type - base type

name - parameter name

value - parameter value

Since:

Apache Tika 1.2

MediaType

public MediaType(MediaType type,
                 Charset charset)

Creates a media type by adding the "charset" parameter to a base type.

Parameters:

type - base type

charset - charset value

Since:

Apache Tika 1.2

Method Detail

application

public static MediaType application(String type)

audio

public static MediaType audio(String type)

image

public static MediaType image(String type)

text

public static MediaType text(String type)

video

public static MediaType video(String type)

set

public static Set<MediaType> set(MediaType... types)

Convenience method that returns an unmodifiable set that contains all the given media types.

Parameters:

types - media types

Returns:

unmodifiable set of the given types

Since:

Apache Tika 1.2

set

public static Set<MediaType> set(String... types)

Convenience method that parses the given media type strings and returns an unmodifiable set that contains all the parsed types.

Parameters:

types - media type strings

Returns:

unmodifiable set of the parsed types

Since:

Apache Tika 1.2

parse

public static MediaType parse(String string)

Parses the given string to a media type. The string is expected to be of the form "type/subtype(; parameter=...)*" as defined in RFC 2045, though we also handle "charset=xxx; type/subtype" for broken web servers.

Parameters:

string - media type string to be parsed

Returns:

parsed media type, or null if parsing fails

getBaseType

public MediaType getBaseType()

Returns the base form of the MediaType, excluding any parameters, such as "text/plain" for "text/plain; charset=utf-8"

getType

public String getType()

Return the Type of the MediaType, such as "text" for "text/plain"

getSubtype

public String getSubtype()

Return the Sub-Type of the MediaType, such as "plain" for "text/plain"

hasParameters

public boolean hasParameters()

Checks whether this media type contains parameters.

Returns:

true if this type has one or more parameters, false otherwise

Since:

Apache Tika 0.8

getParameters

public Map<String,String> getParameters()

Returns an immutable sorted map of the parameters of this media type. The parameter names are guaranteed to be trimmed and in lower case.

Returns:

sorted map of parameters

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(MediaType that)

Specified by:

compareTo in interface Comparable<MediaType>