MutableTreeWalk (collections-we 0.2 API)

java.lang.Object
- xyz.cofe.collection.iterators.MutableTreeWalk<T>

Type Parameters:

T - Тип узла древа

All Implemented Interfaces:

TreeWalk<T>
```
public class MutableTreeWalk<T>
extends Object
implements TreeWalk<T>
```
Реализация интерфейса информации о обходе дерева - текущем узле/листе, с возможностью изменения.

Author:

gocha

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`childIndex`
`protected int`	`currentLevel` Текущий уровень
`protected T`	`currentNode` Текущий узел/лист древа
`protected boolean`	`firstChild`
`protected boolean`	`lastChild`
`protected TreeWalk<T>`	`parent` Родительский узел (или null)
`protected T`	`parentNode` Родительский узел (или null)
`protected int`	`startLevel` Начальный уровень
`protected T`	`startNode` Корневой узел (или null)
`protected int`	`stepLevel` Шаг между уровнями
`protected Iterable<TreeWalk<T>>`	`walkPath` Путь от корня, до текущего узла

Constructor Summary

Constructors
Constructor and Description
`MutableTreeWalk(T startNode, int startLevel, int stepLevel)` Конструктор начального узла (корня) дерева обхода
`MutableTreeWalk(TreeWalk<T> parentTreeWalk, T currentNode, int currentLevel, int stepLevel)` Конструктор жочернего узла

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`currentLevel()` Возвращает текущий уровень
`void`	`currentLevel(int newCurrentLevel)`
`T`	`currentNode()` Возвращает текущий узел/лист древа
`void`	`currentNode(T newCurrentNode)`
`int`	`getChildIndex()` Возвращает индекс узла среди соседних элементов по порядку обхода.
`boolean`	`isFirstChild()` Возвращает признак что данный узел является первым дочерним узлом среди соседниъ элементов.
`boolean`	`isLastChild()` Возвращает признак что данный узел является последним дочерним узлом среди соседних элементов.
`Iterable<T>`	`nodePath()` Возвращает путь от корня, до текущего узла, ввиде набора "узлов"
`TreeWalk<T>`	`parent()` Возвращает указатель на предществующий (родительский) узел древа
`T`	`parentNode()` Возвращает родительский узел
`void`	`parentNode(T newParentNode)`
`void`	`setChildIndex(int childIndex)` Устанавливает индекс узла среди соседних элементов по порядку обхода.
`void`	`setFirstChild(boolean firstChild)` Устанавливает признак что данный узел является первым дочерним узлом среди соседних элементов.
`void`	`setLastChild(boolean lastChild)` Устанавливает признак что данный узел является последним дочерним узлом среди соседних элементов.
`int`	`startLevel()` Начальный уровень
`void`	`startLevel(int newStartLevel)`
`T`	`startNode()` Возвращает корневой узел
`void`	`startNode(T newStartNode)`
`int`	`stepLevel()` Шаг между уровнями
`void`	`stepLevel(int newStepLevel)`
`Iterable<TreeWalk<T>>`	`walkPath()` Возвращает путь от корня, до текущего узла, ввиде набора "шагов"

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

- Field Detail
  - walkPath
```
protected Iterable<TreeWalk<T>> walkPath
```
    Путь от корня, до текущего узла
  - parent
```
protected TreeWalk<T> parent
```
    Родительский узел (или null)
  - currentNode
```
protected T currentNode
```
    Текущий узел/лист древа
  - currentLevel
```
protected int currentLevel
```
    Текущий уровень
  - parentNode
```
protected T parentNode
```
    Родительский узел (или null)
  - startNode
```
protected T startNode
```
    Корневой узел (или null)
  - startLevel
```
protected int startLevel
```
    Начальный уровень
  - stepLevel
```
protected int stepLevel
```
    Шаг между уровнями
  - firstChild
```
protected boolean firstChild
```
  - lastChild
```
protected boolean lastChild
```
  - childIndex
```
protected int childIndex
```
- Constructor Detail
  - MutableTreeWalk
```
public MutableTreeWalk(TreeWalk<T> parentTreeWalk,
                       T currentNode,
                       int currentLevel,
                       int stepLevel)
```
    Конструктор жочернего узла
    
    Parameters:
    
    parentTreeWalk - Родительский узел
    
    currentNode - Текущий узел
    
    currentLevel - Текущий уровень
    
    stepLevel - Шаг между уровнями
  - MutableTreeWalk
```
public MutableTreeWalk(T startNode,
                       int startLevel,
                       int stepLevel)
```
    Конструктор начального узла (корня) дерева обхода
    
    Parameters:
    
    startNode - Узел (корень)
    
    startLevel - начальный уровень
    
    stepLevel - Шаг между уровнями
- Method Detail
  - walkPath
