gov.nist.javax.sip.header

Class SIPIfMatch

java.lang.Object

gov.nist.core.GenericObject

gov.nist.javax.sip.header.SIPObject

gov.nist.javax.sip.header.SIPHeader

gov.nist.javax.sip.header.SIPIfMatch

All Implemented Interfaces:

HeaderExt, SIPHeaderNames, Serializable, Cloneable, ExtensionHeader, Header, SIPIfMatchHeader

public class SIPIfMatch
extends SIPHeader
implements SIPIfMatchHeader, ExtensionHeader

the SIP-If-Match header.

Since:

1.2

Version:

1.2 $Revision: 1.4 $ $Date: 2010-05-06 14:07:50 $

Author:

Jeroen van Bemmel

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	entityTag entity tag 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.SIPIfMatchHeader

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
SIPIfMatch() Default constructor
SIPIfMatch(String etag)

Method Summary

Methods

Modifier and Type	Method and Description
StringBuilder	encodeBody(StringBuilder retval) Encode into canonical form.
String	getETag() get the priority value.
void	setETag(String etag) Set the priority member
void	setValue(String value) For v 1.1 backwards compatibility.

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

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, getName, hashCode, toString

Field Detail

entityTag

protected String entityTag

entity tag field

Constructor Detail

SIPIfMatch

public SIPIfMatch()

Default constructor

SIPIfMatch

public SIPIfMatch(String etag)
           throws ParseException

Throws:

ParseException

Method Detail

encodeBody

public StringBuilder encodeBody(StringBuilder retval)

Encode into canonical form.

Specified by:

encodeBody in class SIPHeader

Returns:

String

getETag

public String getETag()

get the priority value.

Specified by:

getETag in interface SIPIfMatchHeader

Returns:

String

setETag

public void setETag(String etag)
             throws ParseException

Set the priority member

Specified by:

setETag in interface SIPIfMatchHeader

Parameters:

etag - -- the entity tag to set.

Throws:

ParseException - if the ETag syntax is invalid (not a valid token)

setValue

public void setValue(String value)
              throws ParseException

For v 1.1 backwards compatibility.

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.

See Also:

ExtensionHeader.setValue(java.lang.String)