Package org.apache.james.mime4j.dom
Interface Header
- All Known Implementing Classes:
AbstractHeader
,HeaderImpl
A header of an MIME entity (as defined in RFC 2045).
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a field to the end of the list of fields.Gets aField
given a field name.<F extends Field>
FGets aField
given a field name and of the given type.Gets the fields of this header.Gets allField
s having the specified field name.Gets allField
s having the specified field name and of the given type.Gets the fields of this header.iterator()
Returns an iterator over the list of fields of this header.int
removeFields
(String name) Removes allField
s having the specified field name.void
Sets or replaces a field.Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Method Details
-
addField
Adds a field to the end of the list of fields.- Parameters:
field
- the field to add.
-
getFields
Gets the fields of this header. The returned list will not be modifiable.- Returns:
- the list of
Field
objects.
-
getFieldsAsMap
Gets the fields of this header. The returned map will not be modifiable. For each header name, values are ordered by which they appear in the underlying entity.- Returns:
- the map of
Field
objects indexed by names.
-
getField
Gets aField
given a field name. If there are multiple such fields defined in this header the first one will be returned.- Parameters:
name
- the field name (e.g. From, Subject).- Returns:
- the field or
null
if none found.
-
getField
Gets aField
given a field name and of the given type. If there are multiple such fields defined in this header the first one will be returned.- Parameters:
name
- the field name (e.g. From, Subject).clazz
- the field class.- Returns:
- the field or
null
if none found.
-
getFields
Gets allField
s having the specified field name.- Parameters:
name
- the field name (e.g. From, Subject).- Returns:
- the list of fields.
-
getFields
Gets allField
s having the specified field name and of the given type.- Parameters:
name
- the field name (e.g. From, Subject).clazz
- the field class.- Returns:
- the list of fields.
-
iterator
Returns an iterator over the list of fields of this header. -
removeFields
Removes allField
s having the specified field name.- Parameters:
name
- the field name (e.g. From, Subject).- Returns:
- number of fields removed.
-
setField
Sets or replaces a field. This method is useful for header fields such as Subject or Message-ID that should not occur more than once in a message. If thisHeader
does not already contain a header field of the same name as the given field then it is added to the end of the list of fields (same behavior asaddField(Field)
). Otherwise the first occurrence of a field with the same name is replaced by the given field and all further occurrences are removed.- Parameters:
field
- the field to set.
-