AbstractInfoNodeGenerator (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.gui.core.dotnotationtree.AbstractInfoNodeGenerator

All Implemented Interfaces:

Serializable, Comparable<AbstractInfoNodeGenerator>

Direct Known Subclasses:

GlobalInfoNodeGenerator
```
public abstract class AbstractInfoNodeGenerator
extends Object
implements Serializable, Comparable<AbstractInfoNodeGenerator>
```
Ancestor for classes that manipulate the DotNotation tree at the leaves, adding info nodes.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

AbstractInfoNode, Serialized Form

Constructor Summary

Constructors
Constructor Description

AbstractInfoNodeGenerator()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(AbstractInfoNodeGenerator o)`	Compares this object with the specified object for order.
`boolean`	`equals(Object o)`	Returns whether the two objects are the same.
`abstract boolean`	`process(DotNotationNode leaf, String label)`	Processes the leaf, potentially adding one or more info nodes.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractInfoNodeGenerator
```
public AbstractInfoNodeGenerator()
```
- Method Detail
  - process
```
public abstract boolean process(DotNotationNode leaf,
                                String label)
```
    Processes the leaf, potentially adding one or more info nodes.
    
    Parameters:
    
    leaf - the node to add the info node(s) to
    
    label - the full label for the current path to the root
    
    Returns:
    
    true if at least one info node was added
  - compareTo
```
public int compareTo(AbstractInfoNodeGenerator o)
```
    Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Merely uses the classname for comparison.
    
    Specified by:
    
    compareTo in interface Comparable<AbstractInfoNodeGenerator>
    
    Parameters:
    
    o - the object to be compared.
    
    Returns:
    
    a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
  - equals
```
public boolean equals(Object o)
```
    Returns whether the two objects are the same.
    
    Only compares the classnames of the two objects.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - the object to be compared
    
    Returns:
    
    true if the object is the same as this one