ClassNode (common 0.2.2 API)

java.lang.Object
- xyz.cofe.collection.tree.ClassNode

All Implemented Interfaces:: NodesExtracter, ScnChanged<ClassNode,Long>

public class ClassNode
extends Object
implements NodesExtracter, ScnChanged<ClassNode,Long>

Функция "следования" (извлечения) дочерних/связынных объектов из объектов определенного типа.

Использование:

 ClassNode cn = new ClassNode();
 
 // Определяем функцию извелечения дочерних файлов из каталога
 cn.add( File.class, new NodesExtracter(){ ... } );
 
 // Определяем функцию 1 извелечения элементов из списка
 cn.add( List.class, new NodesExtracter(){ ... } );
 
 // Определяем функцию 2 извелечения элементов из списка в обратном порядке
 cn.add( List.class, new NodesExtracter(){ ... } );
 
 // вернет итератор по элементам, 
 // при чем элементы будут возвращены по два раза
 // в прямом и в обратном порядке т.к. определены две функции
 for( Object it : cn.fetch( list ) )

Author:: Kamnev Georgiy (nt.gocha@gmail.com)

Field Summary

Fields
Modifier and Type	Field and Description
`protected Lock`	`lock`
`protected LongScnChangedSupport<ClassNode>`	`scn`
`protected Map<Class,Set<NodesExtracter>>`	`typedExtracter`
`protected ClassSet`	`types`

Constructor Summary

Constructors
Constructor and Description
`ClassNode()` Конструктор по умочанию
`ClassNode(ClassNode src, Lock lock)` Конструктор копирования с блокиовкой
`ClassNode(Lock lock)` Конструктор с блокировкой

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Closeable`	`add(Class cls, NodesExtracter ne)` Добавляет функцию следования
`<T> ClassNode`	`adds(Class<T> cls, NodesExtracter<T,?>... ne)` Добавляет функции следования для указанного типа
`void`	`addScnChangedEvent(ScnChangedEvent<ClassNode,Long> ev)` Добавляет уведомление в очередь
`Closeable`	`addScnChangedListener(ScnChanedListener<ClassNode,Long> listener)` Добавляет подписчика на изменения
`Closeable`	`addScnChangedListener(ScnChanedListener<ClassNode,Long> listener, boolean weakLink)` Добавляет подписчика на изменения
`void`	`clear()` Очищает все функции следования для указанного типа
`void`	`clear(Class cls)` Очищает все функции следования для указанного типа
`ClassNode`	`clone()` Клонирование
`ClassNode`	`clone(Lock lock)` Клонирование с блокировкой
`Iterable`	`extract(Object from)` Возвращает набор функций подходящих для извлечения данных (синоним fetch).
`NodesExtracter[]`	`extractersOf(Class cls)` Возвращает набор функций подходящих для извлечения данных
`Iterable`	`fetch(Object node)` Возвращает набор функций подходящих для извлечения данных
`void`	`fireScnChanged(Long old, Long cur)` Уведомляет подписчиков о измении SCN минуя очередь уведомлений
`void`	`fireScnChangedEvent(ScnChangedEvent<ClassNode,Long> event)` Уведомляет подписчиков о измении SCN минуя очередь уведомлений
`void`	`fireScnChangedEvents()` Рассылает уведомления из очереди
`Class[]`	`getClasses()` Возвращает зарегистрированные типы
`NodesExtracter[]`	`getNodeExtracters(Class cls)` Возвращает функции следования для указанного типа
`ConcurrentLinkedQueue<ScnChangedEvent<ClassNode,Long>>`	`getScnChangedEventQueue()` Возвращает очередь уведомлений
`Set<ScnChanedListener<ClassNode,Long>>`	`getScnChangedListeners()` Возвращает активных подписчиков
`boolean`	`hasClass(Class cls)` Проверяет наличие функций у указанного типа
`boolean`	`hasScnChangedListener(ScnChanedListener<ClassNode,Long> listener)` Проверяет что указанный подписчик имеется в списках рассылки
`Pair<Long,Long>`	`nextscn()` Генерирует новый номер SCN.
`Pair<Long,Long>`	`nextscn(boolean addEvent, boolean fireEvent)` (non-Javadoc)
`void`	`remove(Class cls, NodesExtracter ne)` Удаляет функцию следования
`void`	`removeAllScnChangedListeners()` Удаляет всех подписчиков
`void`	`removeScnChangedListener(ScnChanedListener<ClassNode,Long> listener)` Удаляет подписчика от уведомлений
`Long`	`scn()` (non-Javadoc)
`void`	`scn(Runnable run)` Выполняет код в блоку try/finally а затем рассылает уведомления.

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

- Field Detail
  - lock
```
protected final Lock lock
```
  - typedExtracter
```
protected final Map<Class,Set<NodesExtracter>> typedExtracter
```
  - types
```
protected final ClassSet types
```
  - scn
```
protected final LongScnChangedSupport<ClassNode> scn
```
- Constructor Detail
  - ClassNode
```
public ClassNode()
```
    Конструктор по умочанию
  - ClassNode
```
public ClassNode(Lock lock)
```
    Конструктор с блокировкой
    
    Parameters:
    
    lock - блокировка
  - ClassNode
```
public ClassNode(ClassNode src,
                 Lock lock)
