public class

ContentType

extends Object
java.lang.Object
   ↳ com.google.code.javax.mail.internet.ContentType

Class Overview

This class represents a MIME ContentType value. It provides methods to parse a ContentType string into individual components and to generate a MIME style ContentType string.

Summary

Fields
private ParameterList list
private String primaryType
private String subType
Public Constructors
ContentType()
No-arg Constructor.
ContentType(String primaryType, String subType, ParameterList list)
Constructor.
ContentType(String s)
Constructor that takes a Content-Type string.
Public Methods
String getBaseType()
Return the MIME type string, without the parameters.
String getParameter(String name)
Return the specified parameter value.
ParameterList getParameterList()
Return a ParameterList object that holds all the available parameters.
String getPrimaryType()
Return the primary type.
String getSubType()
Return the subType.
boolean match(ContentType cType)
Match with the specified ContentType object.
boolean match(String s)
Match with the specified content-type string.
void setParameter(String name, String value)
Set the specified parameter.
void setParameterList(ParameterList list)
Set a new ParameterList.
void setPrimaryType(String primaryType)
Set the primary type.
void setSubType(String subType)
Set the subType.
String toString()
Retrieve a RFC2045 style string representation of this Content-Type.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

private ParameterList list

private String primaryType

private String subType

Public Constructors

public ContentType ()

No-arg Constructor.

public ContentType (String primaryType, String subType, ParameterList list)

Constructor.

Parameters
primaryType Primary type
subType SubType
list ParameterList

public ContentType (String s)

Constructor that takes a Content-Type string. The String is parsed into its constituents: primaryType, subType and parameters. A ParseException is thrown if the parse fails.

Parameters
s The Content-Type string.
Throws
ParseException if the parse fails.

Public Methods

public String getBaseType ()

Return the MIME type string, without the parameters. The returned value is basically the concatenation of the primaryType, the '/' character and the secondaryType.

Returns
  • the type

public String getParameter (String name)

Return the specified parameter value. Returns null if this parameter is absent.

Parameters
name
Returns
  • parameter value

public ParameterList getParameterList ()

Return a ParameterList object that holds all the available parameters. Returns null if no parameters are available.

Returns
  • ParameterList

public String getPrimaryType ()

Return the primary type.

Returns
  • the primary type

public String getSubType ()

Return the subType.

Returns
  • the subType

public boolean match (ContentType cType)

Match with the specified ContentType object. This method compares only the primaryType and subType . The parameters of both operands are ignored.

For example, this method will return true when comparing the ContentTypes for "text/plain" and "text/plain; charset=foobar". If the subType of either operand is the special character '*', then the subtype is ignored during the match. For example, this method will return true when comparing the ContentTypes for "text/plain" and "text/*"

Parameters
cType ContentType to compare this against

public boolean match (String s)

Match with the specified content-type string. This method compares only the primaryType and subType . The parameters of both operands are ignored.

For example, this method will return true when comparing the ContentType for "text/plain" with "text/plain; charset=foobar". If the subType of either operand is the special character '*', then the subtype is ignored during the match. For example, this method will return true when comparing the ContentType for "text/plain" with "text/*"

Parameters
s

public void setParameter (String name, String value)

Set the specified parameter. If this parameter already exists, it is replaced by this new value.

Parameters
name Parameter name
value Parameter value

public void setParameterList (ParameterList list)

Set a new ParameterList.

Parameters
list ParameterList

public void setPrimaryType (String primaryType)

Set the primary type. Overrides existing primary type.

Parameters
primaryType Primary type

public void setSubType (String subType)

Set the subType. Replaces the existing subType.

Parameters
subType The subType

public String toString ()

Retrieve a RFC2045 style string representation of this Content-Type. Returns null if the conversion failed.

Returns
  • RFC2045 style string