gov.nist.javax.sip.header

Class SIPHeader

java.lang.Object

gov.nist.core.GenericObject

gov.nist.javax.sip.header.SIPObject

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.9 $ $Date: 2010-05-06 14:07:52 $

Author:

M. Ranganathan

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	headerName name of this header

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

Modifier	Constructor and Description
	SIPHeader() Default constructor
protected	SIPHeader(String hname) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
String	encode() Encode this header into canonical form.
StringBuilder	encode(StringBuilder buffer) Encode the header into the given StringBuilder.
protected abstract StringBuilder	encodeBody(StringBuilder buffer) Encode the body of this header (the stuff that follows headerName).
String	getHeaderName() Name of the SIPHeader
String	getHeaderValue() Get the header value (i.e.
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, 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.Header

clone, equals

Field Detail

headerName

protected String headerName

name of this header

Constructor Detail

SIPHeader

protected SIPHeader(String hname)

Constructor

Parameters:

hname - String to set

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 StringBuilder encode(StringBuilder buffer)

Description copied from class: SIPObject

Encode the header into the given StringBuilder. Default implemation calls encode().

Overrides:

encode in class SIPObject

encodeBody

protected abstract StringBuilder encodeBody(StringBuilder buffer)

Encode the body of this header (the stuff that follows headerName). A.K.A headerValue.

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