java.lang.Object
jakarta.xml.soap.MimeHeaders
A container for
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.
- Since:
- 1.6
- See Also:
-
Constructor Summary
ConstructorDescriptionConstructs a defaultMimeHeaders
object initialized with an emptyVector
object. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds aMimeHeader
object with the specified name and value to thisMimeHeaders
object's list of headers.Returns all theMimeHeader
s in thisMimeHeaders
object.String[]
Returns all the values for the specified header as an array ofString
objects.getMatchingHeaders
(String[] names) Returns all theMimeHeader
objects whose name matches a name in the given array of names.getNonMatchingHeaders
(String[] names) Returns all of theMimeHeader
objects whose name does not match a name in the given array of names.void
Removes all the header entries from thisMimeHeaders
object.void
removeHeader
(String name) Remove allMimeHeader
objects whose name matches the given name.void
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.
-
Constructor Details
-
MimeHeaders
public MimeHeaders()Constructs a defaultMimeHeaders
object initialized with an emptyVector
object.
-
-
Method Details
-
getHeader
Returns all the values for the specified header as an array ofString
objects.- Parameters:
name
- the name of the header for which values will be returned- Returns:
- a
String
array with all the values for the specified header - See Also:
-
setHeader
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. This method also removes all matching headers after the first one.Note that RFC822 headers can contain only US-ASCII characters.
- Parameters:
name
- aString
with the name of the header for which to searchvalue
- aString
with the value that will replace the current value of the specified header- Throws:
IllegalArgumentException
- if there was a problem in the mime header name or the value being set- See Also:
-
addHeader
Adds aMimeHeader
object with the specified name and value to thisMimeHeaders
object's list of headers.Note that RFC822 headers can contain only US-ASCII characters.
- Parameters:
name
- aString
with the name of the header to be addedvalue
- aString
with the value of the header to be added- Throws:
IllegalArgumentException
- if there was a problem in the mime header name or value being added
-
removeHeader
Remove allMimeHeader
objects whose name matches the given name.- Parameters:
name
- aString
with the name of the header for which to search
-
removeAllHeaders
public void removeAllHeaders()Removes all the header entries from thisMimeHeaders
object. -
getAllHeaders
Returns all theMimeHeader
s in thisMimeHeaders
object.- Returns:
- an
Iterator
object over thisMimeHeaders
object's list ofMimeHeader
objects
-
getMatchingHeaders
Returns all theMimeHeader
objects whose name matches a name in the given array of names.- Parameters:
names
- an array ofString
objects with the names for which to search- Returns:
- an
Iterator
object over theMimeHeader
objects whose name matches one of the names in the given list
-
getNonMatchingHeaders
Returns all of theMimeHeader
objects whose name does not match a name in the given array of names.- Parameters:
names
- an array ofString
objects with the names for which to search- Returns:
- an
Iterator
object over theMimeHeader
objects whose name does not match one of the names in the given list
-