javax.xml.soap
Class MimeHeaders
java.lang.Object
javax.xml.soap.MimeHeaders
public class MimeHeaders
extends java.lang.Object
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 JAXM API.
MimeHeaders() - Constructs
a default
MimeHeaders object initialized with
an empty Vector object.
|
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 headers 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(names[] ) - Returns all the
MimeHeader objects whose
name matches a name in the given array of names.
|
Iterator | getNonMatchingHeaders(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 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.
|
MimeHeaders
public MimeHeaders()
Constructs
a default MimeHeaders
object initialized with
an empty Vector
object.
addHeader
public void addHeader(String name,
String value)
Adds a
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 added
getAllHeaders
public Iterator getAllHeaders()
Returns all the headers in this MimeHeaders
object.
- an
Iterator
object over this
MimeHeaders
object's list of
MimeHeader
objects
getHeader
public String[] getHeader(String name)
Returns all of the values for the specified header as an
array of String
objects.
name
- the name of the header for which
values will be returned
- a
String
array with all of the values
for the specified header
setHeader(java.lang.String, java.lang.String)
getMatchingHeaders
public Iterator getMatchingHeaders(names[] )
Returns all the MimeHeader
objects whose
name matches a name in the given array of names.
- an
Iterator
object over the
MimeHeader
objects whose name matches one of the
names in the given list
getNonMatchingHeaders
public Iterator getNonMatchingHeaders(names[] )
Returns all of the MimeHeader
objects whose
name does not match a name in the given array of names.
- an
Iterator
object over the
MimeHeader
objects whose name does not match one
of the names in the given list
removeAllHeaders
public void removeAllHeaders()
Removes all the header entries from this
MimeHeaders
object.
removeHeader
public void removeHeader(String name)
Remove all MimeHeader
objects whose name
matches the the given name.
name
- a String
with the
name of the header for which to search
setHeader
public 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. This method
also removes all matching headers after the first one.
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 header
getHeader(java.lang.String)
Copyright © 2005 Apache Web Services Project. All Rights Reserved.