|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.adt.topology.object.properties.PropertyObject
com.ibm.adt.topology.object.properties.PropertyArray
public class PropertyArray
PropertyArray is a component of the TopologyObject Properties heirachy. It is used to create a complex property definition that may contain either PropertyList or non-specified Object objects. Objects that are not a PropertyList are automatically wrapped in a PropertyValue object to maintain property hierarchy and navigability. Note that a PropertyArray may only store like objects, and may not store other Property or PropertyArray objects. For storing Property objects, use PropertyList instead. PropertyArray may only be stored as a Property value.
PropertyList
,
Property
,
PropertyValue
,
Serialized FormField Summary |
---|
Fields inherited from class com.ibm.adt.topology.object.properties.PropertyObject |
---|
hashCode, name |
Constructor Summary | |
---|---|
PropertyArray()
Creates a new PropertyArray instance. |
Method Summary | |
---|---|
void |
add(java.lang.Object object)
Stores an object in the PropertyArray. |
void |
copyAll(PropertyArray array)
Copies a collection of Property(s) to this PropertyList. |
boolean |
equals(java.lang.Object obj)
|
(package private) void |
finalizeProperty()
Finalizes the PropertyObject structure. |
(package private) PropertyList |
findProperties(java.lang.String searchText,
boolean isCaseSensitive,
boolean isCollectionName,
boolean isPropertyName,
boolean isPropertyValue)
Search the PropertyArray for occurrences of properties that match the specified criteria. |
PropertyObject |
get(int index)
Returns the element in the PropertyArray corresponding to the specified index. |
java.util.Collection |
getAsCollection()
Returns the PropertyArray as an Collection. |
PropertyObject |
getPropertyValue(java.lang.String key)
Used to retrieve a nested property value according to the specified xpath-style key. |
java.lang.String |
getStoredObjectClass()
Returns the class name of the contained elements. |
int |
hashCode()
|
int |
indexOf(PropertyObject object)
Returns the index of the given PropertyObject within the array. |
boolean |
isEmpty()
Test whether the PropertyArray is empty. |
java.util.Iterator |
iterator()
Return an Iterator for the PropertyArray. |
java.lang.String |
peek()
Returns string that peeks the property value. |
int |
size()
Returns the number of objects stored in the PropertyArray. |
java.lang.String |
toString()
|
Methods inherited from class com.ibm.adt.topology.object.properties.PropertyObject |
---|
getKey, getName, getOrdinal, getParent, getRoot, setParent, setRoot |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public PropertyArray()
Method Detail |
---|
public final PropertyObject getPropertyValue(java.lang.String key) throws TopologyException
key
- specifies the key of the Property whose value is to be
retrieved
TopologyException
public final PropertyObject get(int index)
index
-
public final java.util.Iterator iterator()
public final int size()
public final java.util.Collection getAsCollection()
public final void add(java.lang.Object object) throws TopologyException
object
- the object to store
TopologyException
public final java.lang.String getStoredObjectClass()
public final boolean isEmpty()
public final void copyAll(PropertyArray array) throws TopologyException
properties
-
TopologyException
public final int indexOf(PropertyObject object)
object
-
public final java.lang.String peek()
PropertyObject
peek
in class PropertyObject
public final java.lang.String toString()
toString
in class java.lang.Object
public final boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public final int hashCode()
hashCode
in class java.lang.Object
final PropertyList findProperties(java.lang.String searchText, boolean isCaseSensitive, boolean isCollectionName, boolean isPropertyName, boolean isPropertyValue) throws TopologyException
searchText
- -
a regular expression string to match againstisCaseInsensitive
- -
make search case insensitiveisCollectionName
- -
return property collection if property name matches a
collection property.isPropertyName
- -
search property namesisPropertyValue
- -
search property values
TopologyException
final void finalizeProperty()
PropertyObject
finalizeProperty
in class PropertyObject
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |