javax.sip.header
Interface Parameters

All Known Subinterfaces:

AcceptEncodingHeader, AcceptHeader, AcceptLanguageHeader, AlertInfoHeader, AuthenticationInfoHeader, AuthorizationHeader, CallInfoHeader, ContactHeader, ContentDispositionHeader, ContentTypeHeader, ErrorInfoHeader, EventHeader, FromHeader, ProxyAuthenticateHeader, ProxyAuthorizationHeader, ReasonHeader, RecordRouteHeader, ReferToHeader, ReplyToHeader, RetryAfterHeader, RouteHeader, SipURI, SubscriptionStateHeader, TelURL, ToHeader, ViaHeader, WWWAuthenticateHeader

public interface Parameters

This interface defines methods for accessing generic parameters for Headers that contain generic parameter values.

Version:

1.2

Author:

BEA Systems, NIST

Method Summary

String	getParameter(String name) Returns the value of the named parameter, or null if it is not set.
Iterator	getParameterNames() Returns an Iterator over the names (Strings) of all parameters present in this ParametersHeader.
void	removeParameter(String name) Removes the specified parameter from Parameters of this ParametersHeader.
void	setParameter(String name, String value) Sets the value of the specified parameter.

Method Detail

getParameter

String getParameter(String name)

Returns the value of the named parameter, or null if it is not set. A zero-length String indicates flag parameter.

Parameters:

name - name of parameter to retrieve

Returns:

the value of specified parameter

setParameter

void setParameter(String name,
                  String value)
                  throws ParseException

Sets the value of the specified parameter. If the parameter already had a value it will be overwritten. A zero-length String indicates flag parameter.

Parameters:

name - - a String specifying the parameter name

value - - a String specifying the parameter value

Throws:

ParseException - which signals that an error has been reached unexpectedly while parsing the parameter name or value.

getParameterNames

Iterator getParameterNames()

Returns an Iterator over the names (Strings) of all parameters present in this ParametersHeader.

Returns:

an Iterator over all the parameter names

removeParameter

void removeParameter(String name)

Removes the specified parameter from Parameters of this ParametersHeader. This method returns silently if the parameter is not part of the ParametersHeader.

Parameters:

name - - a String specifying the parameter name