org.xul.script.scripts.lang

Class AbstractScriptLanguageFactory<S>

java.lang.Object

org.xul.script.scripts.lang.AbstractScriptLanguageFactory<S>

Type Parameters:

S - the Script interface

All Implemented Interfaces:

ScriptLanguageFactory<S>

Direct Known Subclasses:

DefaultScriptLanguageFactory

public abstract class AbstractScriptLanguageFactory<S>
extends java.lang.Object
implements ScriptLanguageFactory<S>

Factory for scripts.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractScriptLanguageFactory.BuilderCreator The BuilderCreator class allows to create ScriptBuilders.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.Short,java.lang.Class<ScriptBuilder>>	builderClasses The Map of ScriptBuilder classes for each script type.
protected org.scripthelper.context.ScriptContext	context The ScriptContext.
protected org.scripthelper.exceptions.ScriptExceptionListener	exceptionListener The Script ExceptionListener.
protected java.lang.ClassLoader	loader The ClassLoader.
protected org.scripthelper.context.ScriptLogger	logger The script logger.
protected java.util.Map<java.lang.Short,java.lang.Boolean>	scriptSupported The Map of mimes and their support in the factory.
protected java.util.Map<java.lang.Short,java.lang.Class<org.scripthelper.model.ScriptWrapper<S>>>	wrapperClasses The Map of ScriptWrapper classes for each script type.

Constructor Summary

Constructors

Constructor and Description
AbstractScriptLanguageFactory()

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.Class<ScriptBuilder>	createBuilderClass(short scriptType) Create the builder class for a specified MIME type.
protected java.lang.Class<ScriptBuilder>	createBuilderClassImpl(java.lang.String path) Create the builder class at the specified path.
org.scripthelper.model.ScriptWrapper<S>	createScript(short scriptType) Create a script wrapper.
org.scripthelper.model.ScriptWrapper	createScriptWrapper(short scriptType, org.scripthelper.js.JSScriptable scriptable) Create a script wrapper.
protected java.lang.Class<ScriptBuilder>	getBuilderClass(short scriptType) Return the builder class for a MIME type.
org.scripthelper.context.ScriptContext	getScriptContext() Return the script context.
org.scripthelper.exceptions.ScriptExceptionListener	getScriptExceptionListener() Return the script exception listener.
java.lang.Class<S>	getScriptInterface() Return the class of the associated script interface.
org.scripthelper.context.ScriptLogger	getScriptLogger() Return the script logger.
boolean	isScriptSupported(short scriptType) Return true if the MIME type is supported.
protected boolean	isSupported(short scriptType, java.lang.String libPath) Return true if the builder at a specified buildpath support specified scripts.
void	setClassLoader(java.lang.ClassLoader loader) Set the ClassLoader
void	setScriptContext(org.scripthelper.context.ScriptContext context) Set the script context.
void	setScriptExceptionListener(org.scripthelper.exceptions.ScriptExceptionListener exceptionListener) Set the script exception listener.
void	setScriptLogger(org.scripthelper.context.ScriptLogger scriptLogger) Set the script logger.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

scriptSupported

protected final java.util.Map<java.lang.Short,java.lang.Boolean> scriptSupported

The Map of mimes and their support in the factory.

loader

protected java.lang.ClassLoader loader

The ClassLoader.

wrapperClasses

protected final java.util.Map<java.lang.Short,java.lang.Class<org.scripthelper.model.ScriptWrapper<S>>> wrapperClasses

The Map of ScriptWrapper classes for each script type.

builderClasses

protected final java.util.Map<java.lang.Short,java.lang.Class<ScriptBuilder>> builderClasses

The Map of ScriptBuilder classes for each script type.

context

protected org.scripthelper.context.ScriptContext context

The ScriptContext.

exceptionListener

protected org.scripthelper.exceptions.ScriptExceptionListener exceptionListener

The Script ExceptionListener.

logger

protected org.scripthelper.context.ScriptLogger logger

The script logger.

Constructor Detail

AbstractScriptLanguageFactory

