|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AttachmentMetaData
Modeled heavily after the javax.xml.soap.MimeHeaders
interface.
This interface provides access to MIME headers describing attachment contents.
Method Summary | |
---|---|
void |
addMimeHeader(java.lang.String name,
java.lang.String value)
Adds a SerializableMimeHeader object with the specified name and value to this AttachmentMetaData object’s list of headers. |
java.util.Iterator |
getAllMimeHeaders()
Returns all the MIME headers associated with the attachment’s metadata. |
java.lang.String |
getAttachmentID()
Gets the unique storage ID associated with the attachment. |
java.util.Iterator |
getMatchingMimeHeaders(java.lang.String[] names)
Returns all the MIME header objects whose name matches a name in the given array of names. |
java.lang.String[] |
getMimeHeader(java.lang.String name)
Returns all of the values for the specified header as an array of String objects. |
java.util.Iterator |
getNonMatchingMimeHeaders(java.lang.String[] names)
Returns all of MIME header objects whose name does not match a name in the given array of names. |
void |
removeAllMimeHeaders()
Removes all the header entries from this attachment metadata object. |
void |
removeMimeHeader(java.lang.String name)
Remove all MIME headers whose name matches the given name. |
void |
setMimeHeader(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. |
Method Detail |
---|
java.lang.String getAttachmentID()
null
void addMimeHeader(java.lang.String name, java.lang.String value)
name
- The name of the MIME header. Must not be null
value
- The value of the MIME header. Must not be null
java.lang.IllegalArgumentException
- Thrown if either argument is null
.java.util.Iterator getAllMimeHeaders()
SerializableMimeHeader
.
null
java.lang.String[] getMimeHeader(java.lang.String name)
name
- The MIME header name. May not be null
null
if no such header exists.
java.lang.IllegalArgumentException
- Thrown if the supplied header name is null
.java.util.Iterator getMatchingMimeHeaders(java.lang.String[] names)
SerializableMimeHeader
.
names
- An array of header names. The array may not be null
or contain
any null
entries
null
java.lang.IllegalArgumentException
- Thrown if the supplied names list is null
or contains a
null
entry.java.util.Iterator getNonMatchingMimeHeaders(java.lang.String[] names)
SerializableMimeHeader
.
names
- An array of header names. The array may not be null
or contain
any null
entries
null
java.lang.IllegalArgumentException
- Thrown if the supplied names list is null
or contains a
null
entry.void removeAllMimeHeaders()
void removeMimeHeader(java.lang.String name)
name
- The name of the MIME headers to remove. May not be null
java.lang.IllegalArgumentException
- Thrown if the supplied header name is null
.void setMimeHeader(java.lang.String name, java.lang.String value)
name
- The name of the MIME header. May not be null
value
- The value of the MIME header. May not be null
java.lang.IllegalArgumentException
- Thrown if either arguments are null
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |