Interface ContentTypeField
-
- All Superinterfaces:
Field
,ParsedField
- All Known Implementing Classes:
ContentTypeFieldImpl
,ContentTypeFieldLenientImpl
public interface ContentTypeField extends ParsedField
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
PARAM_BOUNDARY
The name of theboundary
parameter.static java.lang.String
PARAM_CHARSET
The name of thecharset
parameter.static java.lang.String
TYPE_MESSAGE_RFC822
Themessage/rfc822
MIME type.static java.lang.String
TYPE_MULTIPART_DIGEST
Themultipart/digest
MIME type.static java.lang.String
TYPE_MULTIPART_PREFIX
The prefix of allmultipart
MIME types.static java.lang.String
TYPE_TEXT_PLAIN
Thetext/plain
MIME type.
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default boolean
bodyDescriptionField()
java.lang.String
getBoundary()
Gets the value of theboundary
parameter if set.java.lang.String
getCharset()
Gets the value of thecharset
parameter if set.java.lang.String
getMediaType()
Gets the media type defined in this Content-Type field.java.lang.String
getMimeType()
Gets the MIME type defined in this Content-Type field.java.lang.String
getParameter(java.lang.String name)
Gets the value of a parameter.java.util.Map<java.lang.String,java.lang.String>
getParameters()
Gets all parameters.java.lang.String
getSubType()
Gets the subtype defined in this Content-Type field.boolean
isMimeType(java.lang.String mimeType)
Determines if the MIME type of this field matches the given one.boolean
isMultipart()
Determines if the MIME type of this field ismultipart/*
.-
Methods inherited from interface org.apache.james.mime4j.stream.Field
getBody, getName, getNameLowerCase, getRaw
-
Methods inherited from interface org.apache.james.mime4j.dom.field.ParsedField
getParseException, isValidField
-
-
-
-
Field Detail
-
TYPE_MULTIPART_PREFIX
static final java.lang.String TYPE_MULTIPART_PREFIX
The prefix of allmultipart
MIME types.- See Also:
- Constant Field Values
-
TYPE_MULTIPART_DIGEST
static final java.lang.String TYPE_MULTIPART_DIGEST
Themultipart/digest
MIME type.- See Also:
- Constant Field Values
-
TYPE_TEXT_PLAIN
static final java.lang.String TYPE_TEXT_PLAIN
Thetext/plain
MIME type.- See Also:
- Constant Field Values
-
TYPE_MESSAGE_RFC822
static final java.lang.String TYPE_MESSAGE_RFC822
Themessage/rfc822
MIME type.- See Also:
- Constant Field Values
-
PARAM_BOUNDARY
static final java.lang.String PARAM_BOUNDARY
The name of theboundary
parameter.- See Also:
- Constant Field Values
-
PARAM_CHARSET
static final java.lang.String PARAM_CHARSET
The name of thecharset
parameter.- See Also:
- Constant Field Values
-
-
Method Detail
-
bodyDescriptionField
default boolean bodyDescriptionField()
- Specified by:
bodyDescriptionField
in interfaceParsedField
-
getMimeType
java.lang.String getMimeType()
Gets the MIME type defined in this Content-Type field.- Returns:
- the MIME type or an empty string if not set.
-
getMediaType
java.lang.String getMediaType()
Gets the media type defined in this Content-Type field.
-
getSubType
java.lang.String getSubType()
Gets the subtype defined in this Content-Type field.
-
getParameter
java.lang.String getParameter(java.lang.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
java.util.Map<java.lang.String,java.lang.String> getParameters()
Gets all parameters.- Returns:
- the parameters.
-
isMimeType
boolean isMimeType(java.lang.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
boolean isMultipart()
Determines if the MIME type of this field ismultipart/*
.- Returns:
true
if this field is has amultipart/*
MIME type,false
otherwise.
-
getBoundary
java.lang.String getBoundary()
Gets the value of theboundary
parameter if set.- Returns:
- the
boundary
parameter value ornull
if not set.
-
getCharset
java.lang.String getCharset()
Gets the value of thecharset
parameter if set.- Returns:
- the
charset
parameter value ornull
if not set.
-
-