gov.nist.javax.sip.header

Class SIPObject

java.lang.Object

gov.nist.core.GenericObject

gov.nist.javax.sip.header.SIPObject

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

CallIdentifier, Challenge, Credentials, MediaRange, Protocol, RequestLine, SIPHeader, StatusLine

public abstract class SIPObject
extends GenericObject

Root class for all singleton objects in this package: specializes the gov.nist.sip.header.GenericObject class for SIPHeader related objects.

Version:

1.2 $Revision: 1.11 $ $Date: 2010-05-06 14:07:48 $

Author:

M. Ranganathan

See Also:

Serialized Form

Field Summary

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SIPObject() default Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	dbgPrint() Debug function
String	debugDump() An introspection based string formatting method.
String	debugDump(int indent) Formatter with a given starting indentation (for nested structs).
abstract String	encode() Encode the header into a String.
StringBuilder	encode(StringBuilder buffer) Encode the header into the given StringBuilder.
boolean	equals(Object other) An introspection based equality predicate for SIPObjects.
boolean	match(Object other) An introspection based predicate matching using a template object.
String	toString()

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, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SIPObject

protected SIPObject()

default Constructor

Method Detail

dbgPrint

public void dbgPrint()

Debug function

Overrides:

dbgPrint in class GenericObject

encode

public abstract String encode()

Encode the header into a String.

Specified by:

encode in class GenericObject

Returns:

String

encode

public StringBuilder encode(StringBuilder buffer)

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

Overrides:

encode in class GenericObject

equals

public boolean equals(Object other)

An introspection based equality predicate for SIPObjects.

Overrides:

equals in class GenericObject

Parameters:

other - the other object to test against.

Returns:

true if the objects are euqal and false otherwise

match

public boolean match(Object other)

An introspection based predicate matching using a template object. Allows for partial match of two protocl Objects. You can set a generalized matcher (using regular expressions for example) by implementing the Match interface and registering it with the template.

Overrides:

match in class GenericObject

Parameters:

other - the match pattern to test against. The match object has to be of the same type (class). Primitive types and non-sip fields that are non null are matched for equality. Null in any field matches anything. Some book-keeping fields are ignored when making the comparison.

debugDump

public String debugDump()

An introspection based string formatting method. We need this because in this package (although it is an exact duplicate of the one in the superclass) because it needs to access the protected members of the other objects in this class.

Overrides:

debugDump in class GenericObject

Returns:

String

debugDump

public String debugDump(int indent)

Formatter with a given starting indentation (for nested structs).

Overrides:

debugDump in class GenericObject

Parameters:

indent - int to set

Returns:

String

toString

public String toString()

Overrides:

toString in class Object