Class ContextBranch

java.lang.Object

java.util.AbstractCollection<Object>

java.util.AbstractList<Object>

java.util.AbstractSequentialList<Object>

pro.verron.officestamper.core.ContextBranch

All Implemented Interfaces:

Iterable<Object>, Collection<Object>, List<Object>, SequencedCollection<Object>, ContextTree

public class ContextBranch
extends AbstractSequentialList<Object>
implements ContextTree

A branch in the context tree.

Field Summary

Fields inherited from class AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
ContextBranch(ContextRoot tree, Object root)	Constructs a ContextBranch with a single root object.
ContextBranch(ContextRoot tree, List<Object> branch)	Constructs a ContextBranch with a list of objects forming the branch.

Method Summary

Modifier and Type	Method	Description
String	addBranch(Object object)	Adds a new branch with the given object.
ListIterator<Object>	listIterator(int index)
Object	root()	Returns the root object of the branch.
int	size()
String	toString()

Methods inherited from class AbstractSequentialList

add, addAll, get, iterator, remove, set

Methods inherited from class AbstractList

add, clear, equals, hashCode, indexOf, lastIndexOf, listIterator, removeRange, subList

Methods inherited from class AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface Iterable

forEach

Methods inherited from interface List

addAll, addFirst, addLast, contains, containsAll, getFirst, getLast, isEmpty, remove, removeAll, removeFirst, removeLast, replaceAll, retainAll, reversed, sort, spliterator, toArray, toArray

Constructor Details

ContextBranch

public ContextBranch(ContextRoot tree,
 Object root)

Constructs a ContextBranch with a single root object.

Parameters:

tree - the context root tree.

root - the root object of the branch.

ContextBranch

public ContextBranch(ContextRoot tree,
 List<Object> branch)

Constructs a ContextBranch with a list of objects forming the branch.

Parameters:

tree - the context root tree.

branch - the list of objects in the branch.

Method Details

addBranch

public String addBranch(Object object)

Adds a new branch with the given object.

Specified by:

addBranch in interface ContextTree

Parameters:

object - the object to add to the branch.

Returns:

the key of the added branch.

root

public Object root()

Returns the root object of the branch.

Returns:

the root object.

size

public int size()

Specified by:

size in interface Collection<Object>

Specified by:

size in interface List<Object>

Specified by:

size in class AbstractCollection<Object>

toString

public String toString()

Overrides:

toString in class AbstractCollection<Object>

listIterator

public ListIterator<Object> listIterator(int index)

Specified by:

listIterator in interface List<Object>

Specified by:

listIterator in class AbstractSequentialList<Object>