public AbstractScriptLanguageFactory()

Method Detail

setClassLoader

public void setClassLoader(java.lang.ClassLoader loader)

Set the ClassLoader

Specified by:

setClassLoader in interface ScriptLanguageFactory<S>

Parameters:

loader - the ClassLoader

setScriptExceptionListener

public void setScriptExceptionListener(org.scripthelper.exceptions.ScriptExceptionListener exceptionListener)

Set the script exception listener.

Specified by:

setScriptExceptionListener in interface ScriptLanguageFactory<S>

Parameters:

exceptionListener - the script exception listener

getScriptExceptionListener

public org.scripthelper.exceptions.ScriptExceptionListener getScriptExceptionListener()

Return the script exception listener.

Specified by:

getScriptExceptionListener in interface ScriptLanguageFactory<S>

Returns:

the script exception listener

setScriptLogger

public void setScriptLogger(org.scripthelper.context.ScriptLogger scriptLogger)

Set the script logger.

Specified by:

setScriptLogger in interface ScriptLanguageFactory<S>

Parameters:

scriptLogger - the script logger

getScriptLogger

public org.scripthelper.context.ScriptLogger getScriptLogger()

Return the script logger.

Specified by:

getScriptLogger in interface ScriptLanguageFactory<S>

Returns:

the script logger

setScriptContext

public void setScriptContext(org.scripthelper.context.ScriptContext context)

Set the script context.

Specified by:

setScriptContext in interface ScriptLanguageFactory<S>

Parameters:

context - the script context

getScriptContext

public org.scripthelper.context.ScriptContext getScriptContext()

Return the script context.

Specified by:

getScriptContext in interface ScriptLanguageFactory<S>

Returns:

the script context

getScriptInterface

public java.lang.Class<S> getScriptInterface()

Return the class of the associated script interface.

Specified by:

getScriptInterface in interface ScriptLanguageFactory<S>

Returns:

the class of the associated script interface

createScript

public org.scripthelper.model.ScriptWrapper<S> createScript(short scriptType)

Create a script wrapper.

Specified by:

createScript in interface ScriptLanguageFactory<S>

Parameters:

scriptType - the script type

Returns:

the ScriptWrapper

isSupported

protected boolean isSupported(short scriptType,
                              java.lang.String libPath)

Return true if the builder at a specified buildpath support specified scripts.

Parameters:

scriptType - the script type

libPath - the builder path

Returns:

true if the builder at the specified buildpath support scripts with a specified MIME

createBuilderClassImpl

protected java.lang.Class<ScriptBuilder> createBuilderClassImpl(java.lang.String path)

Create the builder class at the specified path.

Parameters:

path - the path

Returns:

the builder class

getBuilderClass

protected java.lang.Class<ScriptBuilder> getBuilderClass(short scriptType)

Return the builder class for a MIME type.

Parameters:

scriptType - the script type

Returns:

the builder class

createScriptWrapper

public org.scripthelper.model.ScriptWrapper createScriptWrapper(short scriptType,
                                                                org.scripthelper.js.JSScriptable scriptable)

Create a script wrapper. Note that we can't add the generic tag on the return type, else the class would not compile.

Specified by:

createScriptWrapper in interface ScriptLanguageFactory<S>

Parameters:

scriptType - the script type

scriptable - the JSScriptable (u=only used for Javascript scripts)

Returns:

the ScriptWrapper

createBuilderClass

protected abstract java.lang.Class<ScriptBuilder> createBuilderClass(short scriptType)

Create the builder class for a specified MIME type.

Parameters:

scriptType - the script type

Returns:

the builder class

isScriptSupported

public boolean isScriptSupported(short scriptType)

Return true if the MIME type is supported. It will also try to crete the associated builder class if the MIME type is supported. The class maintains a Map of builder classes for each supported MIME type to avoid to create a new builder each time a new script has to ce created.

Specified by:

isScriptSupported in interface ScriptLanguageFactory<S>

Parameters:

scriptType - the script type

Returns:

true if the script type is supported