NIST SIP Parser and Stack (v1.2) API

gov.nist.javax.sip.header
Class MaxForwards

java.lang.Object
  |
  +--gov.nist.core.GenericObject
        |
        +--gov.nist.javax.sip.header.SIPObject
              |
              +--gov.nist.javax.sip.header.SIPHeader
                    |
                    +--gov.nist.javax.sip.header.MaxForwards
All Implemented Interfaces:
Cloneable, Header, MaxForwardsHeader, Serializable, SIPHeaderNames

public class MaxForwards
extends SIPHeader
implements MaxForwardsHeader

MaxForwards SIPHeader

Version:
JAIN-SIP-1.1
Author:
M. Ranganathan
, Olivier Deruelle
This code is in the public domain.
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface javax.sip.header.MaxForwardsHeader
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, MAX_FORWARDS, MIME_VERSION, MIN_EXPIRES, ORGANIZATION, PRIORITY, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, PROXY_REQUIRE, RACK, REASON, RECORD_ROUTE, REPLY_TO, REQUIRE, RETRY_AFTER, ROUTE, RSEQ, SERVER, SUBJECT, SUBSCRIPTION_STATE, SUPPORTED, TIMESTAMP, TO, UNSUPPORTED, USER_AGENT, VIA, WARNING, WWW_AUTHENTICATE
 
Constructor Summary
MaxForwards()
          Default constructor.
 
Method Summary
 void decrementMaxForwards()
          decrement MaxForwards field one by one.
 String encodeBody()
          Encode into a string.
 int getMaxForwards()
          get the MaxForwards field.
 boolean hasReachedZero()
          Boolean function
 void setMaxForwards(int maxForwards)
          Set the maxForwards member
 
Methods inherited from class gov.nist.javax.sip.header.SIPHeader
encode, getHeaderName, getHeaderValue, getName, getValue, isHeaderList, setHeaderName
 
Methods inherited from class gov.nist.javax.sip.header.SIPObject
clone, dbgPrint, debugDump, debugDump, equals, match, merge, replace, replace, replace, replace, toString
 
Methods inherited from class gov.nist.core.GenericObject
getClassFromName, getMatcher, isMySubclass, setMatcher
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.sip.header.Header
clone, equals, getName, toString
 

Constructor Detail

MaxForwards

public MaxForwards()
Default constructor.

Method Detail

getMaxForwards

public int getMaxForwards()
get the MaxForwards field.

Specified by:
getMaxForwards in interface MaxForwardsHeader
Returns:
the maxForwards member.

setMaxForwards

public void setMaxForwards(int maxForwards)
                    throws InvalidArgumentException
Set the maxForwards member

Specified by:
setMaxForwards in interface MaxForwardsHeader
Parameters:
maxForwards - maxForwards parameter to set
Throws:
InvalidArgumentException - if the maxForwards argument is less than 0 or greater than 255.

encodeBody

public String encodeBody()
Encode into a string.

Overrides:
encodeBody in class SIPHeader
Returns:
encoded string.

hasReachedZero

public boolean hasReachedZero()
Boolean function

Returns:
true if MaxForwards field reached zero.

decrementMaxForwards

public void decrementMaxForwards()
decrement MaxForwards field one by one.

Specified by:
decrementMaxForwards in interface MaxForwardsHeader

NIST SIP Parser and Stack (v1.2) API

A product of the NIST/ITL Advanced Networking Technologies Division.
See conditions of use.
Get the latest distribution.
Submit a bug report or feature request.