GroovyEngine (cxgroovy 0.2.2 API)

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

All Implemented Interfaces:

MapStore, Xml2Object, XmlElementStore, Engine, EngineOutput, GetBindings, GetClassLoader, SetBindings, SetClassLoader, xyz.cofe.scn.ScnChanged<GCompilerConf,Long>
```
public class GroovyEngine
extends Object
implements Engine, MapStore, XmlElementStore, Xml2Object, SetBindings, GetBindings, EngineOutput, xyz.cofe.scn.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 xyz.cofe.scn.ScnChanedListener`	`compilerConfChangeListener`
`protected GCompilerConf`	`compilerConfiguration`
`protected xyz.cofe.scn.ScnChanedListener`	`dropGroovyShell`
`protected Writer`	`errorWriter`
`protected GroovyEngineFactory`	`factory`
`protected boolean`	`GClassLoaderClearCache`
`protected xyz.cofe.scn.LongScnChangedSupport`	`scnSupport`
`protected long`	`submitId`
`protected long`	`submitIdInc`
`protected boolean`	`threadGroupAuto`
`protected Writer`	`writer`

Constructor Summary

Constructors
Constructor and Description

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

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addScnChangedEvent(xyz.cofe.scn.ScnChangedEvent ev)`
`Closeable`	`addScnChangedListener(xyz.cofe.scn.ScnChanedListener listener)`
`Closeable`	`addScnChangedListener(xyz.cofe.scn.ScnChanedListener listener, boolean weakLink)`
`GroovyEngine`	`clone()`
`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(xyz.cofe.scn.ScnChangedEvent event)` Уведомляет подписчиков о измении SCN минуя очередь уведомлений
`void`	`fireScnChangedEvents()` Рассылает уведомления из очереди
`EngineBindings`	`getBindings()`
`ClassLoader`	`getClassLoader()` Указывает загрузчик классов, на поведение GroovyClassLoader влияет свойство GClassLoaderClearCache
`GCompilerConf`	`getCompilerConfiguration()`
`Writer`	`getErrorWriter()` Указывает output ошибок для класса скрипта.
`GroovyEngineFactory`	`getFactory()`
`Class`	`getJavaType()`
`ConcurrentLinkedQueue`	`getScnChangedEventQueue()` Возвращает очередь уведомлений
`Set`	`getScnChangedListeners()`
`long`	`getSubmitId()` Счетчик для ThreadGroup
`long`	`getSubmitIdInc()` Шаг счетчика ThreadGroup
`String`	`getTagName()`
`boolean`	`getThreadGroupAuto()`
`Writer`	`getWriter()` Указывает output для класса скрипта.
`groovy.lang.GroovyShell`	`groovyShell()` Создает/возвращает GroovyShell
`Object`	`groovyShellByReflect()`
`boolean`	`hasScnChangedListener(xyz.cofe.scn.ScnChanedListener listener)`
`boolean`	`isAssignOutProperty()` Gets the value of the property assignOutProperty.
`boolean`	`isCacheGroovyShell()` Указывает кэшировать или каждый раз создавать новый GroovyShell
`boolean`	`isGClassLoaderClearCache()` Указывает сбрасывать кэш скомпилированных Groovy классов из ClassLoader-а, при запуске скрипта
`boolean`	`isTryReflectGroovyShell()`
`void`	`loadXml(String xml)` Восстанавливает объект по XML разметке
`xyz.cofe.collection.Pair`	`nextscn()` Генерирует новый номер SCN.
`xyz.cofe.collection.Pair`	`nextscn(boolean addEvent, boolean fireEvent)` Генерирует новый номер SCN
`void`	`removeAllScnChangedListeners()`
`void`	`removeScnChangedListener(xyz.cofe.scn.ScnChanedListener listener)`
`Object`	`restore(Element el)`
`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`	`setTryReflectGroovyShell(boolean tryReflectGroovyShell)`
`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)`
`void`	`xmlElementStore(Element xe)`

Methods inherited from class java.lang.Object
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 xyz.cofe.scn.LongScnChangedSupport scnSupport
```
  - dropGroovyShell
```
protected final xyz.cofe.scn.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 xyz.cofe.scn.ScnChanedListener compilerConfChangeListener
```
  - threadGroupAuto
```
protected boolean threadGroupAuto
```
  - submitId
```
protected long submitId
```
  - submitIdInc
```
protected long submitIdInc
```
- Constructor Detail
  - GroovyEngine
```
public GroovyEngine()
```
    Конструктор по умолчанию
  - GroovyEngine
```
public GroovyEngine(GroovyEngine sample)
```
    Конструктор по умолчанию
- Method Detail
  - clone
```
public GroovyEngine clone()
```
    Specified by:
    
    clone in interface Engine
    
    Overrides:
    
    clone in class Object
  - scn
```
public Long scn()
```
    Specified by:
    
    scn in interface xyz.cofe.scn.ScnChanged<GCompilerConf,Long>
  - nextscn
```
public xyz.cofe.collection.Pair nextscn(boolean addEvent,
                                        boolean fireEvent)
```
    Генерирует новый номер SCN
    
    Parameters:
    
    addEvent - true - добавляет извещение в очередь
    
    fireEvent - true - рассылает накопленные собщения из очереди
    
    Returns:
    
    Предыдущий и текущий номер SCN
  - nextscn
