ForwardingHierarchy (Derquinse Commons API)

java.lang.Object
- com.google.common.collect.ForwardingObject
- - net.derquinse.common.collect.ForwardingHierarchy<E>

Type Parameters:

E - Type of the elements in the hierarchy.

All Implemented Interfaces:

Hierarchy<E>
```
public abstract class ForwardingHierarchy<E>
extends ForwardingObject
implements Hierarchy<E>
```
A hierarchy that forward its method calls to a delegated hierarchy.

Author:

Andres Rodriguez

Constructor Summary

Constructors
Constructor and Description

ForwardingHierarchy()

Constructors
Constructor and Description
`ForwardingHierarchy()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(E element)` Returns `true` if the hierarchy contains the provided element.
`boolean`	`containsAll(Iterable<? extends E> elements)` Returns `true` if the hierarchy contains all the provided elements.
`protected abstract Hierarchy<E>`	`delegate()`
`Set<E>`	`elementSet()` Returns the set of distinct elements contained in this hierarchy.
`boolean`	`equals(Object object)` Compares the specified object with this hierarchy for equality.
`Iterable<E>`	`getAncestors(E element)` Returns the ancestors of the specified element.
`List<E>`	`getChildren(E element)` Returns the children of the specified element.
`Set<E>`	`getDescendants(E element)` Returns the descendants of the specified element.
`List<E>`	`getFirstLevel()` Returns the first level of the hierarchy.
`int`	`getIndex(E element)` Returns the index of the specified element among its siblings.
`E`	`getParent(E element)` Returns the parent of the specified element.
`E`	`getRoot()` Returns the root element.
`List<E>`	`getSiblings(E element)` Returns the siblings of the specified element.
`int`	`hashCode()` Returns the hash code value for this hierarchy.
`boolean`	`isEmpty()` Returns `true` if the hierarchy is empty.
`boolean`	`isRooted()` Returns whether the hierarchy is rooted.
`int`	`size()` Returns the number of elements in the hierarchy.

Methods inherited from class com.google.common.collect.ForwardingObject
toString

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

- Constructor Detail
  - ForwardingHierarchy
```
public ForwardingHierarchy()
```
- Method Detail
  - delegate
```
protected abstract Hierarchy<E> delegate()
```
    Specified by:
    
    delegate in class ForwardingObject
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: Hierarchy
    
    Returns true if the hierarchy is empty.
    
    Specified by:
    
    isEmpty in interface Hierarchy<E>
  - size
```
public int size()
```
    Description copied from interface: Hierarchy
    
    Returns the number of elements in the hierarchy.
    
    Specified by:
    
    size in interface Hierarchy<E>
  - contains
```
public boolean contains(E element)
```
    Description copied from interface: Hierarchy
    
    Returns true if the hierarchy contains the provided element.
    
    Specified by:
    
    contains in interface Hierarchy<E>
  - containsAll
```
public boolean containsAll(Iterable<? extends E> elements)
```
    Description copied from interface: Hierarchy
    
    Returns true if the hierarchy contains all the provided elements.
    
    Specified by:
    
    containsAll in interface Hierarchy<E>
  - elementSet
```
public Set<E> elementSet()
```
    Description copied from interface: Hierarchy
    
    Returns the set of distinct elements contained in this hierarchy.
    
    Specified by:
    
    elementSet in interface Hierarchy<E>
    
    Returns:
    
    A set containing a live view the elements of the hierarchy.
  - getChildren
```
public List<E> getChildren(E element)
```
    Description copied from interface: Hierarchy
    
    Returns the children of the specified element.
    
    Specified by:
    
    getChildren in interface Hierarchy<E>
    
    Parameters:
    
    element - Element which children are requested. If null the first level will be returned.
    
    Returns:
    
    The list of children, the empty list if it has no children. Never null.
  - getFirstLevel
