GroovyEngine (root 0.2-SNAPSHOT API)

java.lang.Object
- xyz.cofe.cxconsole.groovy.GroovyEngine

All Implemented Interfaces:

MapStore, Xml2Object, XmlElementStore, Engine, EngineOutput, GetBindings, GetClassLoader, SetBindings, SetClassLoader, ScnChanged<GCompilerConf,Long>
```
public class GroovyEngine
extends Object
implements Engine, MapStore, XmlElementStore, Xml2Object, SetBindings, GetBindings, EngineOutput, ScnChanged<GCompilerConf,Long>, SetClassLoader, GetClassLoader
```
Реализация поддержки Groovy через GroovyShell

Author:

georgiy

Property Summary

All Methods Instance Methods Concrete Methods
Type Property and Description

boolean isAssignOut
Gets the value of the property assignOutProperty.

All Methods Instance Methods Concrete Methods
Type	Property and Description
`boolean`	`isAssignOut` Gets the value of the property assignOutProperty.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`assignOutProperty`
`protected EngineBindings`	`bindings`
`protected boolean`	`cacheGroovyShell`
`protected ClassLoader`	`classLoader`
`protected ScnChanedListener`	`compilerConfChangeListener`
`protected GCompilerConf`	`compilerConfiguration`
`protected ScnChanedListener`	`dropGroovyShell`
`protected Writer`	`errorWriter`
`protected GroovyEngineFactory`	`factory`
`protected boolean`	`GClassLoaderClearCache`
`protected LongScnChangedSupport`	`scnSupport`
`protected long`	`submitId`
`protected long`	`submitIdInc`
`protected boolean`	`threadGroupAuto`
`protected Writer`	`writer`

Constructor Summary

Constructors
Constructor and Description

GroovyEngine()
Конструктор по умолчанию

