gov.nist.javax.sip.header.extensions

Class References

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

gov.nist.javax.sip.header.extensions.References

All Implemented Interfaces:

ReferencesHeader, HeaderExt, ParametersExt, SIPHeaderNames, Serializable, Cloneable, ExtensionHeader, Header, Parameters

public class References
extends ParametersHeader
implements ReferencesHeader, ExtensionHeader

See Also:

Serialized Form

Field Summary

Fields inherited from class gov.nist.javax.sip.header.ParametersHeader

duplicates, parameters

Fields inherited from class gov.nist.javax.sip.header.SIPHeader

headerName

Fields inherited from class gov.nist.core.GenericObject

AND, AT, COLON, COMMA, DOT, DOUBLE_QUOTE, EQUALS, GREATER_THAN, HT, immutableClasses, indentation, LESS_THAN, LPAREN, matchExpression, NEWLINE, PERCENT, POUND, QUESTION, QUOTE, RETURN, RPAREN, SEMICOLON, SLASH, SP, STAR, stringRepresentation

Fields inherited from interface gov.nist.javax.sip.header.extensions.ReferencesHeader

CHAIN, INQUIRY, NAME, REFER, REL, SEQUEL, SERVICE, XFER

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, JOIN, MAX_FORWARDS, MIME_VERSION, MIN_EXPIRES, MIN_SE, ORGANIZATION, PRIORITY, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, PROXY_REQUIRE, RACK, REASON, RECORD_ROUTE, REFERRED_BY, REPLACES, REPLY_TO, REQUIRE, RETRY_AFTER, ROUTE, RSEQ, SERVER, SESSION_EXPIRES, SIP_ETAG, SIP_IF_MATCH, SUBJECT, SUBSCRIPTION_STATE, SUPPORTED, TIMESTAMP, TO, UNSUPPORTED, USER_AGENT, VIA, WARNING, WWW_AUTHENTICATE

Constructor Summary

Constructors

Constructor and Description
References()

Method Summary

Methods

Modifier and Type	Method and Description
StringBuilder	encodeBody(StringBuilder buffer) Encode the body of this header (the stuff that follows headerName).
String	getCallId()
String	getName() Alias for getHaderName above.
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.
String	getRel()
void	removeParameter(String name) Removes the specified parameter from Parameters of this ParametersHeader.
void	setCallId(String callId)
void	setParameter(String name, String value) Sets the value of the specified parameter.
void	setRel(String rel)
void	setValue(String value) Sets the value parameter of the ExtensionHeader.

Methods inherited from class gov.nist.javax.sip.header.ParametersHeader

clone, equalParameters, getMultiParameter, getMultiParameterNames, getMultiParameters, getMultiParameterValue, getNameValue, getParameter, getParameterAsBoolean, getParameterAsFloat, getParameterAsHexInt, getParameterAsInt, getParameterAsLong, getParameterAsURI, getParameters, getParameterValue, hasMultiParameter, hasMultiParameters, hasParameter, hasParameters, removeMultiParameter, removeMultiParameters, removeParameters, setMultiParameter, setMultiParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameters, setQuotedParameter

Methods inherited from class gov.nist.javax.sip.header.SIPHeader

encode, encode, getHeaderName, getHeaderValue, getValue, hashCode, isHeaderList, setHeaderName, toString

Methods inherited from class gov.nist.javax.sip.header.SIPObject

dbgPrint, debugDump, debugDump, equals, match

Methods inherited from class gov.nist.core.GenericObject

dbgPrint, getClassFromName, getIndentation, getMatcher, isMySubclass, makeClone, merge, setMatcher, sprint, sprint, sprint, sprint, sprint, sprint, sprint, sprint, sprint

Methods inherited from class java.lang.Object

equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.sip.header.ExtensionHeader

getValue

Methods inherited from interface javax.sip.header.Header

clone, equals, hashCode, toString

Constructor Detail

References

public References()

Method Detail

getCallId

public String getCallId()

Specified by:

getCallId in interface ReferencesHeader

getRel

public String getRel()

Specified by:

getRel in interface ReferencesHeader

setCallId

public void setCallId(String callId)

Specified by:

setCallId in interface ReferencesHeader

setRel

public void setRel(String rel)
            throws ParseException

Specified by:

setRel in interface ReferencesHeader

Throws:

ParseException

getParameter

public String getParameter(String name)

Description copied from interface: Parameters

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

Specified by:

getParameter in interface Parameters

Overrides:

getParameter in class ParametersHeader

Parameters:

name - name of parameter to retrieve

Returns:

the value of specified parameter

getParameterNames

public Iterator getParameterNames()

Description copied from class: ParametersHeader

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

Specified by:

getParameterNames in interface Parameters

Overrides:

getParameterNames in class ParametersHeader

Returns:

an Iterator over all the parameter names

removeParameter

public void removeParameter(String name)

Description copied from class: ParametersHeader

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

Specified by:

removeParameter in interface Parameters

Overrides:

removeParameter in class ParametersHeader

Parameters:

name - - a String specifying the parameter name

setParameter

public void setParameter(String name,
                String value)
                  throws ParseException

Description copied from class: ParametersHeader

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.

Specified by:

setParameter in interface Parameters

Overrides:

setParameter in class ParametersHeader

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.

getName

public String getName()

Description copied from class: SIPHeader

Alias for getHaderName above.

Specified by:

getName in interface Header

Overrides:

getName in class SIPHeader

Returns:

String headerName

encodeBody

public StringBuilder encodeBody(StringBuilder buffer)

Description copied from class: SIPHeader

Encode the body of this header (the stuff that follows headerName). A.K.A headerValue.

Specified by:

encodeBody in class ParametersHeader

setValue

public void setValue(String value)
              throws ParseException

Description copied from interface: ExtensionHeader

Sets the value parameter of the ExtensionHeader.

Specified by:

setValue in interface ExtensionHeader

Parameters:

value - - the new value of the ExtensionHeader

Throws:

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