public class MimeHeaders
extends java.lang.Object
MimeHeader objects, which represent
the MIME headers present in a MIME part of a message.
This class is used primarily when an application wants to
retrieve specific attachments based on certain MIME headers and
values. This class will most likely be used by implementations of
AttachmentPart and other MIME dependent parts of the SAAJ
API.
SOAPMessage.getAttachments(),
AttachmentPart| Constructor and Description |
|---|
MimeHeaders()
Constructs a default
MimeHeaders object initialized with
an empty Vector object. |
| Modifier and Type | Method and Description |
|---|---|
void |
addHeader(java.lang.String name,
java.lang.String value)
Adds a
MimeHeader object with the specified name and value
to this MimeHeaders object's list of headers. |
java.util.Iterator<MimeHeader> |
getAllHeaders()
Returns all the
MimeHeaders in this MimeHeaders object. |
java.lang.String[] |
getHeader(java.lang.String name)
Returns all of the values for the specified header as an array of
String objects. |
java.util.Iterator<MimeHeader> |
getMatchingHeaders(java.lang.String[] names)
Returns all the
MimeHeader objects whose name matches
a name in the given array of names. |
java.util.Iterator<MimeHeader> |
getNonMatchingHeaders(java.lang.String[] names)
Returns all of the
MimeHeader objects whose name does not
match a name in the given array of names. |
void |
removeAllHeaders()
Removes all the header entries from this
MimeHeaders object. |
void |
removeHeader(java.lang.String name)
Remove all
MimeHeader objects whose name matches the
given name. |
void |
setHeader(java.lang.String name,
java.lang.String value)
Replaces the current value of the first header entry whose name matches
the given name with the given value, adding a new header if no existing header
name matches.
|
public MimeHeaders()
MimeHeaders object initialized with
an empty Vector object.public java.lang.String[] getHeader(java.lang.String name)
String objects.name - the name of the header for which values will be returnedString array with all of the values for the
specified headersetHeader(java.lang.String, java.lang.String)public void setHeader(java.lang.String name,
java.lang.String value)
Note that RFC822 headers can contain only US-ASCII characters.
name - a String with the name of the header for
which to searchvalue - a String with the value that will replace the
current value of the specified headerjava.lang.IllegalArgumentException - if there was a problem in the
mime header name or the value being setgetHeader(java.lang.String)public void addHeader(java.lang.String name,
java.lang.String value)
MimeHeader object with the specified name and value
to this MimeHeaders object's list of headers.
Note that RFC822 headers can contain only US-ASCII characters.
name - a String with the name of the header to
be addedvalue - a String with the value of the header to
be addedjava.lang.IllegalArgumentException - if there was a problem in the
mime header name or value being addedpublic void removeHeader(java.lang.String name)
MimeHeader objects whose name matches the
given name.name - a String with the name of the header for
which to searchpublic void removeAllHeaders()
MimeHeaders object.public java.util.Iterator<MimeHeader> getAllHeaders()
MimeHeaders in this MimeHeaders object.Iterator object over this MimeHeaders
object's list of MimeHeader objectspublic java.util.Iterator<MimeHeader> getMatchingHeaders(java.lang.String[] names)
MimeHeader objects whose name matches
a name in the given array of names.names - an array of String objects with the names
for which to searchIterator object over the MimeHeader
objects whose name matches one of the names in the given listpublic java.util.Iterator<MimeHeader> getNonMatchingHeaders(java.lang.String[] names)
MimeHeader objects whose name does not
match a name in the given array of names.names - an array of String objects with the names
for which to searchIterator object over the MimeHeader
objects whose name does not match one of the names in the given list