Package org.apache.james.mime4j.field
Class ContentDispositionFieldImpl
- java.lang.Object
-
- org.apache.james.mime4j.field.AbstractField
-
- org.apache.james.mime4j.field.ContentDispositionFieldImpl
-
- All Implemented Interfaces:
ContentDispositionField
,ParsedField
,Field
public class ContentDispositionFieldImpl extends AbstractField implements ContentDispositionField
Represents aContent-Disposition
field.
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.Date
creationDate
private boolean
creationDateParsed
private java.lang.String
dispositionType
private java.util.Date
modificationDate
private boolean
modificationDateParsed
private java.util.Map<java.lang.String,java.lang.String>
parameters
private boolean
parsed
private ParseException
parseException
static FieldParser<ContentDispositionField>
PARSER
private java.util.Date
readDate
private boolean
readDateParsed
-
Fields inherited from class org.apache.james.mime4j.field.AbstractField
monitor, rawField
-
Fields inherited from interface org.apache.james.mime4j.dom.field.ContentDispositionField
DISPOSITION_TYPE_ATTACHMENT, DISPOSITION_TYPE_INLINE, PARAM_CREATION_DATE, PARAM_FILENAME, PARAM_MODIFICATION_DATE, PARAM_READ_DATE, PARAM_SIZE
-
-
Constructor Summary
Constructors Constructor Description ContentDispositionFieldImpl(Field rawField, DecodeMonitor monitor)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Date
getCreationDate()
Gets the value of thecreation-date
parameter if set and valid.java.lang.String
getDispositionType()
Gets the disposition type defined in this Content-Disposition field.java.lang.String
getFilename()
Gets the value of thefilename
parameter if set.java.util.Date
getModificationDate()
Gets the value of themodification-date
parameter if set and valid.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.ParseException
getParseException()
Gets the exception that was raised during parsing of the field value, if any; otherwise, null.java.util.Date
getReadDate()
Gets the value of theread-date
parameter if set and valid.long
getSize()
Gets the value of thesize
parameter if set and valid.boolean
isAttachment()
Returntrue
if the disposition type of this field is attachment,false
otherwise.boolean
isDispositionType(java.lang.String dispositionType)
Determines if the disposition type of this field matches the given one.boolean
isInline()
Returntrue
if the disposition type of this field is inline,false
otherwise.private void
parse()
private java.util.Date
parseDate(java.lang.String paramName)
-
Methods inherited from class org.apache.james.mime4j.field.AbstractField
getBody, getName, getNameLowerCase, getRaw, getRawField, isValidField, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.james.mime4j.dom.field.ContentDispositionField
bodyDescriptionField
-
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
isValidField
-
-
-
-
Field Detail
-
parsed
private boolean parsed
-
dispositionType
private java.lang.String dispositionType
-
parameters
private final java.util.Map<java.lang.String,java.lang.String> parameters
-
parseException
private ParseException parseException
-
creationDateParsed
private boolean creationDateParsed
-
creationDate
private java.util.Date creationDate
-
modificationDateParsed
private boolean modificationDateParsed
-
modificationDate
private java.util.Date modificationDate
-
readDateParsed
private boolean readDateParsed
-
readDate
private java.util.Date readDate
-
PARSER
public static final FieldParser<ContentDispositionField> PARSER
-
-
Constructor Detail
-
ContentDispositionFieldImpl
ContentDispositionFieldImpl(Field rawField, DecodeMonitor monitor)
-
-
Method Detail
-
getParseException
public ParseException getParseException()
Gets the exception that was raised during parsing of the field value, if any; otherwise, null.- Specified by:
getParseException
in interfaceParsedField
- Overrides:
getParseException
in classAbstractField
- Returns:
- the exception that was thrown by the field parser or
null
if the field is valid. - See Also:
ParsedField.getParseException()
-
getDispositionType
public java.lang.String getDispositionType()
Description copied from interface:ContentDispositionField
Gets the disposition type defined in this Content-Disposition field.- Specified by:
getDispositionType
in interfaceContentDispositionField
- Returns:
- the disposition type or an empty string if not set.
- See Also:
ContentDispositionField.getDispositionType()
-
getParameter
public java.lang.String getParameter(java.lang.String name)
Description copied from interface:ContentDispositionField
Gets the value of a parameter. Parameter names are case-insensitive.- Specified by:
getParameter
in interfaceContentDispositionField
- Parameters:
name
- the name of the parameter to get.- Returns:
- the parameter value or
null
if not set. - See Also:
ContentDispositionField.getParameter(java.lang.String)
-
getParameters
public java.util.Map<java.lang.String,java.lang.String> getParameters()
Description copied from interface:ContentDispositionField
Gets all parameters.- Specified by:
getParameters
in interfaceContentDispositionField
- Returns:
- the parameters.
- See Also:
ContentDispositionField.getParameters()
-
isDispositionType
public boolean isDispositionType(java.lang.String dispositionType)
Description copied from interface:ContentDispositionField
Determines if the disposition type of this field matches the given one.- Specified by:
isDispositionType
in interfaceContentDispositionField
- Parameters:
dispositionType
- the disposition type to match against.- Returns:
true
if the disposition type of this field matches,false
otherwise.- See Also:
ContentDispositionField.isDispositionType(java.lang.String)
-
isInline
public boolean isInline()
Description copied from interface:ContentDispositionField
Returntrue
if the disposition type of this field is inline,false
otherwise.- Specified by:
isInline
in interfaceContentDispositionField
- Returns:
true
if the disposition type of this field is inline,false
otherwise.- See Also:
ContentDispositionField.isInline()
-
isAttachment
public boolean isAttachment()
Description copied from interface:ContentDispositionField
Returntrue
if the disposition type of this field is attachment,false
otherwise.- Specified by:
isAttachment
in interfaceContentDispositionField
- Returns:
true
if the disposition type of this field is attachment,false
otherwise.- See Also:
ContentDispositionField.isAttachment()
-
getFilename
public java.lang.String getFilename()
Description copied from interface:ContentDispositionField
Gets the value of thefilename
parameter if set.- Specified by:
getFilename
in interfaceContentDispositionField
- Returns:
- the
filename
parameter value ornull
if not set. - See Also:
ContentDispositionField.getFilename()
-
getCreationDate
public java.util.Date getCreationDate()
Description copied from interface:ContentDispositionField
Gets the value of thecreation-date
parameter if set and valid.- Specified by:
getCreationDate
in interfaceContentDispositionField
- Returns:
- the
creation-date
parameter value ornull
if not set or invalid. - See Also:
ContentDispositionField.getCreationDate()
-
getModificationDate
public java.util.Date getModificationDate()
Description copied from interface:ContentDispositionField
Gets the value of themodification-date
parameter if set and valid.- Specified by:
getModificationDate
in interfaceContentDispositionField
- Returns:
- the
modification-date
parameter value ornull
if not set or invalid. - See Also:
ContentDispositionField.getModificationDate()
-
getReadDate
public java.util.Date getReadDate()
Description copied from interface:ContentDispositionField
Gets the value of theread-date
parameter if set and valid.- Specified by:
getReadDate
in interfaceContentDispositionField
- Returns:
- the
read-date
parameter value ornull
if not set or invalid. - See Also:
ContentDispositionField.getReadDate()
-
getSize
public long getSize()
Description copied from interface:ContentDispositionField
Gets the value of thesize
parameter if set and valid.- Specified by:
getSize
in interfaceContentDispositionField
- Returns:
- the
size
parameter value or-1
if not set or invalid. - See Also:
ContentDispositionField.getSize()
-
parseDate
private java.util.Date parseDate(java.lang.String paramName)
-
parse
private void parse()
-
-