NIST SIP Parser and Stack (v1.2) API

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, ReplyToHeader, RetryAfterHeader, RouteHeader, SipURI, SubscriptionStateHeader, ToHeader, ViaHeader, WWWAuthenticateHeader
All Known Implementing Classes:
Accept, AcceptEncoding, AcceptLanguage, AlertInfo, AuthenticationInfo, Authorization, CallInfo, Contact, ContentDisposition, ContentType, ErrorInfo, Event, From, ParametersHeader, ProxyAuthenticate, ProxyAuthorization, Reason, RecordRoute, ReplyTo, RetryAfter, Route, SipUri, SubscriptionState, To, Via, WWWAuthenticate

public interface Parameters

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

Version:
1.1
Author:
Sun Microsystems

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

public 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.

Returns:
the value of specified parameter

setParameter

public 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

public 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

public 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

NIST SIP Parser and Stack (v1.2) API

A product of the NIST/ITL Advanced Networking Technologies Division.
See conditions of use.
Get the latest distribution.
Submit a bug report or feature request.