public class MimeHeaders extends 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(String name,
String value)
Adds a
MimeHeader object with the specified name and value
to this MimeHeaders object's list of headers. |
Iterator |
getAllHeaders()
Returns all the
MimeHeader s in this MimeHeaders object. |
String[] |
getHeader(String name)
Returns all of the values for the specified header as an array of
String objects. |
Iterator |
getMatchingHeaders(String[] names)
Returns all the
MimeHeader objects whose name matches
a name in the given array of names. |
Iterator |
getNonMatchingHeaders(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(String name)
Remove all
MimeHeader objects whose name matches the
given name. |
void |
setHeader(String name,
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 String[] getHeader(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(String name, 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 headerIllegalArgumentException
- if there was a problem in the
mime header name or the value being setgetHeader(java.lang.String)
public void addHeader(String name, 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 addedIllegalArgumentException
- if there was a problem in the
mime header name or value being addedpublic void removeHeader(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 Iterator getAllHeaders()
MimeHeader
s in this MimeHeaders
object.Iterator
object over this MimeHeaders
object's list of MimeHeader
objectspublic Iterator getMatchingHeaders(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 Iterator getNonMatchingHeaders(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 listCopyright © 2018 JBoss by Red Hat. All rights reserved.