com.tivoli.twg.monitor.api
Class TWGMonPath

java.lang.Object
  extended bycom.tivoli.twg.monitor.api.TWGMonPath

public class TWGMonPath
extends java.lang.Object

This is the TWGMonPath class. This class encapsulates path information for monitoring requests example of usage:

 // create the object
 TWGMonPath  realPath = new TWGMonPath();
 // add 2 levels to the path
 real.AddLevel("Director Agent");
 real.AddLevel("MONCPU");
 


Constructor Summary
TWGMonPath()
          This is the constructor for building the object
 
Method Summary
 TWGMonPath addLevel(java.lang.String pathMember)
          Used to add a level to the end of the path
 java.lang.Object clone()
          Returns a clone of this attribute path.
 boolean equals(TWGMonPath that)
          Compare the value of this path with another path
 java.lang.String getLevel(int level)
          Get the path string for the level requested
 int getLevels()
          get the number of levels in the path
 java.util.Locale getLocale()
          get the locale for the path.
 void setLocale(java.util.Locale locale)
          Set the locale string for the path from a Locale object
 void setLocale(java.lang.String localeStr)
          Deprecated. replaced by setLocale(Locale)
 java.lang.String toString()
          get the path for debugging purposes
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TWGMonPath

public TWGMonPath()
This is the constructor for building the object

Method Detail

addLevel

public TWGMonPath addLevel(java.lang.String pathMember)
Used to add a level to the end of the path

Parameters:
pathMember - adds the next level to the path already contained in the object
Returns:
TWGMonPath refering to this object

getLevels

public int getLevels()
get the number of levels in the path

Returns:
int containing the number of levels in the path

getLevel

public java.lang.String getLevel(int level)
Get the path string for the level requested

Parameters:
level - get the requested path level
Returns:
String string found at level requested

clone

public java.lang.Object clone()
Returns a clone of this attribute path.

Returns:
Object containing a clone of this attribute path.

equals

public boolean equals(TWGMonPath that)
Compare the value of this path with another path

Parameters:
that - the path to check equality with
Returns:
boolean with indication of the two paths are equal.

setLocale

public void setLocale(java.lang.String localeStr)
Deprecated. replaced by setLocale(Locale)

Set the locale string for the path from a string


setLocale

public void setLocale(java.util.Locale locale)
Set the locale string for the path from a Locale object

Parameters:
locale - the locale to set

getLocale

public java.util.Locale getLocale()
get the locale for the path. null if not set

Returns:
the locale string of this path

toString

public java.lang.String toString()
get the path for debugging purposes

Returns:
String containing the path information on a form usable for a debug log