NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

gov.nist.javax.sip.header
Class SIPHeader

java.lang.Object
  extended by gov.nist.core.GenericObject
      extended by gov.nist.javax.sip.header.SIPObject
          extended by gov.nist.javax.sip.header.SIPHeader
All Implemented Interfaces:
HeaderExt, SIPHeaderNames, Serializable, Cloneable, Header
Direct Known Subclasses:
AddressHeaderIms, Allow, AllowEvents, CallID, ContentEncoding, ContentLanguage, ContentLength, CSeq, Expires, ExtensionHeaderImpl, InReplyTo, MaxForwards, MimeVersion, MinExpires, Organization, ParametersHeader, PAssertedService, PMediaAuthorization, PPreferredService, Priority, Privacy, ProxyRequire, RAck, Require, RSeq, Server, SIPDateHeader, SIPETag, SIPHeaderList, SIPIfMatch, Subject, Supported, TimeStamp, Unsupported, UserAgent, Warning

public abstract class SIPHeader
extends SIPObject
implements SIPHeaderNames, Header, HeaderExt

Root class from which all SIPHeader objects are subclassed.

Version:
1.2 $Revision: 1.7 $ $Date: 2009/07/17 18:57:37 $
Author:
M. Ranganathan
See Also:
Serialized Form

Field Summary
 
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
SIPHeader()
          Default constructor
 
Method Summary
 String encode()
          Encode this header into canonical form.
 StringBuffer encode(StringBuffer buffer)
          Encode the header into the given StringBuffer.
 String getHeaderName()
          Name of the SIPHeader
 String getHeaderValue()
          Get the header value (i.e. what follows the name:).
 String getName()
          Alias for getHaderName above.
 String getValue()
          Alias for getHeaderValue.
 int hashCode()
          This is a pretty simple hashCode but satisfies requirements.
 boolean isHeaderList()
          Return false if this is not a header list (SIPHeaderList overrrides this method).
 void setHeaderName(String hdrname)
          Set the name of the header .
 String toString()
          Gets a string representation of the Header.
 
Methods inherited from class gov.nist.javax.sip.header.SIPObject
dbgPrint, debugDump, debugDump, equals, match
 
Methods inherited from class gov.nist.core.GenericObject
clone, getClassFromName, getMatcher, isMySubclass, makeClone, merge, setMatcher
 
Methods inherited from class java.lang.Object
equals, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.sip.header.Header
clone, equals
 

Constructor Detail

SIPHeader

public SIPHeader()
Default constructor

Method Detail

getHeaderName

public String getHeaderName()
Name of the SIPHeader

Returns:
String

getName

public String getName()
Alias for getHaderName above.

Specified by:
getName in interface Header
Returns:
String headerName

setHeaderName

public void setHeaderName(String hdrname)
Set the name of the header .

Parameters:
hdrname - String to set

getHeaderValue

public String getHeaderValue()
Get the header value (i.e. what follows the name:). This merely goes through and lops off the portion that follows the headerName:


isHeaderList

public boolean isHeaderList()
Return false if this is not a header list (SIPHeaderList overrrides this method).

Returns:
false

encode

public String encode()
Encode this header into canonical form.

Specified by:
encode in class SIPObject
Returns:
String

encode

public StringBuffer encode(StringBuffer buffer)
Description copied from class: SIPObject
Encode the header into the given StringBuffer. Default implemation calls encode().

Overrides:
encode in class SIPObject

getValue

public String getValue()
Alias for getHeaderValue.

Specified by:
getValue in interface HeaderExt
Returns:
the header value (i.e. what follows the name:)

hashCode

public int hashCode()
This is a pretty simple hashCode but satisfies requirements.

Specified by:
hashCode in interface Header
Overrides:
hashCode in class Object
Returns:
integer representation of Header hashcode

toString

public final String toString()
Description copied from interface: Header
Gets a string representation of the Header. This method overrides the toString method in java.lang.Object.

Specified by:
toString in interface Header
Overrides:
toString in class SIPObject
Returns:
string representation of Header

NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

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