gov.nist.javax.sip.address
クラス NetObject

java.lang.Object
  gov.nist.core.GenericObject
      gov.nist.javax.sip.address.NetObject

すべての実装されたインタフェース:

java.io.Serializable

直系の既知のサブクラス:

AddressImpl, Authority, GenericURI, TelephoneNumber, UserInfo

public abstract class NetObject
extends GenericObject

Root object for all objects in this package.

バージョン:

JAIN-SIP-1.1 $Revision: 1.2 $ $Date: 2004/01/22 13:26:28 $

作成者:

M. Ranganathan
This code is in the public domain.

関連項目:

直列化された形式

コンストラクタの概要

NetObject()
Default constructor

メソッドの概要

java.lang.Object	clone() For any object in the object (like SIPHeaders) that are cloneable clone the object and add it to the returned List.
java.lang.String	debugDump() An introspection based string formatting method.
java.lang.String	debugDump(int indent) Formatter with a given starting indentation (for nested structs).
abstract java.lang.String	encode() Encode into canonical form.
boolean	equals(java.lang.Object that) An introspection based equality predicate for SIPObjects.
boolean	match(java.lang.Object other) An introspection based predicate matching using a template object.
void	merge(java.lang.Object mergeObject) Recursively override the fields of this object with the fields of a new object.
void	replace(Match regexp, GenericObject replacement) Do a find and replace of objects based on regular expression matching of fields.
void	replace(Match regexp, GenericObjectList replacement) Do a recursive find and replace of objects pointed to by this object based on regular expression pattern matching.
void	replace(java.lang.String objectText, GenericObject replacement, boolean matchSubstring) Do a find and replace of objects
void	replace(java.lang.String objectText, GenericObjectList replacement, boolean matchSubstring) Do a find and replace of objects.
java.lang.String	toString() Encode this to a string.

クラス gov.nist.core.GenericObject から継承されたメソッド

getClassFromName, getMatcher, isMySubclass, setMatcher

クラス java.lang.Object から継承されたメソッド

getClass, hashCode, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

NetObject

public NetObject()

Default constructor

メソッドの詳細

clone

public java.lang.Object clone()

For any object in the object (like SIPHeaders) that are cloneable clone the object and add it to the returned List. Strings and wrappers of basic types are cloned by creating new objects. For other objects, if there is a clone method, then this is invoked and the cloned object appears in the result. Otherwise, this just copies the object reference over. NOTE that this method cannot be moved to the superclass because the superclass is in a different package (and we need to access protected fields from here).

オーバーライド:

クラス GenericObject 内の clone

戻り値:

Object

導入されたバージョン:

1.0

encode

public abstract java.lang.String encode()

Encode into canonical form.

定義:

クラス GenericObject 内の encode

戻り値:

String

equals

public boolean equals(java.lang.Object that)

An introspection based equality predicate for SIPObjects.

オーバーライド:

クラス GenericObject 内の equals

パラメータ:

that - is the other object to test against.

戻り値:

true if the objects are euqal and false otherwise

replace

public void replace(java.lang.String objectText,
                    GenericObject replacement,
                    boolean matchSubstring)
             throws java.lang.IllegalArgumentException

Do a find and replace of objects

オーバーライド:

クラス GenericObject 内の replace

パラメータ:

objectText - is the canonical string representation of the object that we want to replace.

replacement - is the object that we want to replace it with.

matchSubstring - a boolean which tells if we should match a substring of the target object A replacement will occur if a portion of the structure is found with matching encoded text (see the matchSubstring flag) as objectText and with the same class as replacement.

例外:

java.lang.IllegalArgumentException - on null args and if replacementObject does not derive from GenericObject or GenericObjectList

導入されたバージョン:

v1.0

merge

public void merge(java.lang.Object mergeObject)

Recursively override the fields of this object with the fields of a new object. This is useful when you want to genrate a template and override the fields of an incoming SIPMessage with another SIP message that you have already generated.

オーバーライド:

クラス GenericObject 内の merge

パラメータ:

mergeObject - is the replacement object. The override obect must be of the same class as this object. Set any fields that you do not want to override as null in the mergeOject object.

replace

public void replace(java.lang.String objectText,
                    GenericObjectList replacement,
                    boolean matchSubstring)
             throws java.lang.IllegalArgumentException

Do a find and replace of objects.

オーバーライド:

クラス GenericObject 内の replace

パラメータ:

objectText - Canonical string representation of the portion we want to replace.

replacement - object we want to replace this portion with. A replacement will occur if a portion of the structure is found with the matching encoded text as objectText and with the same class as the replacement.

matchSubstring - is true if we want to match the encoded text of a candidate object as a substring of the encoded target text. ( match occurs is objectText is a substring of the encoded text of an object with the same class as replacement.)

例外:

java.lang.IllegalArgumentException - on null args and if replacementObject does not derive from GenericObject or GenericObjectList

導入されたバージョン:

v1.0

match

public boolean match(java.lang.Object other)

An introspection based predicate matching using a template object. Allows for partial match of two protocl Objects.

オーバーライド:

クラス GenericObject 内の match

パラメータ:

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.

戻り値:

true if match succeeds false otherwise.

debugDump

public java.lang.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.

オーバーライド:

クラス GenericObject 内の debugDump

戻り値:

String

replace

public void replace(Match regexp,
                    GenericObjectList replacement)
             throws java.lang.IllegalArgumentException

Do a recursive find and replace of objects pointed to by this object based on regular expression pattern matching.

オーバーライド:

クラス GenericObject 内の replace

パラメータ:

regexp - regular expression for the object we want to find. This is generated using a regular expression matching package such as the apache regexp package.

replacement - object we want to replace this portion with. A replacement will occur if a portion of the structure is found with a match of the encoded text with objectText and with the same class as replacement.

例外:

java.lang.IllegalArgumentException

導入されたバージョン:

v1.0

replace

public void replace(Match regexp,
                    GenericObject replacement)
             throws java.lang.IllegalArgumentException

Do a find and replace of objects based on regular expression matching of fields.

オーバーライド:

クラス GenericObject 内の replace

パラメータ:

regexp - is the match expression (i.e. implementation of the Match interface) for the object that we want to replace.

replacement - is the object that we want to replace it with. A replacement will occur if a portion of the structure is found that matches according to the given regexp and if the class of the replaced field matches the replacement.

例外:

java.lang.IllegalArgumentException

debugDump

public java.lang.String debugDump(int indent)

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

オーバーライド:

クラス GenericObject 内の debugDump

パラメータ:

indent - int to set

戻り値:

String

toString

public java.lang.String toString()

Encode this to a string.

オーバーライド:

クラス java.lang.Object 内の toString

戻り値:

string representation for this object.