ScriptContextImpl (ChRL - Rebellion Scripting 1.0.0 API)

java.lang.Object
- at.chrl.rebellion.scripting.impl.ScriptContextImpl

All Implemented Interfaces:

ScriptContext
```
public class ScriptContextImpl
extends Object
implements ScriptContext
```
This class is actual implementation of ScriptContext

Author:

SoulKeeper

Constructor Summary

Constructors
Constructor and Description
`ScriptContextImpl(File root)` Creates new scriptcontext with given root file
`ScriptContextImpl(File root, ScriptContext parent)` Creates new ScriptContext with given file as root and another ScriptContext as parent

Method Summary

All Methods Instance Methods Concrete 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.
`protected ScriptCompiler`	`instantiateCompiler()` Creates new instance of ScriptCompiler that should be used with this ScriptContext
`boolean`	`isInitialized()` Returns true if this script context is loaded
`void`	`reload()` Invokes `ScriptContext.shutdown()`, after that invokes `ScriptContext.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.

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

- Constructor Detail
  - ScriptContextImpl
```
public ScriptContextImpl(File root)
```
    Creates new scriptcontext with given root file
    
    Parameters:
    
    root - file that represents root directory of this script context
    
    Throws:
    
    NullPointerException - if root is null
    
    IllegalArgumentException - if root directory doesn't exists or is not a directory
  - ScriptContextImpl
```
public ScriptContextImpl(File root,
                         ScriptContext parent)
```
    Creates new ScriptContext with given file as root and another ScriptContext as parent
    
    Parameters:
    
    root - file that represents root directory of this script context
    
    parent - parent ScriptContex. It's classes and libraries will be accessible for this script context
    
    Throws:
    
    NullPointerException - if root is null
    
    IllegalArgumentException - if root directory doesn't exists or is not a directory
- Method Detail
  - init
```
public void init()
```
    Initializes script context. Calls the compilation task.
    After compilation static methods marked with OnClassLoad are invoked
    
    Specified by:
    
    init in interface ScriptContext
  - shutdown
```
public 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
    
    Specified by:
    
    shutdown in interface ScriptContext
  - reload
```
public void reload()
```
    Invokes ScriptContext.shutdown(), after that invokes ScriptContext.init(). Root folder remains the same, but new compiler and classloader are used.
    
    Specified by:
    
    reload in interface ScriptContext
  - getRoot
```
public File getRoot()
```
    Returns the root directory for script engine. Only one script engine per root directory is allowed.
    
    Specified by:
    
    getRoot in interface ScriptContext
    
    Returns:
    
    root directory for script engine
  - getCompilationResult
```
public CompilationResult getCompilationResult()
```
    Returns compilation result of this script context
    
    Specified by:
    
    getCompilationResult in interface ScriptContext
    
    Returns:
    
    compilation result
  - isInitialized
```
public boolean isInitialized()
```
    Returns true if this script context is loaded
    
    Specified by:
    
    isInitialized in interface ScriptContext
    
    Returns:
    
    true if context is initialized
  - setLibraries
```
public void setLibraries(Iterable<File> files)
```
    Sets files that represents jar files, they will be used as libraries
    
    Specified by:
    
    setLibraries in interface ScriptContext
    
    Parameters:
    
    files - that points to jar file, will be used as libraries
  - getLibraries
```
public Iterable<File> getLibraries()
```
    Returns list of files that are used as libraries for this script context
    
    Specified by:
    
    getLibraries in interface ScriptContext
    
    Returns:
    
    list of libraries
  - getParentScriptContext
```
public ScriptContext getParentScriptContext()
```
    Returns parent script context of this context. Returns null if none.
    
    Specified by:
    
    getParentScriptContext in interface ScriptContext
    
    Returns:
    
    parent Script context of this context or null
  - getChildScriptContexts
```
public Collection<ScriptContext> getChildScriptContexts()
```
    Returns list of child contexts or null if no contextes present
    
    Specified by:
    
    getChildScriptContexts in interface ScriptContext
    
    Returns:
    
    list of child contexts or null
  - addChildScriptContext
```
public 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 ScriptContext.init() would be called. Duplicated child contexts are not allowed, in such case child will be ignored
    
    Specified by:
    
    addChildScriptContext in interface ScriptContext
    
    Parameters:
    
    context - child context
  - setClassListener
```
public void setClassListener(ClassListener cl)
```
    Sets the class listener for this script context.
    
    Specified by:
    
    setClassListener in interface ScriptContext
    
    Parameters:
    
    cl - class listener
  - getClassListener
```
public 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());
 
```
    Specified by:
    
    getClassListener in interface ScriptContext
    
    Returns:
    
    Associated class listener
    
    See Also:
    
    AggregatedClassListener, ScheduledTaskClassListener
  - setCompilerClassName
```
public void setCompilerClassName(String className)
```
    Sets compiler class name for this script context.
    Compiler is not inherrited by children.
    
    Specified by:
    
    setCompilerClassName in interface ScriptContext
    
    Parameters:
    
    className - compiler class name
  - getCompilerClassName
```
public String getCompilerClassName()
```
    Returns compiler class name that will be used for this script context.
    
    Specified by:
    
    getCompilerClassName in interface ScriptContext
    
    Returns:
    
    compiler class name that will be used for tis script context
  - instantiateCompiler
```
protected ScriptCompiler instantiateCompiler()
                                      throws RuntimeException
```
    Creates new instance of ScriptCompiler that should be used with this ScriptContext
    
    Returns:
    
    instance of ScriptCompiler
    
    Throws:
    
    RuntimeException - if failed to create instance
  - equals
```
public 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)
    
    Specified by:
    
    equals in interface ScriptContext
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - object to compare with
    
    Returns:
    
    result of comparation
  - hashCode
```
public int hashCode()
```
    Returns hashCoded of this ScriptContext. Hashcode is calculated using root file and parent context(if available)
    
    Specified by:
    
    hashCode in interface ScriptContext
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode
  - finalize
```
public void finalize()
              throws Throwable
```
    This method overrides finalization to ensure that active script context will not be collected by GC. If such situation happens - ScriptContext.shutdown() is called to ensure that resources were released.
    
    Specified by:
    
    finalize in interface ScriptContext
    
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable - if something goes wrong during finalization

Class ScriptContextImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ScriptContextImpl

ScriptContextImpl

Method Detail

init

shutdown

reload

getRoot

getCompilationResult

isInitialized

setLibraries

getLibraries

getParentScriptContext

getChildScriptContexts

addChildScriptContext

setClassListener

getClassListener

setCompilerClassName

getCompilerClassName

instantiateCompiler

equals

hashCode

finalize