```
public Iterable<TreeWalk<T>> walkPath()
```
    Description copied from interface: TreeWalk
    
    Возвращает путь от корня, до текущего узла, ввиде набора "шагов"
    
    Specified by:
    
    walkPath in interface TreeWalk<T>
    
    Returns:
    
    Путь от корня, до текущего узла
  - nodePath
```
public Iterable<T> nodePath()
```
    Description copied from interface: TreeWalk
    
    Возвращает путь от корня, до текущего узла, ввиде набора "узлов"
    
    Specified by:
    
    nodePath in interface TreeWalk<T>
    
    Returns:
    
    Путь от корня, до текущего узла
  - parent
```
public TreeWalk<T> parent()
```
    Description copied from interface: TreeWalk
    
    Возвращает указатель на предществующий (родительский) узел древа
    
    Specified by:
    
    parent in interface TreeWalk<T>
    
    Returns:
    
    Родительский узел (или null)
  - currentNode
```
public T currentNode()
```
    Description copied from interface: TreeWalk
    
    Возвращает текущий узел/лист древа
    
    Specified by:
    
    currentNode in interface TreeWalk<T>
    
    Returns:
    
    Текущий узел/лист древа
  - currentNode
```
public void currentNode(T newCurrentNode)
```
  - currentLevel
```
public int currentLevel()
```
    Description copied from interface: TreeWalk
    
    Возвращает текущий уровень
    
    Specified by:
    
    currentLevel in interface TreeWalk<T>
    
    Returns:
    
    Текущий уровень
  - currentLevel
```
public void currentLevel(int newCurrentLevel)
```
  - parentNode
```
public T parentNode()
```
    Description copied from interface: TreeWalk
    
    Возвращает родительский узел
    
    Specified by:
    
    parentNode in interface TreeWalk<T>
    
    Returns:
    
    Родительский узел (или null)
  - parentNode
```
public void parentNode(T newParentNode)
```
  - startNode
```
public T startNode()
```
    Description copied from interface: TreeWalk
    
    Возвращает корневой узел
    
    Specified by:
    
    startNode in interface TreeWalk<T>
    
    Returns:
    
    Корневой узел (или null)
  - startNode
```
public void startNode(T newStartNode)
```
  - startLevel
```
public int startLevel()
```
    Description copied from interface: TreeWalk
    
    Начальный уровень
    
    Specified by:
    
    startLevel in interface TreeWalk<T>
    
    Returns:
    
    Начальный уровень
  - startLevel
```
public void startLevel(int newStartLevel)
```
  - stepLevel
```
public int stepLevel()
```
    Description copied from interface: TreeWalk
    
    Шаг между уровнями
    
    Specified by:
    
    stepLevel in interface TreeWalk<T>
    
    Returns:
    
    Шаг
  - stepLevel
```
public void stepLevel(int newStepLevel)
```
  - getChildIndex
```
public int getChildIndex()
```
    Возвращает индекс узла среди соседних элементов по порядку обхода.
    Пример:
    
    0
    
    0 1
    0 1 2 0
    
    Returns:
    
    Индекси или -1
  - setChildIndex
```
public void setChildIndex(int childIndex)
```
    Устанавливает индекс узла среди соседних элементов по порядку обхода.
    
    Parameters:
    
    childIndex - Индекси или -1
  - isFirstChild
```
public boolean isFirstChild()
```
    Возвращает признак что данный узел является первым дочерним узлом среди соседниъ элементов.
    
    0
    
    1 F 4 L
    
    2 F 3 L 5 F 6 L
    
    Returns:
    
    true - является первым; не является
  - setFirstChild
```
public void setFirstChild(boolean firstChild)
```
    Устанавливает признак что данный узел является первым дочерним узлом среди соседних элементов.
    
    Parameters:
    
    firstChild - true - является первым; не является
    
    See Also:
    
    isFirstChild()
  - isLastChild
```
public boolean isLastChild()
```
    Возвращает признак что данный узел является последним дочерним узлом среди соседних элементов.
    
    Returns:
    
    true - является последним; false - не является
    
    See Also:
    
    isFirstChild()
  - setLastChild
```
public void setLastChild(boolean lastChild)
```
    Устанавливает признак что данный узел является последним дочерним узлом среди соседних элементов.
    
    Parameters:
    
    lastChild - true - является последним; false - не является
    
    See Also:
    
    isFirstChild()

Class MutableTreeWalk<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

walkPath

parent

currentNode

currentLevel

parentNode

startNode

startLevel

stepLevel

firstChild

lastChild

childIndex

Constructor Detail

MutableTreeWalk

MutableTreeWalk

Method Detail

walkPath

nodePath

parent

currentNode

currentNode

currentLevel

currentLevel

parentNode

parentNode

startNode

startNode

startLevel

startLevel

stepLevel

stepLevel

getChildIndex

setChildIndex

isFirstChild

setFirstChild

isLastChild

setLastChild