gov.nist.javax.sip.header

Class Expires

java.lang.Object

gov.nist.core.GenericObject

gov.nist.javax.sip.header.SIPObject

gov.nist.javax.sip.header.SIPHeader

gov.nist.javax.sip.header.Expires

All Implemented Interfaces:

HeaderExt, SIPHeaderNames, Serializable, Cloneable, ExpiresHeader, Header

public class Expires
extends SIPHeader
implements ExpiresHeader

Expires SIP Header.

Since:

1.1

Version:

1.2 $Revision: 1.7 $ $Date: 2010-05-06 14:07:46 $

Author:

M. Ranganathan

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	expires expires 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.ExpiresHeader

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
Expires() default constructor

Method Summary

Methods

Modifier and Type	Method and Description
String	encodeBody() Return canonical form.
protected StringBuilder	encodeBody(StringBuilder buffer) Encode the body of this header (the stuff that follows headerName).
int	getExpires() Gets the expires value of the ExpiresHeader.
void	setExpires(int expires) Sets the relative expires value of the ExpiresHeader.

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

expires

protected int expires

expires field

Constructor Detail

Expires

public Expires()

default constructor

Method Detail

encodeBody

public String encodeBody()

Return canonical form.

Returns:

String

encodeBody

protected 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 SIPHeader

getExpires

public int getExpires()

Gets the expires value of the ExpiresHeader. This expires value is relative time.

Specified by:

getExpires in interface ExpiresHeader

Returns:

the expires value of the ExpiresHeader.

setExpires

public void setExpires(int expires)
                throws InvalidArgumentException

Sets the relative expires value of the ExpiresHeader. The expires value MUST be greater than zero and MUST be less than 2**31.

Specified by:

setExpires in interface ExpiresHeader

Parameters:

expires - - the new expires value of this ExpiresHeader

Throws:

InvalidArgumentException - if supplied value is less than zero.