javax.sip.header

Interface OptionTag

All Known Subinterfaces:

ProxyRequireHeader, RequireHeader, SupportedHeader, UnsupportedHeader

All Known Implementing Classes:

ProxyRequire, Require, Supported, Unsupported

public interface OptionTag

This interface represents methods for manipulating OptionTags values for any header that contains an OptionTag value. Option tags are unique identifiers used to designate new options (extensions) in SIP. Note that these options appear as parameters in those header fields in an option-tag = token form. Option tags are defined in standards track RFCs. This is a change from past practice, and is instituted to ensure continuing multi-vendor interoperability.

Version:

1.2

Author:

BEA Systems, NIST

See Also:

ProxyRequireHeader, RequireHeader, UnsupportedHeader, SupportedHeader

Method Summary

Methods

Modifier and Type	Method and Description
String	getOptionTag() Gets the option tag of this OptionTag class.
void	setOptionTag(String optionTag) Sets the option tag value to the new supplied optionTag parameter.

Method Detail

setOptionTag

void setOptionTag(String optionTag)
                  throws ParseException

Sets the option tag value to the new supplied optionTag parameter.

Parameters:

optionTag - - the new string value of the option tag.

Throws:

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

getOptionTag

String getOptionTag()

Gets the option tag of this OptionTag class.

Returns:

the string that identifies the option tag value.