Apache JAMES Mime4j 0.6-redhat-2

org.apache.james.mime4j.field
Class ContentTypeField

java.lang.Object
  extended by org.apache.james.mime4j.field.AbstractField
      extended by org.apache.james.mime4j.field.ContentTypeField
All Implemented Interfaces:
ParsedField, Field

public class ContentTypeField
extends AbstractField

Represents a Content-Type field.


Field Summary
static String PARAM_BOUNDARY
          The name of the boundary parameter.
static String PARAM_CHARSET
          The name of the charset parameter.
static String TYPE_MESSAGE_RFC822
          The message/rfc822 MIME type.
static String TYPE_MULTIPART_DIGEST
          The multipart/digest MIME type.
static String TYPE_MULTIPART_PREFIX
          The prefix of all multipart MIME types.
static String TYPE_TEXT_PLAIN
          The text/plain MIME type.
 
Method Summary
 String getBoundary()
          Gets the value of the boundary parameter if set.
 String getCharset()
          Gets the value of the charset parameter if set.
static String getCharset(ContentTypeField f)
          Gets the value of the charset parameter if set for the given field.
 String getMimeType()
          Gets the MIME type defined in this Content-Type field.
static String getMimeType(ContentTypeField child, ContentTypeField parent)
          Gets the MIME type defined in the child's Content-Type field or derives a MIME type from the parent if child is null or hasn't got a MIME type value set.
 String getParameter(String name)
          Gets the value of a parameter.
 Map<String,String> getParameters()
          Gets all parameters.
 org.apache.james.mime4j.field.contenttype.parser.ParseException getParseException()
          Gets the exception that was raised during parsing of the field value, if any; otherwise, null.
 boolean isMimeType(String mimeType)
          Determines if the MIME type of this field matches the given one.
 boolean isMultipart()
          Determines if the MIME type of this field is multipart/*.
 
Methods inherited from class org.apache.james.mime4j.field.AbstractField
getBody, getName, getParser, getRaw, isValidField, parse, parse, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE_MULTIPART_PREFIX

public static final String TYPE_MULTIPART_PREFIX
The prefix of all multipart MIME types.

See Also:
Constant Field Values

TYPE_MULTIPART_DIGEST

public static final String TYPE_MULTIPART_DIGEST
The multipart/digest MIME type.

See Also:
Constant Field Values

TYPE_TEXT_PLAIN

public static final String TYPE_TEXT_PLAIN
The text/plain MIME type.

See Also:
Constant Field Values

TYPE_MESSAGE_RFC822

public static final String TYPE_MESSAGE_RFC822
The message/rfc822 MIME type.

See Also:
Constant Field Values

PARAM_BOUNDARY

public static final String PARAM_BOUNDARY
The name of the boundary parameter.

See Also:
Constant Field Values

PARAM_CHARSET

public static final String PARAM_CHARSET
The name of the charset parameter.

See Also:
Constant Field Values
Method Detail

getParseException

public org.apache.james.mime4j.field.contenttype.parser.ParseException getParseException()
Gets the exception that was raised during parsing of the field value, if any; otherwise, null.

Specified by:
getParseException in interface ParsedField
Overrides:
getParseException in class AbstractField
Returns:
the exception that was thrown by the field parser or null if the field is valid.
See Also:
ParsedField.getParseException()

getMimeType

public String getMimeType()
Gets the MIME type defined in this Content-Type field.

Returns:
the MIME type or an empty string if not set.

getParameter

public String getParameter(String name)
Gets the value of a parameter. Parameter names are case-insensitive.

Parameters:
name - the name of the parameter to get.
Returns:
the parameter value or null if not set.

getParameters

public Map<String,String> getParameters()
Gets all parameters.

Returns:
the parameters.

isMimeType

public boolean isMimeType(String mimeType)
Determines if the MIME type of this field matches the given one.

Parameters:
mimeType - the MIME type to match against.
Returns:
true if the MIME type of this field matches, false otherwise.

isMultipart

public boolean isMultipart()
Determines if the MIME type of this field is multipart/*.

Returns:
true if this field is has a multipart/* MIME type, false otherwise.

getBoundary

public String getBoundary()
Gets the value of the boundary parameter if set.

Returns:
the boundary parameter value or null if not set.

getCharset

public String getCharset()
Gets the value of the charset parameter if set.

Returns:
the charset parameter value or null if not set.

getMimeType

public static String getMimeType(ContentTypeField child,
                                 ContentTypeField parent)
Gets the MIME type defined in the child's Content-Type field or derives a MIME type from the parent if child is null or hasn't got a MIME type value set. If child's MIME type is multipart but no boundary has been set the MIME type of child will be derived from the parent.

Parameters:
child - the child.
parent - the parent.
Returns:
the MIME type.

getCharset

public static String getCharset(ContentTypeField f)
Gets the value of the charset parameter if set for the given field. Returns the default us-ascii if not set or if f is null.

Returns:
the charset parameter value.

Apache JAMES Mime4j 0.6-redhat-2

Copyright © 2004-2012 JBoss by Red Hat. All Rights Reserved.