```
    Конструктор копирования с блокиовкой
    
    Parameters:
    
    src - образец для копирования
    
    lock - блокировка
- Method Detail
  - clone
```
public ClassNode clone()
```
    Клонирование
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    клон
  - clone
```
public ClassNode clone(Lock lock)
```
    Клонирование с блокировкой
    
    Parameters:
    
    lock - блокировка
    
    Returns:
    
    клон
  - scn
```
public Long scn()
```
    (non-Javadoc)
    
    Specified by:
    
    scn in interface ScnChanged<ClassNode,Long>
    
    Returns:
    
    текущий номер изменения
    
    See Also:
    
    LongScnChangedSupport.scn()
  - nextscn
```
public Pair<Long,Long> nextscn(boolean addEvent,
                               boolean fireEvent)
```
    (non-Javadoc)
    
    Parameters:
    
    addEvent - Добавить событие в очередь
    
    fireEvent - ассылает накопленные собщения из очереди
    
    Returns:
    
    Предыдущий и текущий номер SCN
    
    See Also:
    
    LongScnChangedSupport.nextscn(boolean,boolean)
  - nextscn
```
public Pair<Long,Long> nextscn()
```
    Генерирует новый номер SCN.
    Если уровень вложенности scn( Runnable ) - нулевой (нет вложенных блоков), то рассылает накопленные собщения из очереди.
    Если уровень вложенности scn( Runnable ) - больше нуля, то просто добавляет извещения в очередь.
    
    Returns:
    
    Предыдущий и текущий номер SCN
    
    See Also:
    
    LongScnChangedSupport.nextscn()
  - scn
```
public void scn(Runnable run)
```
    Выполняет код в блоку try/finally а затем рассылает уведомления.
    Выполняет код в блоке try/finally. А по завершению верхнего уровня рассылает накопленные уведомления из очереди.
    
    Parameters:
    
    run - код
    
    See Also:
    
    LongScnChangedSupport.scn(Runnable)
  - hasScnChangedListener
```
public boolean hasScnChangedListener(ScnChanedListener<ClassNode,Long> listener)
```
    Description copied from interface: ScnChanged
    
    Проверяет что указанный подписчик имеется в списках рассылки
    
    Specified by:
    
    hasScnChangedListener in interface ScnChanged<ClassNode,Long>
    
    Parameters:
    
    listener - подписчик
    
    Returns:
    
    true - подписчик имеется в списках рассылки
  - getScnChangedListeners
```
public Set<ScnChanedListener<ClassNode,Long>> getScnChangedListeners()
```
    Description copied from interface: ScnChanged
    
    Возвращает активных подписчиков
    
    Specified by:
    
    getScnChangedListeners in interface ScnChanged<ClassNode,Long>
    
    Returns:
    
    подписчики
  - addScnChangedListener
```
public Closeable addScnChangedListener(ScnChanedListener<ClassNode,Long> listener)
```
    Description copied from interface: ScnChanged
    
    Добавляет подписчика на изменения
    
    Specified by:
    
    addScnChangedListener in interface ScnChanged<ClassNode,Long>
    
    Parameters:
    
    listener - подписчик
    
    Returns:
    
    Интерфейс отписки от уведомлений
  - addScnChangedListener
```
public Closeable addScnChangedListener(ScnChanedListener<ClassNode,Long> listener,
                                       boolean weakLink)