```
public xyz.cofe.collection.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(xyz.cofe.scn.ScnChanedListener listener)
```
    Specified by:
    
    hasScnChangedListener in interface xyz.cofe.scn.ScnChanged<GCompilerConf,Long>
  - getScnChangedListeners
```
public Set getScnChangedListeners()
```
    Specified by:
    
    getScnChangedListeners in interface xyz.cofe.scn.ScnChanged<GCompilerConf,Long>
  - addScnChangedListener
```
public Closeable addScnChangedListener(xyz.cofe.scn.ScnChanedListener listener)
```
    Specified by:
    
    addScnChangedListener in interface xyz.cofe.scn.ScnChanged<GCompilerConf,Long>
  - addScnChangedListener
```
public Closeable addScnChangedListener(xyz.cofe.scn.ScnChanedListener listener,
                                       boolean weakLink)
```
    Specified by:
    
    addScnChangedListener in interface xyz.cofe.scn.ScnChanged<GCompilerConf,Long>
  - removeScnChangedListener
```
public void removeScnChangedListener(xyz.cofe.scn.ScnChanedListener listener)
```
    Specified by:
    
    removeScnChangedListener in interface xyz.cofe.scn.ScnChanged<GCompilerConf,Long>
  - removeAllScnChangedListeners
```
public void removeAllScnChangedListeners()
```
    Specified by:
    
    removeAllScnChangedListeners in interface xyz.cofe.scn.ScnChanged<GCompilerConf,Long>
  - fireScnChangedEvent
```
public void fireScnChangedEvent(xyz.cofe.scn.ScnChangedEvent event)
```
    Уведомляет подписчиков о измении SCN минуя очередь уведомлений
    
    Parameters:
    
    event - уведомление
  - getScnChangedEventQueue
```
public ConcurrentLinkedQueue getScnChangedEventQueue()
```
    Возвращает очередь уведомлений
    
    Returns:
    
    Очередь уведомлений
  - addScnChangedEvent
```
public void addScnChangedEvent(xyz.cofe.scn.ScnChangedEvent ev)
```
  - fireScnChangedEvents
```
public void fireScnChangedEvents()
```
    Рассылает уведомления из очереди
  - fireScnChanged
```
public void fireScnChanged(Comparable old,
                           Comparable cur)
```
    Уведомляет подписчиков о измении SCN минуя очередь уведомлений
    
    Parameters:
    
    old - предыдущее значение SCN
    
    cur - текущее значение SCN
  - getFactory
```
public GroovyEngineFactory getFactory()
```
    Specified by:
    
    getFactory in interface Engine
  - setFactory
```
public void setFactory(GroovyEngineFactory factory)
```
    Указывает фабрику Groovy
    
    Parameters:
    
    factory - фабрика
  - getBindings
```
public EngineBindings getBindings()
```
    Specified by:
    
    getBindings in interface GetBindings
  - setBindings
```
public void setBindings(EngineBindings bindings)
```
    Specified by:
    
    setBindings in interface SetBindings
  - 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)
  - isTryReflectGroovyShell
```
public boolean isTryReflectGroovyShell()
```
  - setTryReflectGroovyShell
```
public void setTryReflectGroovyShell(boolean tryReflectGroovyShell)
```
  - groovyShellByReflect
```
public Object groovyShellByReflect()
```
  - 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)
```
    Specified by:
    
    submit in interface Engine
  - xmlElementStore
```
public void xmlElementStore(Element xe)
```
    Specified by:
    
    xmlElementStore in interface XmlElementStore
  - xmlElementRestore
```
public void xmlElementRestore(Element xe)
```
    Specified by:
    
    xmlElementRestore in interface XmlElementStore
  - toXml
```
public String toXml()
```
    Сохраняет объект в XML виде
    
    Returns:
    
    XML разметка объекта
  - loadXml
```
public void loadXml(String xml)
```
    Восстанавливает объект по XML разметке
    
    Parameters:
    
    xml - XML разметка
  - getTagName
```
public String getTagName()
```
    Specified by:
    
    getTagName in interface Xml2Object
  - getJavaType
```
public Class getJavaType()
```
    Specified by:
    
    getJavaType in interface Xml2Object
  - restore
```
public Object restore(Element el)
```
    Specified by:
    
    restore in interface Xml2Object
  - store
```
public void store(Map map)
```
    Specified by:
    
    store in interface MapStore
  - restore
```
public void restore(Map map)
```
    Specified by:
    
    restore in interface MapStore

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

GroovyEngine

Method Detail

clone

scn

nextscn

nextscn

scn

hasScnChangedListener

getScnChangedListeners

addScnChangedListener

addScnChangedListener

removeScnChangedListener

removeAllScnChangedListeners

fireScnChangedEvent

getScnChangedEventQueue

addScnChangedEvent

fireScnChangedEvents

fireScnChanged

getFactory

setFactory

getBindings

setBindings

createGroovyBinding

isAssignOutProperty

setAssignOutProperty

isTryReflectGroovyShell

setTryReflectGroovyShell

groovyShellByReflect

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