ScriptContext (ChRL - Rebellion Scripting 1.0.0 API)

All Known Implementing Classes:

ScriptContextImpl
```
public interface ScriptContext
```
This class represents script context that can be loaded, unloaded, etc...

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addChildScriptContext(ScriptContext context)` Adds child contexts to this context.
`boolean`	`equals(Object obj)` Tests if this ScriptContext is equal to another ScriptContext.
`void`	`finalize()` This method overrides finalization to ensure that active script context will not be collected by GC.
`Collection<ScriptContext>`	`getChildScriptContexts()` Returns list of child contexts or null if no contextes present
`ClassListener`	`getClassListener()` Returns class listener associated with this ScriptContext.
`CompilationResult`	`getCompilationResult()` Returns compilation result of this script context
`String`	`getCompilerClassName()` Returns compiler class name that will be used for this script context.
`Iterable<File>`	`getLibraries()` Returns list of files that are used as libraries for this script context
`ScriptContext`	`getParentScriptContext()` Returns parent script context of this context.
`File`	`getRoot()` Returns the root directory for script engine.
`int`	`hashCode()` Returns hashCoded of this ScriptContext.
`void`	`init()` Initializes script context.
`boolean`	`isInitialized()` Returns true if this script context is loaded
`void`	`reload()` Invokes `shutdown()`, after that invokes `init()`.
`void`	`setClassListener(ClassListener cl)` Sets the class listener for this script context.
`void`	`setCompilerClassName(String className)` Sets compiler class name for this script context.
`void`	`setLibraries(Iterable<File> files)` Sets files that represents jar files, they will be used as libraries
`void`	`shutdown()` Notifies all script classes that they must save their data and release resources to prevent memory leaks.

- Method Detail
  - init
```
void init()
```
    Initializes script context. Calls the compilation task.
    After compilation static methods marked with OnClassLoad are invoked
  - shutdown
```
void shutdown()
```
    Notifies all script classes that they must save their data and release resources to prevent memory leaks. It's done via static methods with OnClassUnload annotation
  - reload
```
void reload()
```
    Invokes shutdown(), after that invokes init(). Root folder remains the same, but new compiler and classloader are used.
  - getRoot
```
File getRoot()
```
    Returns the root directory for script engine. Only one script engine per root directory is allowed.
    
    Returns:
    
    root directory for script engine
  - getCompilationResult
```
CompilationResult getCompilationResult()
```
    Returns compilation result of this script context
    
    Returns:
    
    compilation result
  - isInitialized
```
boolean isInitialized()
```
    Returns true if this script context is loaded
    
    Returns:
    
    true if context is initialized
  - setLibraries
```
void setLibraries(Iterable<File> files)
```
    Sets files that represents jar files, they will be used as libraries
    
    Parameters:
    
    files - that points to jar file, will be used as libraries
  - getLibraries
```
Iterable<File> getLibraries()
```
    Returns list of files that are used as libraries for this script context
    
    Returns:
    
    list of libraries
  - getParentScriptContext
```
ScriptContext getParentScriptContext()
```
    Returns parent script context of this context. Returns null if none.
    
    Returns:
    
    parent Script context of this context or null
  - getChildScriptContexts
```
Collection<ScriptContext> getChildScriptContexts()
```
    Returns list of child contexts or null if no contextes present
    
    Returns:
    
    list of child contexts or null
  - addChildScriptContext
```
void addChildScriptContext(ScriptContext context)
```
    Adds child contexts to this context. If this context is initialized - chiled context will be initialized immideatly. In other case child context will be just added and initialized when init() would be called. Duplicated child contexts are not allowed, in such case child will be ignored
    
    Parameters:
    
    context - child context
  - setClassListener
```
void setClassListener(ClassListener cl)
```
    Sets the class listener for this script context.
    
    Parameters:
    
    cl - class listener
  - getClassListener
```
ClassListener getClassListener()
```
    Returns class listener associated with this ScriptContext.
    If it's null - returns parent classListener.
    If parent is null and classListener is null - it will add the following class listeners as default implementation (order saved):
```
 AggregatedClassListener acl = new AggregatedClassListener();
 acl.addClassListener(new OnClassLoadUnloadListener());
 acl.addClassListener(new ScheduledTaskClassListener());
 
```
    Returns:
    
    Associated class listener
    
    See Also:
    
    AggregatedClassListener, ScheduledTaskClassListener
  - setCompilerClassName
```
void setCompilerClassName(String className)
```
    Sets compiler class name for this script context.
    Compiler is not inherrited by children.
    
    Parameters:
    
    className - compiler class name
  - getCompilerClassName
```
String getCompilerClassName()
```
    Returns compiler class name that will be used for this script context.
    
    Returns:
    
    compiler class name that will be used for tis script context
  - equals
```
boolean equals(Object obj)
```
    Tests if this ScriptContext is equal to another ScriptContext. Comparation is done by comparing root files and parent contexts (if there is any parent)
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - object to compare with
    
    Returns:
    
    result of comparation
  - hashCode
```
int hashCode()
```
    Returns hashCoded of this ScriptContext. Hashcode is calculated using root file and parent context(if available)
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode
  - finalize
```
void finalize()
       throws Throwable
```
    This method overrides finalization to ensure that active script context will not be collected by GC. If such situation happens - shutdown() is called to ensure that resources were released.
    
    Throws:
    
    Throwable - if something goes wrong during finalization

Interface ScriptContext

Method Summary

Method Detail

init

shutdown

reload

getRoot

getCompilationResult

isInitialized

setLibraries

getLibraries

getParentScriptContext

getChildScriptContexts

addChildScriptContext

setClassListener

getClassListener

setCompilerClassName

getCompilerClassName

equals

hashCode

finalize