gov.nist.javax.sdp.fields
クラス SDPObject

java.lang.Object
  上位を拡張 gov.nist.core.GenericObject
      上位を拡張 gov.nist.javax.sdp.fields.SDPObject
すべての実装されたインタフェース:
SDPFieldNames, java.io.Serializable
直系の既知のサブクラス:
ConnectionAddress, Email, EmailAddress, SDPField, SDPFormat, TypedTime, ZoneAdjustment

public abstract class SDPObject
extends GenericObject
implements SDPFieldNames

Root class for everything in this package.

関連項目:
直列化された形式

フィールドの概要
 
インタフェース gov.nist.javax.sdp.fields.SDPFieldNames から継承されたフィールド
ATTRIBUTE_FIELD, BANDWIDTH_FIELD, CONNECTION_FIELD, EMAIL_FIELD, INFORMATION_FIELD, KEY_FIELD, MEDIA_FIELD, ORIGIN_FIELD, PHONE_FIELD, PROTO_VERSION_FIELD, REPEAT_FIELD, SESSION_NAME_FIELD, TIME_FIELD, URI_FIELD, ZONE_FIELD
 
コンストラクタの概要
SDPObject()
           
 
メソッドの概要
 java.lang.Object clone()
          clone this SDP object.
 java.lang.String dbgPrint(int indent)
          Formatter with a given starting indentation.
 java.lang.String debugDump()
          Generic introspection based printing funciton for this package.
abstract  java.lang.String encode()
          Get the string encoded version of this object
 boolean equals(java.lang.Object that)
          An introspection based equality predicate for SDPObjects.
 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()
           
 
クラス gov.nist.core.GenericObject から継承されたメソッド
debugDump, getClassFromName, getMatcher, isMySubclass, setMatcher
 
クラス java.lang.Object から継承されたメソッド
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

コンストラクタの詳細

SDPObject

public SDPObject()
メソッドの詳細

encode

public abstract java.lang.String encode()
クラス GenericObject の記述:
Get the string encoded version of this object

定義:
クラス GenericObject 内の encode

toString

public java.lang.String toString()
オーバーライド:
クラス java.lang.Object 内の toString

clone

public java.lang.Object clone()
clone this SDP object. 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
導入されたバージョン:
1.0

equals

public boolean equals(java.lang.Object that)
An introspection based equality predicate for SDPObjects.

オーバーライド:
クラス GenericObject 内の equals
パラメータ:
other - is the other object to test against.
戻り値:
true if the objects are equal.

debugDump

public java.lang.String debugDump()
Generic introspection based printing funciton for this package. Because we use introspection, this must reside in this package and we cannot use the superclass defintion (even though it is virtually identical.

オーバーライド:
クラス GenericObject 内の debugDump

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.

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.

dbgPrint

public java.lang.String dbgPrint(int indent)
Formatter with a given starting indentation.


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 the same encoded text as objectText and with the same class as replacement.
例外:
java.lang.IllegalArgumentException
導入されたバージョン:
v1.0

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
導入されたバージョン:
v1.0

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