gov.nist.javax.sip.header
クラス ParametersHeader

java.lang.Object
  gov.nist.core.GenericObject
      gov.nist.javax.sip.header.SIPObject
          gov.nist.javax.sip.header.SIPHeader
              gov.nist.javax.sip.header.ParametersHeader

すべての実装されたインタフェース:

SIPHeaderNames, java.io.Serializable, java.lang.Cloneable, javax.sip.header.Header, javax.sip.header.Parameters

直系の既知のサブクラス:

Accept, AcceptEncoding, AcceptLanguage, AddressParametersHeader, AlertInfo, AuthenticationHeader, AuthenticationInfo, CallInfo, ContentDisposition, ContentType, ErrorInfo, Event, Reason, RetryAfter, SubscriptionState, Via

public abstract class ParametersHeader
extends SIPHeader
implements javax.sip.header.Parameters

Parameters header. Suitable for extension by headers that have parameters.

バージョン:

JAIN-SIP-1.1 $Revision: 1.4 $ $Date: 2004/04/15 16:20:38 $

作成者:

M. Ranganathan
This code is in the public domain.

関連項目:

直列化された形式

フィールドの概要

インタフェース gov.nist.javax.sip.header.SIPHeaderNames から継承されたフィールド

ACCEPT, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ALERT_INFO, ALLOW, ALLOW_EVENTS, AUTHENTICATION_INFO, AUTHORIZATION, CALL_ID, CALL_INFO, CONTACT, CONTENT_DISPOSITION, CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_TYPE, CSEQ, DATE, ERROR_INFO, EVENT, EXPIRES, FROM, IN_REPLY_TO, MAX_FORWARDS, MIME_VERSION, MIN_EXPIRES, ORGANIZATION, PRIORITY, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, PROXY_REQUIRE, RACK, REASON, RECORD_ROUTE, REPLY_TO, REQUIRE, RETRY_AFTER, ROUTE, RSEQ, SERVER, SUBJECT, SUBSCRIPTION_STATE, SUPPORTED, TIMESTAMP, TO, UNSUPPORTED, USER_AGENT, VIA, WARNING, WWW_AUTHENTICATE

メソッドの概要

NameValue	getNameValue(java.lang.String parameterName) This is for the benifit of the TCK.
java.lang.String	getParameter(java.lang.String name) Returns the value of the named parameter, or null if it is not set.
java.util.Iterator	getParameterNames() Returns an Iterator over the names (Strings) of all parameters present in this ParametersHeader.
NameValueList	getParameters() get the parameter list.
java.lang.Object	getParameterValue(java.lang.String name) Return the parameter as an object (dont convert to string).
boolean	hasParameter(java.lang.String parameterName) Return true if has a parameter.
boolean	hasParameters() Return true if you have a parameter and false otherwise.
void	removeParameter(java.lang.String name) Removes the specified parameter from Parameters of this ParametersHeader.
void	removeParameters() Remove all parameters.
void	setParameter(NameValue nameValue) Set the parameter given a name and value.
void	setParameter(java.lang.String name, java.lang.String value) Sets the value of the specified parameter.
void	setParameters(NameValueList parameters) Set the parameter list.
void	setQuotedParameter(java.lang.String name, java.lang.String value) Sets the value of the specified parameter.

クラス gov.nist.javax.sip.header.SIPHeader から継承されたメソッド

encode, getHeaderName, getHeaderValue, getName, getValue, isHeaderList, setHeaderName

クラス gov.nist.javax.sip.header.SIPObject から継承されたメソッド

clone, dbgPrint, debugDump, debugDump, equals, match, merge, replace, replace, replace, replace, toString

クラス gov.nist.core.GenericObject から継承されたメソッド

getClassFromName, getMatcher, isMySubclass, setMatcher

クラス java.lang.Object から継承されたメソッド

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

インタフェース javax.sip.header.Header から継承されたメソッド

clone, equals, toString

メソッドの詳細

getParameter

public java.lang.String getParameter(java.lang.String name)

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

定義:

インタフェース javax.sip.header.Parameters 内の getParameter

パラメータ:

name - name of parameter to retrieve

戻り値:

the value of specified parameter

getParameterValue

public java.lang.Object getParameterValue(java.lang.String name)

Return the parameter as an object (dont convert to string).

パラメータ:

name - is the name of the parameter to get.

戻り値:

the object associated with the name.

getParameterNames

public java.util.Iterator getParameterNames()

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

定義:

インタフェース javax.sip.header.Parameters 内の getParameterNames

戻り値:

an Iterator over all the parameter names

hasParameters

public boolean hasParameters()

Return true if you have a parameter and false otherwise.

戻り値:

true if the parameters list is non-empty.

removeParameter

public void removeParameter(java.lang.String name)

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

定義:

インタフェース javax.sip.header.Parameters 内の removeParameter

パラメータ:

name - - a String specifying the parameter name

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String value)
                  throws java.text.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.

定義:

インタフェース javax.sip.header.Parameters 内の setParameter

パラメータ:

name - - a String specifying the parameter name

value - - a String specifying the parameter value

例外:

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

setQuotedParameter

public void setQuotedParameter(java.lang.String name,
                               java.lang.String value)
                        throws java.text.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.

パラメータ:

name - - a String specifying the parameter name

value - - a String specifying the parameter value

例外:

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

hasParameter

public boolean hasParameter(java.lang.String parameterName)

Return true if has a parameter.

パラメータ:

parameterName - is the name of the parameter.

戻り値:

true if the parameter exists and false if not.

removeParameters

public void removeParameters()

Remove all parameters.

getParameters

public NameValueList getParameters()

get the parameter list.

戻り値:

parameter list

setParameter

public void setParameter(NameValue nameValue)

Set the parameter given a name and value.

パラメータ:

nameValue - - the name value of the parameter to set.

setParameters

public void setParameters(NameValueList parameters)

Set the parameter list.

パラメータ:

parameters - The name value list to set as the parameter list.

getNameValue

public NameValue getNameValue(java.lang.String parameterName)

This is for the benifit of the TCK.

戻り値:

the name value pair for the given parameter name.