Package org.apache.tika.mime

Class MimeType

java.lang.Object

org.apache.tika.mime.MimeType

All Implemented Interfaces:

Serializable, Comparable<MimeType>

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

Internet media type.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
int	compareTo(MimeType mime)
boolean	equals(Object o)
String	getAcronym()	Returns an acronym for this mime type.
String	getDescription()	Returns the description of this media type.
String	getExtension()	Returns the preferred file extension of this type, or an empty string if no extensions are known.
List<String>	getExtensions()	Returns the list of all known file extensions of this media type.
List<URI>	getLinks()	Get a list of links to help document this mime type
String	getName()	Returns the name of this media type.
MediaType	getType()	Returns the normalized media type name.
String	getUniformTypeIdentifier()	Get the UTI for this mime type.
int	hashCode()
boolean	hasMagic()
static boolean	isValid(String name)	Checks that the given string is a valid Internet media type name based on rules from RFC 2054 section 5.3.
boolean	matches(byte[] data)
boolean	matchesMagic(byte[] data)
void	setDescription(String description)	Set the description of this media type.
String	toString()	Returns the name of this media type.

Methods inherited from class java.lang.Object

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

Method Detail

isValid

public static boolean isValid(String name)

Checks that the given string is a valid Internet media type name based on rules from RFC 2054 section 5.3. For validation purposes the rules can be simplified to the following:

 name := token "/" token
 token := 1*<any (US-ASCII) CHAR except SPACE, CTLs, or tspecials>
 tspecials :=  "(" / ")" / "<" / ">" / "@" / "," / ";" / ":" /
               "\" / <"> / "/" / "[" / "]" / "?" / "="
 

Parameters:

name - name string

Returns:

true if the string is a valid media type name, false otherwise

getType

public MediaType getType()

Returns the normalized media type name.

Returns:

media type

getName

public String getName()

Returns the name of this media type.

Returns:

media type name (lower case)

getDescription

public String getDescription()

Returns the description of this media type.

Returns:

media type description

setDescription

public void setDescription(String description)

Set the description of this media type.

Parameters:

description - media type description

getAcronym

public String getAcronym()

Returns an acronym for this mime type.

Returns:

mime type acronym

getUniformTypeIdentifier

public String getUniformTypeIdentifier()

Get the UTI for this mime type.

Returns:

The Uniform Type Identifier

See Also:

http://en.wikipedia.org/wiki/Uniform_Type_Identifier

getLinks

public List<URI> getLinks()

Get a list of links to help document this mime type

Returns:

an array of links (will never be null)

hasMagic

public boolean hasMagic()

matchesMagic

public boolean matchesMagic(byte[] data)

matches

public boolean matches(byte[] data)

compareTo

public int compareTo(MimeType mime)

Specified by:

compareTo in interface Comparable<MimeType>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Returns the name of this media type.

Overrides:

toString in class Object

Returns:

media type name

getExtension

public String getExtension()

Returns the preferred file extension of this type, or an empty string if no extensions are known. Use the getExtensions() method to get the full list of known extensions of this type.

Returns:

preferred file extension or empty string

Since:

Apache Tika 0.9

getExtensions

public List<String> getExtensions()

Returns the list of all known file extensions of this media type.

Returns:

known extensions in order of preference (best first)

Since:

Apache Tika 0.10