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

All Known Implementing Classes:

SipHeaderValueImpl

public interface SipHeaderValue

The value of the header.

Method Summary

String	getBaseValue() Accessor for the header value with no parameters.
Map<String,String>	getParams() Accessor for the map of header value parameters.
String	getParamValue(String paramName) Accessor for the value of the specified parameter.
boolean	hasParam(String paramName) Determines whether this header value contains the specified parameter name.

Method Detail

getBaseValue

String getBaseValue()

Accessor for the header value with no parameters.

Returns:

The header value with no parameters.

hasParam

boolean hasParam(String paramName)

Determines whether this header value contains the specified parameter name.

Parameters:

paramName - The name of the specified parameter.

Returns:

true if the value has a parameter of the specified name, otherwise false.

getParamValue

String getParamValue(String paramName)

Accessor for the value of the specified parameter. Note that param values are immutable strings, so this preserved the immutability of header values.

Parameters:

paramName - The name of the parameter to access.

Returns:

The value of the parameter with the specified name.

getParams

Map<String,String> getParams()

Accessor for the map of header value parameters. This returns a copy of the parameters, preserving the immutability of the header value.

Returns:

The map of header value parameters.