Constructors
Constructor and Description
`GroovyEngine()` Конструктор по умолчанию

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addScnChangedEvent(ScnChangedEvent ev)`
`Closeable`	`addScnChangedListener(ScnChanedListener listener)` Добавляет подписчика на изменения
`Closeable`	`addScnChangedListener(ScnChanedListener listener, boolean weakLink)` Добавляет подписчика на изменения
`protected void`	`configure(ThreadMonitorImpl thmon)` Настраивает монитор выполнения скрипта.
`protected groovy.lang.Binding`	`createGroovyBinding(EngineBindings ebind)` Создает прокси "привязок" для GroovyShell
`protected void`	`dropGroovyShell()` Удаляет GroovyShell из кэша
`void`	`fireScnChanged(Comparable old, Comparable cur)` Уведомляет подписчиков о измении SCN минуя очередь уведомлений
`void`	`fireScnChangedEvent(ScnChangedEvent event)` Уведомляет подписчиков о измении SCN минуя очередь уведомлений
`void`	`fireScnChangedEvents()` Рассылает уведомления из очереди
`EngineBindings`	`getBindings()` Указывает "привязку" к переменным
`ClassLoader`	`getClassLoader()` Указывает загрузчик классов, на поведение GroovyClassLoader влияет свойство GClassLoaderClearCache
`GCompilerConf`	`getCompilerConfiguration()`
`Writer`	`getErrorWriter()` Указывает output ошибок для класса скрипта.
`GroovyEngineFactory`	`getFactory()` Возвращает фабрику для создания движка
`Class`	`getJavaType()` JAVA объект соответ тэгу
`ConcurrentLinkedQueue`	`getScnChangedEventQueue()` Возвращает очередь уведомлений
`Set`	`getScnChangedListeners()` Возвращает активных подписчиков
`long`	`getSubmitId()` Счетчик для ThreadGroup
`long`	`getSubmitIdInc()` Шаг счетчика ThreadGroup
`String`	`getTagName()` XML Тег которым представлен объект
`boolean`	`getThreadGroupAuto()`
`Writer`	`getWriter()` Указывает output для класса скрипта.
`groovy.lang.GroovyShell`	`groovyShell()` Создает/возвращает GroovyShell
`boolean`	`hasScnChangedListener(ScnChanedListener listener)` Проверяет что указанный подписчик имеется в списках рассылки
`boolean`	`isAssignOutProperty()` Gets the value of the property assignOutProperty.
`boolean`	`isCacheGroovyShell()` Указывает кэшировать или каждый раз создавать новый GroovyShell
`boolean`	`isGClassLoaderClearCache()` Указывает сбрасывать кэш скомпилированных Groovy классов из ClassLoader-а, при запуске скрипта
`void`	`loadXml(String xml)` Восстанавливает объект по XML разметке
`Pair`	`nextscn()` Генерирует новый номер SCN.
`Pair`	`nextscn(boolean addEvent, boolean fireEvent)` Генерирует новый номер SCN
`void`	`removeAllScnChangedListeners()` Удаляет всех подписчиков
`void`	`removeScnChangedListener(ScnChanedListener listener)` Удаляет подписчика от уведомлений
`Object`	`restore(Element el)` Восстановление объекта из XML описания
`void`	`restore(Map map)` Восстановление состояния объекта
`Long`	`scn()` Возвращает текущий номер изменений
`void`	`scn(Runnable run)` Выполняет код в блоку try/finally а затем рассылает уведомления.
`void`	`setAssignOutProperty(boolean assignOutProperty)` Устанавливать свойство out для GroovyShell, если доступен writer
`void`	`setBindings(EngineBindings bindings)` Указывает "привязку" к переменным
`void`	`setCacheGroovyShell(boolean cacheGroovyShell)` Указывает кэшировать или каждый раз создавать новый GroovyShell
`void`	`setClassLoader(ClassLoader classLoader)` Указывает загрузчик классов, на поведение GroovyClassLoader влияет свойство GClassLoaderClearCache
`void`	`setCompilerConfiguration(GCompilerConf compilerConfiguration)`
`void`	`setErrorWriter(Writer writer)` Указывает output ошибок для класса скрипта.
`void`	`setFactory(GroovyEngineFactory factory)` Указывает фабрику Groovy
`void`	`setGClassLoaderClearCache(boolean GClassLoaderClearCache)` Указывает сбрасывать кэш скомпилированных Groovy классов из ClassLoader-а, при запуске скрипта
`void`	`setSubmitId(long submitId)` Счетчик для ThreadGroup
`void`	`setSubmitIdInc(long submitIdInc)` Шаг счетчика ThreadGroup
`void`	`setThreadGroupAuto(boolean threadGroupAuto)`
`void`	`setWriter(Writer writer)` Указывает output для класса скрипта.
`void`	`store(Map map)` Сохранение состояния объекта
`ExecuteMonitor<GroovyEngineScript>`	`submit(GroovyEngineScript script)`
`ExecuteMonitor<String>`	`submit(String script)` Отправляет скрипт на выполнение
`String`	`toXml()` Сохраняет объект в XML виде
`void`	`xmlElementRestore(Element xe)` Восстанавливает объект из контейнера XML
`void`	`xmlElementStore(Element xe)` Сохраняет объект в XML представление

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

- Property Detail
  - isAssignOut
```
public boolean isAssignOutProperty
```
    Gets the value of the property assignOutProperty.
- Field Detail
  - scnSupport
```
protected final LongScnChangedSupport scnSupport
```
  - dropGroovyShell
```
protected final ScnChanedListener dropGroovyShell
```
  - factory
```
protected GroovyEngineFactory factory
```
  - bindings
```
protected EngineBindings bindings
```
  - assignOutProperty
```
protected boolean assignOutProperty
```
  - cacheGroovyShell
```
protected boolean cacheGroovyShell
```
  - GClassLoaderClearCache
```
protected boolean GClassLoaderClearCache
```
  - classLoader
```
protected ClassLoader classLoader
```
  - writer
```
protected Writer writer
```
  - errorWriter
```
protected Writer errorWriter
```
  - compilerConfiguration
```
protected GCompilerConf compilerConfiguration
```
  - compilerConfChangeListener
```
protected ScnChanedListener compilerConfChangeListener
```
  - threadGroupAuto
```
protected boolean threadGroupAuto
```
  - submitId
```
protected long submitId
```
  - submitIdInc
```
protected long submitIdInc
```
- Constructor Detail
  - GroovyEngine
```
public GroovyEngine()
```
    Конструктор по умолчанию
- Method Detail
  - scn
```
public Long scn()
```
    Description copied from interface: ScnChanged
    
    Возвращает текущий номер изменений
    
    Specified by:
    
    scn in interface ScnChanged<GCompilerConf,Long>
    
    Returns:
    
    текущий номер изменения
  - nextscn
```
public Pair nextscn(boolean addEvent,
                    boolean fireEvent)
