Jexler (jexler-core 4.0.0 API)

ch.artecat.jexler.Jexler

All Implemented Interfaces and Traits:

IssueTracker, Service
```
@groovy.transform.CompileStatic
class Jexler
extends java.lang.Object
```
Jexler, runs a Groovy script that handles events.
Authors:
Jex Jexler (Alain Stalder)

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`Jexler.Events`	Blocking queue for events sent to a Jexler ('events' variable in jexler scripts).

Field Summary

Fields
Modifiers	Name	Description
`protected Jexler.Events`	`events`	Event queue.

Constructor Summary

Constructors
Constructor and description
`Jexler (java.io.File file, JexlerContainer container)` Constructor.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`forgetIssues()`
	`groovy.util.ConfigObject`	`getAsConfig()` Convenience method for getting ConfigSlurper config from parsing this jexler; uses the class already compiled by Grengine.
	`JexlerContainer`	`getContainer()` Get container that contains this jexler.
	`java.io.File`	`getDir()` Get directory that contains script file.
	`java.io.File`	`getFile()` Get jexler script file.
	`java.lang.String`	`getId()`
	`java.util.List<Issue>`	`getIssues()`
	`groovy.util.ConfigObject`	`getMetaConfig()` Get meta config.
	`groovy.lang.Script`	`getScript()` Get jexler script instance, null if script is not running.
	`ServiceState`	`getState()`
	`void`	`handle(Event event)` Handle given event.
	`boolean`	`isRunnable()` Return true if jexler is indicated as a jexler in the first line of its script text (meta config); more precisely returns the state at startup if already running, else reads from file.
	`void`	`start()` Initiate jexler start.
	`void`	`stop()` Initiate jexler stop by sending it a stop event to handle.
	`void`	`trackIssue(Issue issue)`
	`void`	`trackIssue(Service service, java.lang.String message, java.lang.Throwable cause)`
	`void`	`zap()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - protected final Jexler.Events events
    
    Event queue.
- Constructor Detail
  - Jexler(java.io.File file, JexlerContainer container)
    
    Constructor.
    Parameters:
    file - file with jexler script
    container - jexler container that contains this jexler
- Method Detail
  - @java.lang.Override void forgetIssues()
  - groovy.util.ConfigObject getAsConfig()
    
    Convenience method for getting ConfigSlurper config from parsing this jexler; uses the class already compiled by Grengine.
  - JexlerContainer getContainer()
    
    Get container that contains this jexler.
  - java.io.File getDir()
    
    Get directory that contains script file.
  - java.io.File getFile()
    
    Get jexler script file.
  - @java.lang.Override java.lang.String getId()
  - @java.lang.Override java.util.List<Issue> getIssues()
  - groovy.util.ConfigObject getMetaConfig()
    
    Get meta config. Read from the jexler file at each call except if the jexler is already running, in that case returns meta config read at the time the jexler was started. The meta config of a jexler is stored in the first line of a jexler script file. Example:
```
 // Jexler { autostart = true; some = 'thing' }
 
```
    Returns null if there is no meta config in the jexler or the file could not be read; returns an empty config object if config is present but could not be parsed.
  - groovy.lang.Script getScript()
    
    Get jexler script instance, null if script is not running.
  - @java.lang.Override ServiceState getState()
  - void handle(Event event)
    
    Handle given event.
  - boolean isRunnable()
    
    Return true if jexler is indicated as a jexler in the first line of its script text (meta config); more precisely returns the state at startup if already running, else reads from file.
  - @java.lang.Override void start()
    
    Initiate jexler start. Immediately marks the jexler service as starting up, then tries to start the script. Typically returns before the jexler script has started or completed to initialize all of its services. The jexler remains in the running state until the script exits in any way, after it has been tried to stop all registered services.
  - @java.lang.Override void stop()
    
    Initiate jexler stop by sending it a stop event to handle.
  - @java.lang.Override void trackIssue(Issue issue)
  - @java.lang.Override void trackIssue(Service service, java.lang.String message, java.lang.Throwable cause)
  - @java.lang.Override void zap()

| Detail:
Field
Constructor
Method

Groovy Documentation

[Groovy] Class Jexler

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected final Jexler.Events events

Constructor Detail

Jexler(java.io.File file, JexlerContainer container)

Method Detail

@java.lang.Override void forgetIssues()

groovy.util.ConfigObject getAsConfig()

JexlerContainer getContainer()

java.io.File getDir()

java.io.File getFile()

@java.lang.Override java.lang.String getId()

@java.lang.Override java.util.List<Issue> getIssues()

groovy.util.ConfigObject getMetaConfig()

groovy.lang.Script getScript()

@java.lang.Override ServiceState getState()

void handle(Event event)

boolean isRunnable()

@java.lang.Override void start()

@java.lang.Override void stop()

@java.lang.Override void trackIssue(Issue issue)

@java.lang.Override void trackIssue(Service service, java.lang.String message, java.lang.Throwable cause)

@java.lang.Override void zap()