```
    Description copied from interface: ScnChanged
    
    Добавляет подписчика на изменения
    
    Specified by:
    
    addScnChangedListener in interface ScnChanged<ClassNode,Long>
    
    Parameters:
    
    listener - подписчик
    
    weakLink - true - добавить подписчика на weak ссылку / false - как hard ссылку
    
    Returns:
    
    Интерфейс отписки от уведомлений
  - removeScnChangedListener
```
public void removeScnChangedListener(ScnChanedListener<ClassNode,Long> listener)
```
    Description copied from interface: ScnChanged
    
    Удаляет подписчика от уведомлений
    
    Specified by:
    
    removeScnChangedListener in interface ScnChanged<ClassNode,Long>
    
    Parameters:
    
    listener - подписчик
  - removeAllScnChangedListeners
```
public void removeAllScnChangedListeners()
```
    Description copied from interface: ScnChanged
    
    Удаляет всех подписчиков
    
    Specified by:
    
    removeAllScnChangedListeners in interface ScnChanged<ClassNode,Long>
  - fireScnChangedEvent
```
public void fireScnChangedEvent(ScnChangedEvent<ClassNode,Long> event)
```
    Уведомляет подписчиков о измении SCN минуя очередь уведомлений
    
    Parameters:
    
    event - уведомление
    
    See Also:
    
    ScnChangedSupport.fireScnChangedEvent(xyz.cofe.scn.ScnChangedEvent)
  - getScnChangedEventQueue
```
public ConcurrentLinkedQueue<ScnChangedEvent<ClassNode,Long>> getScnChangedEventQueue()
```
    Возвращает очередь уведомлений
    
    Returns:
    
    Очередь уведомлений
    
    See Also:
    
    ScnChangedSupport.getScnChangedEventQueue()
  - addScnChangedEvent
```
public void addScnChangedEvent(ScnChangedEvent<ClassNode,Long> ev)
```
    Добавляет уведомление в очередь
    
    Parameters:
    
    ev - уведомление
    
    See Also:
    
    ScnChangedSupport.fireScnChangedEvent(xyz.cofe.scn.ScnChangedEvent)
  - fireScnChangedEvents
```
public void fireScnChangedEvents()
```
    Рассылает уведомления из очереди
    
    See Also:
    
    ScnChangedSupport.fireScnChangedEvent(xyz.cofe.scn.ScnChangedEvent)
  - fireScnChanged
```
public void fireScnChanged(Long old,
                           Long cur)
```
    Уведомляет подписчиков о измении SCN минуя очередь уведомлений
    
    Parameters:
    
    old - предыдущее значение SCN
    
    cur - текущее значение SCN
    
    See Also:
    
    ScnChangedSupport.fireScnChangedEvent(xyz.cofe.scn.ScnChangedEvent)
  - adds
```
public <T> ClassNode adds(Class<T> cls,
                          NodesExtracter<T,?>... ne)
```
    Добавляет функции следования для указанного типа
    
    Type Parameters:
    
    T - тип
    
    Parameters:
    
    cls - тип
    
    ne - функции
    
    Returns:
    
    self ссылка
  - add
```
public Closeable add(Class cls,
                     NodesExtracter ne)
```
    Добавляет функцию следования
    
    Parameters:
    
    cls - тип
    
    ne - функция следования
    
    Returns:
    
    интерфейс для удаления ассоциации
  - remove
```
public void remove(Class cls,
                   NodesExtracter ne)
```
    Удаляет функцию следования
    
    Parameters:
    
    cls - тип
    
    ne - функция
  - clear
```
public void clear(Class cls)
```
    Очищает все функции следования для указанного типа
    
    Parameters:
    
    cls - тип
  - clear
```
public void clear()
```
    Очищает все функции следования для указанного типа
  - hasClass
```
public boolean hasClass(Class cls)
```
    Проверяет наличие функций у указанного типа
    
    Parameters:
    
    cls - тип
    
    Returns:
    
    true - есть функции
  - getClasses
```
public Class[] getClasses()
```
    Возвращает зарегистрированные типы
    
    Returns:
    
    типы
  - getNodeExtracters
```
public NodesExtracter[] getNodeExtracters(Class cls)
```
    Возвращает функции следования для указанного типа
    
    Parameters:
    
    cls - тип
    
    Returns:
    
    функции
    
    See Also:
    
    Map.get(java.lang.Object)
  - extractersOf
```
public NodesExtracter[] extractersOf(Class cls)
```
    Возвращает набор функций подходящих для извлечения данных
    
    Parameters:
    
    cls - тип данных
    
    Returns:
    
    набор подходящих функций
  - fetch
```
public Iterable fetch(Object node)
```
    Возвращает набор функций подходящих для извлечения данных
    
    Parameters:
    
    node - объект из которого происходит извлечение данных
    
    Returns:
    
    Объекты которые следуют согласно указанным функциям
  - extract
```
public Iterable extract(Object from)
```
    Возвращает набор функций подходящих для извлечения данных (синоним fetch).
    
    Specified by:
    
    extract in interface NodesExtracter
    
    Parameters:
    
    from - объект из которого происходит извлечение данных
    
    Returns:
    
    Объекты которые следуют согласно указанным функциям
    
    See Also:
    
    fetch(java.lang.Object)

Class ClassNode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

lock

typedExtracter

types

scn

Constructor Detail

ClassNode

ClassNode

ClassNode

Method Detail

clone

clone

scn

nextscn

nextscn

scn

hasScnChangedListener

getScnChangedListeners

addScnChangedListener

addScnChangedListener

removeScnChangedListener

removeAllScnChangedListeners

fireScnChangedEvent

getScnChangedEventQueue

addScnChangedEvent

fireScnChangedEvents

fireScnChanged

adds

add

remove

clear

clear

hasClass

getClasses

getNodeExtracters

extractersOf

fetch

extract