```
    Генерирует новый номер SCN
    
    Parameters:
    
    addEvent - true - добавляет извещение в очередь
    
    fireEvent - true - рассылает накопленные собщения из очереди
    
    Returns:
    
    Предыдущий и текущий номер SCN
  - nextscn
```
public Pair nextscn()
```
    Генерирует новый номер SCN.
    Если уровень вложенности scn( Runnable ) - нулевой (нет вложенных блоков), то рассылает накопленные собщения из очереди.
    Если уровень вложенности scn( Runnable ) - больше нуля, то просто добавляет извещения в очередь.
    
    Returns:
    
    Предыдущий и текущий номер SCN
  - scn
```
public void scn(Runnable run)
```
    Выполняет код в блоку try/finally а затем рассылает уведомления.
    Выполняет код в блоке try/finally. А по завершению верхнего уровня рассылает накопленные уведомления из очереди.
    
    Parameters:
    
    run - код
  - hasScnChangedListener
```
public boolean hasScnChangedListener(ScnChanedListener listener)
```
    Description copied from interface: ScnChanged
    
    Проверяет что указанный подписчик имеется в списках рассылки
    
    Specified by:
    
    hasScnChangedListener in interface ScnChanged<GCompilerConf,Long>
    
    Parameters:
    
    listener - подписчик
    
    Returns:
    
    true - подписчик имеется в списках рассылки
  - getScnChangedListeners
```
public Set getScnChangedListeners()
```
    Description copied from interface: ScnChanged
    
    Возвращает активных подписчиков
    
    Specified by:
    
    getScnChangedListeners in interface ScnChanged<GCompilerConf,Long>
    
    Returns:
    
    подписчики
  - addScnChangedListener
```
public Closeable addScnChangedListener(ScnChanedListener listener)
```
    Description copied from interface: ScnChanged
    
    Добавляет подписчика на изменения
    
    Specified by:
    
    addScnChangedListener in interface ScnChanged<GCompilerConf,Long>
    
    Parameters:
    
    listener - подписчик
    
    Returns:
    
    Интерфейс отписки от уведомлений
  - addScnChangedListener
```
public Closeable addScnChangedListener(ScnChanedListener listener,
                                       boolean weakLink)
```
    Description copied from interface: ScnChanged
    
    Добавляет подписчика на изменения
    
    Specified by:
    
    addScnChangedListener in interface ScnChanged<GCompilerConf,Long>
    
    Parameters:
    
    listener - подписчик
    
    weakLink - true - добавить подписчика на weak ссылку / false - как hard ссылку
    
    Returns:
    
    Интерфейс отписки от уведомлений
  - removeScnChangedListener
```
public void removeScnChangedListener(ScnChanedListener listener)
```
    Description copied from interface: ScnChanged
    
    Удаляет подписчика от уведомлений
    
    Specified by:
    
    removeScnChangedListener in interface ScnChanged<GCompilerConf,Long>
    
    Parameters:
    
    listener - подписчик
  - removeAllScnChangedListeners
```
public void removeAllScnChangedListeners()
```
    Description copied from interface: ScnChanged
    
    Удаляет всех подписчиков
    
    Specified by:
    
    removeAllScnChangedListeners in interface ScnChanged<GCompilerConf,Long>
  - fireScnChangedEvent
```
public void fireScnChangedEvent(ScnChangedEvent event)
```
    Уведомляет подписчиков о измении SCN минуя очередь уведомлений
    
    Parameters:
    
    event - уведомление
  - getScnChangedEventQueue
```
public ConcurrentLinkedQueue getScnChangedEventQueue()
```
    Возвращает очередь уведомлений
    
    Returns:
    
    Очередь уведомлений
  - addScnChangedEvent
```
public void addScnChangedEvent(ScnChangedEvent ev)
```
  - fireScnChangedEvents
```
public void fireScnChangedEvents()
```
    Рассылает уведомления из очереди
  - fireScnChanged
```
public void fireScnChanged(Comparable old,
                           Comparable cur)
