com.bigdata.counters

Interface ICounterNode

All Known Subinterfaces:

ICounter<T>, ICounterSet

All Known Implementing Classes:

AbstractCounterSet, CounterSet

public interface ICounterNode

Shared abstraction layer for both ICounterSet and ICounter.

Version:

$Id$

Author:

Bryan Thompson

Method Summary

Methods

Modifier and Type	Method and Description
ICounterNode	getChild(String name) Return the directly attached object by name.
int	getDepth() Depth of this node in the hierarchy, where the depth of the root is ZERO (0).
String	getName() The local name (does not include the path from the root).
ICounterSet	getParent() The immediate parent in the hierarchy -or- null iff this is the root of the hierarchy.
String	getPath() Complete path from the root inclusive of the local name.
ICounterNode	getPath(String path) Return the object described by the path.
ICounterSet	getRoot() The root of the hierarchy.
boolean	isCounter() true iff this is a counter.
boolean	isCounterSet() true iff this is a collection of counters.
boolean	isRoot() true iff this is the root of the hierarchy.

Method Detail

getParent

ICounterSet getParent()

The immediate parent in the hierarchy -or- null iff this is the root of the hierarchy.

getName

String getName()

The local name (does not include the path from the root).

getPath

String getPath()

Complete path from the root inclusive of the local name.

getDepth

int getDepth()

Depth of this node in the hierarchy, where the depth of the root is ZERO (0).

getRoot

ICounterSet getRoot()

The root of the hierarchy.

isRoot

boolean isRoot()

true iff this is the root of the hierarchy.

isCounterSet

boolean isCounterSet()

true iff this is a collection of counters.

isCounter

boolean isCounter()

true iff this is a counter.

getChild

ICounterNode getChild(String name)

Return the directly attached object by name.

Parameters:

name - The counter name.

Returns:

The object.

getPath

ICounterNode getPath(String path)

Return the object described by the path.

Parameters:

path - The path.

Returns:

The object or null if nothing exists for that path.