MimeHeaders

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS (src) NEXT CLASS (src)

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.xml.soap
Class MimeHeaders

java.lang.Object
  javax.xml.soap.MimeHeaders

Direct Known Subclasses:: MimeHeadersImpl (src)

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 SAAJ API.

Constructor Summary
`MimeHeaders()`

Method Summary
`void`	`addHeader(java.lang.String name, java.lang.String value)`
`java.util.Iterator`	`getAllHeaders()`
`java.lang.String[]`	`getHeader(java.lang.String name)`
`java.util.Iterator`	`getMatchingHeaders(java.lang.String[] names)`
`java.util.Iterator`	`getNonMatchingHeaders(java.lang.String[] names)`
`void`	`removeAllHeaders()`
`void`	`removeHeader(java.lang.String 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MimeHeaders

public MimeHeaders()

Method Detail

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)
               throws java.lang.IllegalArgumentException

Parameters:: name -; value -
Throws:: java.lang.IllegalArgumentException - - if name is null or empty.

getAllHeaders

public java.util.Iterator getAllHeaders()

getHeader

public java.lang.String[] getHeader(java.lang.String name)

Parameters:: name -
Returns:: All matching header values if found, null otherwise

getMatchingHeaders

public java.util.Iterator getMatchingHeaders(java.lang.String[] names)

getNonMatchingHeaders

public java.util.Iterator getNonMatchingHeaders(java.lang.String[] names)

removeAllHeaders

public void removeAllHeaders()

removeHeader

public void removeHeader(java.lang.String name)

setHeader

public 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. This method also removes all matching headers after the first one.