```
    Уведомляет подписчиков о измении SCN минуя очередь уведомлений
    
    Parameters:
    
    old - предыдущее значение SCN
    
    cur - текущее значение SCN
  - getFactory
```
public GroovyEngineFactory getFactory()
```
    Description copied from interface: Engine
    
    Возвращает фабрику для создания движка
    
    Specified by:
    
    getFactory in interface Engine
    
    Returns:
    
    фабрика движков
  - setFactory
```
public void setFactory(GroovyEngineFactory factory)
```
    Указывает фабрику Groovy
    
    Parameters:
    
    factory - фабрика
  - getBindings
```
public EngineBindings getBindings()
```
    Description copied from interface: GetBindings
    
    Указывает "привязку" к переменным
    
    Specified by:
    
    getBindings in interface GetBindings
    
    Returns:
    
    "привязки" переменным
  - setBindings
```
public void setBindings(EngineBindings bindings)
```
    Description copied from interface: SetBindings
    
    Указывает "привязку" к переменным
    
    Specified by:
    
    setBindings in interface SetBindings
    
    Parameters:
    
    bindings - "привязки" переменным
  - createGroovyBinding
```
protected groovy.lang.Binding createGroovyBinding(EngineBindings ebind)
```
    Создает прокси "привязок" для GroovyShell
    
    Parameters:
    
    ebind - исходные "привязки"
    
    Returns:
    
    GroovyShell "привязки"
  - isAssignOutProperty
```
public boolean isAssignOutProperty()
```
    Gets the value of the property assignOutProperty.
  - setAssignOutProperty
```
public void setAssignOutProperty(boolean assignOutProperty)
```
    Устанавливать свойство out для GroovyShell, если доступен writer
    
    Parameters:
    
    assignOutProperty - true - устанавливать
    
    See Also:
    
    configure(xyz.cofe.cxconsole.script.jsr233.ThreadMonitorImpl)
  - groovyShell
```
public groovy.lang.GroovyShell groovyShell()
```
    Создает/возвращает GroovyShell
    
    Returns:
    
    GroovyShell
  - dropGroovyShell
```
protected void dropGroovyShell()
```
    Удаляет GroovyShell из кэша
  - isCacheGroovyShell
```
public boolean isCacheGroovyShell()
```
    Указывает кэшировать или каждый раз создавать новый GroovyShell
    
    Returns:
    
    true - кэшировать объект GroovyShell
  - setCacheGroovyShell
```
public void setCacheGroovyShell(boolean cacheGroovyShell)
```
    Указывает кэшировать или каждый раз создавать новый GroovyShell
    
    Parameters:
    
    cacheGroovyShell - true - кэшировать объект GroovyShell
  - isGClassLoaderClearCache
```
public boolean isGClassLoaderClearCache()
```
    Указывает сбрасывать кэш скомпилированных Groovy классов из ClassLoader-а, при запуске скрипта
    
    Returns:
    
    true - сбрасывать кэш / false - оставить кэш как есть
  - setGClassLoaderClearCache
```
public void setGClassLoaderClearCache(boolean GClassLoaderClearCache)
```
    Указывает сбрасывать кэш скомпилированных Groovy классов из ClassLoader-а, при запуске скрипта
    
    Parameters:
    
    GClassLoaderClearCache - true - сбрасывать кэш / false - оставить кэш как есть
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Указывает загрузчик классов, на поведение GroovyClassLoader влияет свойство GClassLoaderClearCache
    
    Specified by:
    
    getClassLoader in interface GetClassLoader
    
    Returns:
    
    Загрузчик классов
    
    See Also:
    
    isGClassLoaderClearCache(), setGClassLoaderClearCache(boolean)
  - setClassLoader
```
public void setClassLoader(ClassLoader classLoader)
```
    Указывает загрузчик классов, на поведение GroovyClassLoader влияет свойство GClassLoaderClearCache
    
    Specified by:
    
    setClassLoader in interface SetClassLoader
    
    Parameters:
    
    classLoader - Загрузчик классов
    
    See Also:
    
    isGClassLoaderClearCache(), setGClassLoaderClearCache(boolean)
  - getWriter
```
public Writer getWriter()
```
    Указывает output для класса скрипта. Лучше испольвать службу ScriptOutputService
    
    Specified by:
    
    getWriter in interface EngineOutput
    
    Returns:
    
    output длся скрпта
    
    See Also:
    
    ScriptOutputService
  - setWriter
```
public void setWriter(Writer writer)
```
    Указывает output для класса скрипта. Лучше испольвать службу ScriptOutputService
    
    Specified by:
    
    setWriter in interface EngineOutput
    
    Parameters:
    
    writer - output длся скрпта
    
    See Also:
    
    ScriptOutputService
  - getErrorWriter
```
public Writer getErrorWriter()
```
    Указывает output ошибок для класса скрипта. Лучше испольвать службу ScriptOutputService
    
    Specified by:
    
    getErrorWriter in interface EngineOutput
    
    Returns:
    
    output длся скрпта
    
    See Also:
    
    ScriptOutputService
  - setErrorWriter
```
public void setErrorWriter(Writer writer)
```
    Указывает output ошибок для класса скрипта. Лучше испольвать службу ScriptOutputService
    
    Specified by:
    
    setErrorWriter in interface EngineOutput
    
    Parameters:
    
    writer - output длся скрпта
    
    See Also:
    
    ScriptOutputService
  - getCompilerConfiguration
```
public GCompilerConf getCompilerConfiguration()
```
  - setCompilerConfiguration
```
public void setCompilerConfiguration(GCompilerConf compilerConfiguration)
```
  - getThreadGroupAuto
```
public boolean getThreadGroupAuto()
```
  - setThreadGroupAuto
```
public void setThreadGroupAuto(boolean threadGroupAuto)
```
  - getSubmitId
```
public long getSubmitId()
```
    Счетчик для ThreadGroup
    
    Returns:
    
    значение счетчика
    
    See Also:
    
    configure(xyz.cofe.cxconsole.script.jsr233.ThreadMonitorImpl)
  - setSubmitId
```
public void setSubmitId(long submitId)
```
    Счетчик для ThreadGroup
    
    Parameters:
    
    submitId - значение счетчика
    
    See Also:
    
    configure(xyz.cofe.cxconsole.script.jsr233.ThreadMonitorImpl)
  - getSubmitIdInc
```
public long getSubmitIdInc()
```
    Шаг счетчика ThreadGroup
    
    Returns:
    
    размер шага
    
    See Also:
    
    configure(xyz.cofe.cxconsole.script.jsr233.ThreadMonitorImpl)
  - setSubmitIdInc
```
public void setSubmitIdInc(long submitIdInc)
```
    Шаг счетчика ThreadGroup
    
    Parameters:
    
    submitIdInc - размер шага
    
    See Also:
    
    configure(xyz.cofe.cxconsole.script.jsr233.ThreadMonitorImpl)
  - configure
```
protected void configure(ThreadMonitorImpl thmon)
```
    Настраивает монитор выполнения скрипта.
    Если указано threadGroupAuto=true, то создает тред группу ThreadGroup с именем GroovyEngine tg#номер, Номер берется из свойства submitId, после значение свойства submitId увеличивается на величину submitIdInc.
    
    Parameters:
    
    thmon - монитор
    
    See Also:
    
    getSubmitId(), setSubmitId(long), getSubmitIdInc(), setSubmitIdInc(long)
  - submit
```
public ExecuteMonitor<GroovyEngineScript> submit(GroovyEngineScript script)
```
  - submit
```
public ExecuteMonitor<String> submit(String script)
```
    Description copied from interface: Engine
    
    Отправляет скрипт на выполнение
    
    Specified by:
    
    submit in interface Engine
    
    Parameters:
    
    script - скрипт
    
    Returns:
    
    монитор выполнения
  - xmlElementStore
```
public void xmlElementStore(Element xe)
```
    Description copied from interface: XmlElementStore
    
    Сохраняет объект в XML представление
    
    Specified by:
    
    xmlElementStore in interface XmlElementStore
    
    Parameters:
    
    xe - контейнер XML
  - xmlElementRestore
```
public void xmlElementRestore(Element xe)
```
    Description copied from interface: XmlElementStore
    
    Восстанавливает объект из контейнера XML
    
    Specified by:
    
    xmlElementRestore in interface XmlElementStore
    
    Parameters:
    
    xe - контейнер XML
  - toXml
```
public String toXml()
```
    Сохраняет объект в XML виде
    
    Returns:
    
    XML разметка объекта
  - loadXml
```
public void loadXml(String xml)
```
    Восстанавливает объект по XML разметке
    
    Parameters:
    
    xml - XML разметка
  - getTagName
```
public String getTagName()
```
    Description copied from interface: Xml2Object
    
    XML Тег которым представлен объект
    
    Specified by:
    
    getTagName in interface Xml2Object
    
    Returns:
    
    xml-тэг
  - getJavaType
```
public Class getJavaType()
```
    Description copied from interface: Xml2Object
    
    JAVA объект соответ тэгу
    
    Specified by:
    
    getJavaType in interface Xml2Object
    
    Returns:
    
    JAVA объект
  - restore
```
public Object restore(Element el)
```
    Description copied from interface: Xml2Object
    
    Восстановление объекта из XML описания
    
    Specified by:
    
    restore in interface Xml2Object
    
    Parameters:
    
    el - xml описание
    
    Returns:
    
    объект
  - store
```
public void store(Map map)
```
    Description copied from interface: MapStore
    
    Сохранение состояния объекта
    
    Specified by:
    
    store in interface MapStore
    
    Parameters:
    
    map - хранилище
  - restore
```
public void restore(Map map)
```
    Description copied from interface: MapStore
    
    Восстановление состояния объекта
    
    Specified by:
    
    restore in interface MapStore
    
    Parameters:
    
    map - хранилище

Class GroovyEngine

Property Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

isAssignOut

Field Detail

scnSupport

dropGroovyShell

factory

bindings

assignOutProperty

cacheGroovyShell

GClassLoaderClearCache

classLoader

writer

errorWriter

compilerConfiguration

compilerConfChangeListener

threadGroupAuto

submitId

submitIdInc

Constructor Detail

GroovyEngine

Method Detail

scn

nextscn

nextscn

scn

hasScnChangedListener

getScnChangedListeners

addScnChangedListener

addScnChangedListener

removeScnChangedListener

removeAllScnChangedListeners

fireScnChangedEvent

getScnChangedEventQueue

addScnChangedEvent

fireScnChangedEvents

fireScnChanged

getFactory

setFactory

getBindings

setBindings

createGroovyBinding

isAssignOutProperty

setAssignOutProperty

groovyShell

dropGroovyShell

isCacheGroovyShell

setCacheGroovyShell

isGClassLoaderClearCache

setGClassLoaderClearCache

getClassLoader

setClassLoader

getWriter

setWriter

getErrorWriter

setErrorWriter

getCompilerConfiguration

setCompilerConfiguration

getThreadGroupAuto

setThreadGroupAuto

getSubmitId

setSubmitId

getSubmitIdInc

setSubmitIdInc

configure

submit

submit

xmlElementStore

xmlElementRestore

toXml

loadXml

getTagName

getJavaType

restore

store