```
public List<E> getFirstLevel()
```
    Description copied from interface: Hierarchy
    
    Returns the first level of the hierarchy. For a rooted hierarchy it will be a single list element.
    
    Specified by:
    
    getFirstLevel in interface Hierarchy<E>
    
    Returns:
    
    The list of values with no parent. Never null.
  - getParent
```
public E getParent(E element)
```
    Description copied from interface: Hierarchy
    
    Returns the parent of the specified element.
    
    Specified by:
    
    getParent in interface Hierarchy<E>
    
    Parameters:
    
    element - Element which parent is requested.
    
    Returns:
    
    The parent element or null if it is a first-level element.
  - getSiblings
```
public List<E> getSiblings(E element)
```
    Description copied from interface: Hierarchy
    
    Returns the siblings of the specified element.
    
    Specified by:
    
    getSiblings in interface Hierarchy<E>
    
    Parameters:
    
    element - Element which siblings are requested.
    
    Returns:
    
    The list of siblings. At least with one element, the argument itself.
  - getIndex
```
public int getIndex(E element)
```
    Description copied from interface: Hierarchy
    
    Returns the index of the specified element among its siblings.
    
    Specified by:
    
    getIndex in interface Hierarchy<E>
    
    Parameters:
    
    element - Element which index is requested.
    
    Returns:
    
    The position in the list of siblings.
  - getRoot
```
public E getRoot()
```
    Description copied from interface: Hierarchy
    
    Returns the root element.
    
    Specified by:
    
    getRoot in interface Hierarchy<E>
    
    Returns:
    
    The only element in the first level.
  - isRooted
```
public boolean isRooted()
```
    Description copied from interface: Hierarchy
    
    Returns whether the hierarchy is rooted.
    
    Specified by:
    
    isRooted in interface Hierarchy<E>
    
    Returns:
    
    True if the first level has one element.
  - getAncestors
```
public Iterable<E> getAncestors(E element)
```
    Description copied from interface: Hierarchy
    
    Returns the ancestors of the specified element.
    
    Specified by:
    
    getAncestors in interface Hierarchy<E>
    
    Parameters:
    
    element - Element which ancestors are requested.
    
    Returns:
    
    The ancestors in descending level order.
  - getDescendants
```
public Set<E> getDescendants(@Nullable
                             E element)
```
    Description copied from interface: Hierarchy
    
    Returns the descendants of the specified element.
    
    Specified by:
    
    getDescendants in interface Hierarchy<E>
    
    Parameters:
    
    element - Element which descendants are requested. If null the element set is returned.
    
    Returns:
    
    The set of descendants. Iteration order is unspecified.
  - equals
```
public boolean equals(@Nullable
                      Object object)
```
    Description copied from interface: Hierarchy
    
    Compares the specified object with this hierarchy for equality. Returns true if the specified object is also a hierarchy, the two hierarchies have the same size, and both contain the same elements in the same coordinates. This definition ensures that the equals method works properly across different implementations of the hierarchy interface.
    
    Specified by:
    
    equals in interface Hierarchy<E>
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    object - Object to be compared for equality with this hierarchy.
    
    Returns:
    
    True if the specified object is equal to this hierarchy.
  - hashCode
```
public int hashCode()
```
    Description copied from interface: Hierarchy
    
    Returns the hash code value for this hierarchy. The hash code of a hierarchy is defined to be the sum of hash(e)^level(e) for every element e of the hierarchy. This definition fulfills the general contract of Object.hashCode().
    
    Specified by:
    
    hashCode in interface Hierarchy<E>
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    The hash code value for this hierarchy.
    
    See Also:
    
    Object.equals(Object), Hierarchy.equals(Object)

Class ForwardingHierarchy<E>

Constructor Summary

Method Summary

Methods inherited from class com.google.common.collect.ForwardingObject

Methods inherited from class java.lang.Object

Constructor Detail

ForwardingHierarchy

Method Detail

delegate

isEmpty

size

contains

containsAll

elementSet

getChildren

getFirstLevel

getParent

getSiblings

getIndex

getRoot

isRooted

getAncestors

getDescendants

equals

hashCode