org.xul.script.scripts

Class AbstractScriptFactory<S>

java.lang.Object

org.xul.script.scripts.AbstractScriptFactory<S>

Type Parameters:

S - the Script interface

All Implemented Interfaces:

ScriptFactory

Direct Known Subclasses:

DefaultScriptFactory

public abstract class AbstractScriptFactory<S>
extends java.lang.Object
implements ScriptFactory

Factory for scripts.

Since:

1.1

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.ClassLoader	classLoader The ClassLoader.
protected XULScriptContext	context The XULScriptContext.
protected org.scripthelper.exceptions.ScriptExceptionListener	exceptionListener The ScriptExceptionListener.
protected java.util.Map<java.lang.Class<?>,ScriptLanguageFactory<?>>	langFactories The ScriptLanguageFactory.
protected org.scripthelper.context.ScriptLogger	scriptLogger The ScriptLogger.

Constructor Summary

Constructors

Constructor and Description
AbstractScriptFactory()

Method Summary

Modifier and Type	Method and Description
ScriptHandle	addScript(short scriptType, XULDocument document, org.scripthelper.model.ScriptSource source) Add a script.
ScriptHandle	addScript(XULDocument document, org.scripthelper.model.ScriptSource source) Add a script.
void	addScriptToDocuments(ScriptHandle script) Add a script to all XUL documents.
void	addScriptToXUL(java.net.URL url, XULDocument doc) Add a script to a XUL document.
boolean	containsScript(org.scripthelper.model.ScriptSource source) Return true if the factory contains a ScriptSource.
java.lang.ClassLoader	getClassLoader() Return the classLoader to use to load the script classes
java.util.Set<java.lang.Class<?>>	getInterfaces() Return the Set of script interfaces which are handled by this factory.
ScriptHandle	getScript(org.scripthelper.model.ScriptSource source) Return the script associated with a source.
XULScriptContext	getScriptContext() Return the script context.
org.scripthelper.exceptions.ScriptExceptionListener	getScriptExceptionListener() Return the script exception listener.
org.scripthelper.context.ScriptLogger	getScriptLogger() Return the script logger.
java.util.Map<org.scripthelper.model.ScriptSource,ScriptHandle>	getScripts() Return the scripts.
protected short	getScriptType(org.scripthelper.model.ScriptSource source) Return the script type for a script source.
boolean	hasScript(java.lang.String name) Return true if the factory has a script of a specified name.
ScriptHandle	removeScript(org.scripthelper.model.ScriptSource source) Removed a script.
void	setClassLoader(java.lang.ClassLoader classLoader) Set the classLoader to use to load the script classes.
void	setScriptContext(XULScriptContext context) Set the global script context used by all scripts.
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

Methods inherited from interface org.xul.script.scripts.ScriptFactory

createScriptLanguageFactory, createScriptLanguageFactoryImpl

Field Detail

langFactories

protected java.util.Map<java.lang.Class<?>,ScriptLanguageFactory<?>> langFactories

The ScriptLanguageFactory.

context

protected XULScriptContext context

The XULScriptContext.

exceptionListener

protected org.scripthelper.exceptions.ScriptExceptionListener exceptionListener

The ScriptExceptionListener.

scriptLogger

protected org.scripthelper.context.ScriptLogger scriptLogger

The ScriptLogger.

classLoader

protected java.lang.ClassLoader classLoader

The ClassLoader.

Constructor Detail

AbstractScriptFactory

public AbstractScriptFactory()

Method Detail

setClassLoader

public void setClassLoader(java.lang.ClassLoader classLoader)

Set the classLoader to use to load the script classes.

Specified by:

setClassLoader in interface ScriptFactory

Parameters:

classLoader - the classLoader

getClassLoader

public java.lang.ClassLoader getClassLoader()

Return the classLoader to use to load the script classes

Specified by:

getClassLoader in interface ScriptFactory

Returns:

classLoader the classLoader

setScriptContext

public void setScriptContext(XULScriptContext context)

Set the global script context used by all scripts.

Specified by:

setScriptContext in interface ScriptFactory

Parameters:

context - the global script context

getScriptContext

public XULScriptContext getScriptContext()

Return the script context.

Specified by:

getScriptContext in interface ScriptFactory

Returns:

the script context

setScriptExceptionListener

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

Set the script exception listener.

Specified by:

setScriptExceptionListener in interface ScriptFactory

Parameters:

exceptionListener - the script exception listener

getScriptExceptionListener

public org.scripthelper.exceptions.ScriptExceptionListener getScriptExceptionListener()

Return the script exception listener.

Specified by:

getScriptExceptionListener in interface ScriptFactory

Returns:

the script exception listener

setScriptLogger

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

Set the script logger.

Specified by:

setScriptLogger in interface ScriptFactory

Parameters:

scriptLogger - the script logger

getScriptLogger

public org.scripthelper.context.ScriptLogger getScriptLogger()

Return the script logger.

Specified by:

getScriptLogger in interface ScriptFactory

Returns:

the script logger

getScripts

public java.util.Map<org.scripthelper.model.ScriptSource,ScriptHandle> getScripts()

Return the scripts.

Specified by:

getScripts in interface ScriptFactory

Returns:

the scripts

getInterfaces

public java.util.Set<java.lang.Class<?>> getInterfaces()

Return the Set of script interfaces which are handled by this factory.

Specified by:

getInterfaces in interface ScriptFactory

Returns:

the Set of script interfaces

addScriptToXUL

public void addScriptToXUL(java.net.URL url,
                           XULDocument doc)

Add a script to a XUL document.

Specified by:

addScriptToXUL in interface ScriptFactory

Parameters:

url - the script

doc - the XUL document

getScript

public ScriptHandle getScript(org.scripthelper.model.ScriptSource source)

Return the script associated with a source.

Specified by:

getScript in interface ScriptFactory

Parameters:

source - the ScriptSource

Returns:

the script

containsScript

public boolean containsScript(org.scripthelper.model.ScriptSource source)

Return true if the factory contains a ScriptSource.

Specified by:

containsScript in interface ScriptFactory

Parameters:

source - the ScriptSource

Returns:

true if the factory contains the ScriptSource

removeScript

public ScriptHandle removeScript(org.scripthelper.model.ScriptSource source)

Removed a script.

Specified by:

removeScript in interface ScriptFactory

Parameters:

source - the ScriptSource

Returns:

the ScriptHandle which corresponded to the source

addScriptToDocuments

public void addScriptToDocuments(ScriptHandle script)

Add a script to all XUL documents.

Specified by:

addScriptToDocuments in interface ScriptFactory

Parameters:

script - the script handle

getScriptType

protected short getScriptType(org.scripthelper.model.ScriptSource source)

Return the script type for a script source.

Parameters:

source - the ScriptSource

Returns:

the script type

addScript

public ScriptHandle addScript(XULDocument document,
                              org.scripthelper.model.ScriptSource source)

Add a script. The factory will try to infer the MIME from the source file name.

Specified by:

addScript in interface ScriptFactory

Parameters:

document - the XULDocument

source - the script source

Returns:

the script handle

addScript

public ScriptHandle addScript(short scriptType,
                              XULDocument document,
                              org.scripthelper.model.ScriptSource source)

Add a script.

Specified by:

addScript in interface ScriptFactory

Parameters:

scriptType - the script type

document - the XULDocument

source - the script source

Returns:

the script handle

hasScript

public boolean hasScript(java.lang.String name)

Return true if the factory has a script of a specified name.

Specified by:

hasScript in interface ScriptFactory

Parameters:

name - the script name

Returns:

true if the factory has a script of the specified name