|
NIST SIP Parser and Stack (v1.2) API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
Parameters header. Suitable for extension by headers that have parameters.
Field Summary |
Fields inherited from interface 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 |
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. |
NameValueList |
getParameters()
get the parameter list. |
Object |
getParameterValue(String name)
Return the parameter as an object (dont convert to string). |
boolean |
hasParameter(String parameterName)
Return true if has a parameter. |
boolean |
hasParameters()
Return true if you have a parameter and false otherwise. |
void |
removeParameter(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(String name,
String value)
Sets the value of the specified parameter. |
void |
setParameters(NameValueList parameters)
Set the parameter list. |
void |
setQuotedParameter(String name,
String value)
Sets the value of the specified parameter. |
Methods inherited from class gov.nist.javax.sip.header.SIPHeader |
encode, getHeaderName, getHeaderValue, getName, getValue, isHeaderList, setHeaderName |
Methods inherited from class gov.nist.javax.sip.header.SIPObject |
clone, dbgPrint, debugDump, debugDump, equals, match, merge, replace, replace, replace, replace, toString |
Methods inherited from class gov.nist.core.GenericObject |
getClassFromName, getMatcher, isMySubclass, setMatcher |
Methods inherited from class java.lang.Object |
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface javax.sip.header.Header |
clone, equals, toString |
Method Detail |
public String getParameter(String name)
getParameter
in interface Parameters
public Object getParameterValue(String name)
name
- is the name of the parameter to get.
public Iterator getParameterNames()
getParameterNames
in interface Parameters
public boolean hasParameters()
public void removeParameter(String name)
removeParameter
in interface Parameters
name
- - a String specifying the parameter namepublic void setParameter(String name, String value) throws ParseException
setParameter
in interface Parameters
name
- - a String specifying the parameter namevalue
- - a String specifying the parameter value
ParseException
- which signals that an error has been reached
unexpectedly while parsing the parameter name or value.public void setQuotedParameter(String name, String value) throws ParseException
name
- - a String specifying the parameter namevalue
- - a String specifying the parameter value
ParseException
- which signals that an error has been reached
unexpectedly while parsing the parameter name or value.public boolean hasParameter(String parameterName)
public void removeParameters()
public NameValueList getParameters()
public void setParameter(NameValue nameValue)
nameValue
- - the name value of the parameter to set.public void setParameters(NameValueList parameters)
|
NIST SIP Parser and Stack (v1.2) API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |