com.ibm.adt.topology.object.properties
Class PropertyObject

java.lang.Object
  extended by com.ibm.adt.topology.object.properties.PropertyObject
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
Property, PropertyArray, PropertyList, PropertyValue

public abstract class PropertyObject
extends java.lang.Object
implements java.io.Serializable

The superclass for all objects in the com.ibm.adt.topology.object.properties package. It provides the implementation for the common set of required getter methods, and provides the interface for PropertyObject sub-classes.

See Also:
Property, PropertyValue, PropertyList, PropertyArray, Serialized Form

Field Summary
(package private)  int hashCode
           
(package private)  java.lang.String name
           
 
Constructor Summary
PropertyObject()
          Builds a base PropertyObject.
 
Method Summary
(package private) abstract  void finalizeProperty()
          Finalizes the PropertyObject structure.
 java.lang.String getKey()
          Gets the key for the given PropertyObject that corresponds to where the PropertyObject resides in the property heirarchy.
 java.lang.String getName()
          Gets the name of the PropertyObject.
 int getOrdinal()
          Gets the Property ordinal relative to the property tree it is contained within.
 java.lang.Object getParent()
          Gets the PropertyObject's immediate parent.
 TopologyObject getRoot()
          Gets the TopologyObject instance that this PropertyObject belongs to.
abstract  java.lang.String peek()
          Returns string that peeks the property value.
(package private)  void setParent(java.lang.Object parent)
           
(package private)  void setRoot(TopologyObject root)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

java.lang.String name

hashCode

int hashCode
Constructor Detail

PropertyObject

PropertyObject()
Builds a base PropertyObject.

Method Detail

getKey

public final java.lang.String getKey()
Gets the key for the given PropertyObject that corresponds to where the PropertyObject resides in the property heirarchy.

Returns:
the key

getName

public final java.lang.String getName()
Gets the name of the PropertyObject.

Returns:
the property name.

getRoot

public final TopologyObject getRoot()
Gets the TopologyObject instance that this PropertyObject belongs to.

Returns:
the TopologyObject

getParent

public final java.lang.Object getParent()
Gets the PropertyObject's immediate parent. If the PropertyObject is the root PropertyList, the owning TopologyObject will be returned.

Returns:
Returns the parent.

getOrdinal

public final int getOrdinal()
Gets the Property ordinal relative to the property tree it is contained within.

Returns:
the ordinal

peek

public abstract java.lang.String peek()
Returns string that peeks the property value.

Returns:

setParent

final void setParent(java.lang.Object parent)
Parameters:
parent - the parent to set

setRoot

final void setRoot(TopologyObject root)
Parameters:
root - the root to set

finalizeProperty

abstract void finalizeProperty()
Finalizes the PropertyObject structure.



© Copyright 2006 IBM Corp. 2006 All Rights Reserved