gov.nist.javax.sip.header

Class Require

java.lang.Object

gov.nist.core.GenericObject

gov.nist.javax.sip.header.SIPObject

gov.nist.javax.sip.header.SIPHeader

gov.nist.javax.sip.header.Require

All Implemented Interfaces:

HeaderExt, SIPHeaderNames, Serializable, Cloneable, Header, OptionTag, RequireHeader

public class Require
extends SIPHeader
implements RequireHeader

Require SIP Header.

Version:

1.2 $Revision: 1.6 $ $Date: 2010-05-06 14:07:48 $

Author:

M. Ranganathan
, Olivier Deruelle

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	optionTag optionTag field

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 javax.sip.header.RequireHeader

NAME

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
Require() Default constructor
Require(String s) constructor

Method Summary

Methods

Modifier and Type	Method and Description
StringBuilder	encodeBody(StringBuilder retval) Encode in canonical form.
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.

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

encode, encode, getHeaderName, getHeaderValue, getName, 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

clone, 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.Header

clone, equals, getName, hashCode, toString

Field Detail

optionTag

protected String optionTag

optionTag field

Constructor Detail

Require

public Require()

Default constructor

Require

public Require(String s)

constructor

Parameters:

s - String to set

Method Detail

encodeBody

public StringBuilder encodeBody(StringBuilder retval)

Encode in canonical form.

Specified by:

encodeBody in class SIPHeader

Returns:

String

setOptionTag

public void setOptionTag(String optionTag)
                  throws ParseException

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

Specified by:

setOptionTag in interface OptionTag

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

public String getOptionTag()

Gets the option tag of this OptionTag class.

Specified by:

getOptionTag in interface OptionTag

Returns:

the string that identifies the option tag value.