NIST SIP Parser and Stack (v1.2) API

gov.nist.javax.sip.header
Class Route

java.lang.Object
  |
  +--gov.nist.core.GenericObject
        |
        +--gov.nist.javax.sip.header.SIPObject
              |
              +--gov.nist.javax.sip.header.SIPHeader
                    |
                    +--gov.nist.javax.sip.header.ParametersHeader
                          |
                          +--gov.nist.javax.sip.header.AddressParametersHeader
                                |
                                +--gov.nist.javax.sip.header.Route
All Implemented Interfaces:
Cloneable, Header, HeaderAddress, Parameters, RouteHeader, Serializable, SIPHeaderNames

public class Route
extends AddressParametersHeader
implements RouteHeader

Route SIPHeader Object

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

Field Summary
 
Fields inherited from interface javax.sip.header.RouteHeader
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
Route()
          Default constructor
Route(AddressImpl address)
          Default constructor given an address.
 
Method Summary
 String encodeBody()
          Encode into canonical form.
 boolean equals(Object that)
          Equality predicate.
 int hashCode()
          Hashcode so this header can be inserted into a set.
 
Methods inherited from class gov.nist.javax.sip.header.AddressParametersHeader
getAddress, setAddress
 
Methods inherited from class gov.nist.javax.sip.header.ParametersHeader
getParameter, getParameterNames, getParameters, getParameterValue, hasParameter, hasParameters, removeParameter, removeParameters, setParameter, setParameter, setParameters, setQuotedParameter
 
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, 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, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.sip.header.HeaderAddress
getAddress, setAddress
 
Methods inherited from interface javax.sip.header.Parameters
getParameter, getParameterNames, removeParameter, setParameter
 
Methods inherited from interface javax.sip.header.Header
clone, getName, toString
 

Constructor Detail

Route

public Route()
Default constructor


Route

public Route(AddressImpl address)
Default constructor given an address.

Parameters:
address - -- address of this header.
Method Detail

equals

public boolean equals(Object that)
Equality predicate. Two routes are equal if their addresses are equal.

Specified by:
equals in interface Header
Overrides:
equals in class SIPObject
Parameters:
that - is the other object to compare with.
Returns:
true if the route addresses are equal.

hashCode

public int hashCode()
Hashcode so this header can be inserted into a set.

Overrides:
hashCode in class Object
Returns:
the hashcode of the encoded address.

encodeBody

public String encodeBody()
Encode into canonical form. Acknowledgement: contains a bug fix for a bug reported by Laurent Schwizer

Overrides:
encodeBody in class ParametersHeader
Returns:
a canonical encoding of the header.

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.