org.lastbamboo.common.sip.stack.message.header
Interface SipHeader

All Known Implementing Classes:

SipHeaderImpl

public interface SipHeader

Interface for a single SIP header.

Method Summary

void	addValue(SipHeaderValue headerValue) Adds the value of the specified header to the value for this header.
String	getName() Accessor for the name of the header.
SipHeaderValue	getValue() Accessor for the header value.
List<SipHeaderValue>	getValues() Accessor for the header values.

Method Detail

getName

String getName()

Accessor for the name of the header.

Returns:

The name of the header.

getValues

List<SipHeaderValue> getValues()

Accessor for the header values. This is useful for headers containing multiple values. For other headers, this Collection will contain only a single entry.

Returns:

The Collection of header field values. Each entry in the collection is a header value.

addValue

void addValue(SipHeaderValue headerValue)

Adds the value of the specified header to the value for this header. This uses the rules for providing multiple header values for a single header name specified in RFC 3261 section 7.3.1.

Parameters:

headerValue - The header value to add to this header.

getValue

SipHeaderValue getValue()

Accessor for the header value. If this header contains multiple values, this will return the first one.

Returns:

The header value, or simply the first value if this header contains multiple values.