org.kohsuke.stapler

Class AbstractTearOff<CLT,S,E extends java.lang.Exception>

java.lang.Object

org.kohsuke.stapler.CachingScriptLoader<S,E>

org.kohsuke.stapler.AbstractTearOff<CLT,S,E>

Type Parameters:

CLT - ClassLoader tear-off.

Direct Known Subclasses:

GroovyClassTearOff, GroovyServerPageTearOff, JellyClassTearOff

public abstract class AbstractTearOff<CLT,S,E extends java.lang.Exception>
extends CachingScriptLoader<S,E>

Partial default implementation of tear-off class, for convenience of derived classes.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field and Description
protected CLT	classLoader
protected MetaClass	owner

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTearOff(MetaClass owner, java.lang.Class<CLT> cltClass)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract java.lang.String	getDefaultScriptExtension() The file extension of this kind of scripts, such as ".jelly"
protected java.net.URL	getResource(java.lang.String name)
protected WebApp	getWebApp()
protected boolean	hasAllowedExtension(java.lang.String name) Checks if the file name is allowed as a script of this type.
protected S	loadScript(java.lang.String name) Cache-less version of the CachingScriptLoader.findScript(String) that provides the actual logic.
protected abstract S	parseScript(java.net.URL res) Compiles a script into the compiled form.
S	resolveScript(java.lang.String name) Loads the script just from the target class without considering inherited scripts from its base types.

Methods inherited from class org.kohsuke.stapler.CachingScriptLoader

clearScripts, findScript

Methods inherited from class java.lang.Object

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

Field Detail

owner

protected final MetaClass owner

classLoader

protected final CLT classLoader

Constructor Detail

AbstractTearOff

protected AbstractTearOff(MetaClass owner,
               java.lang.Class<CLT> cltClass)

Method Detail

getWebApp

protected final WebApp getWebApp()

getDefaultScriptExtension

protected abstract java.lang.String getDefaultScriptExtension()

The file extension of this kind of scripts, such as ".jelly"

hasAllowedExtension

protected boolean hasAllowedExtension(java.lang.String name)

Checks if the file name is allowed as a script of this type. This is necessary to have multiple facets co-exist peacefully without them trying to load each other's scripts.

resolveScript

public S resolveScript(java.lang.String name)
                throws E extends java.lang.Exception

Loads the script just from the target class without considering inherited scripts from its base types.

Throws:

E extends java.lang.Exception

loadScript

protected final S loadScript(java.lang.String name)
                      throws E extends java.lang.Exception

Description copied from class: CachingScriptLoader

Cache-less version of the CachingScriptLoader.findScript(String) that provides the actual logic.

Specified by:

loadScript in class CachingScriptLoader<S,E extends java.lang.Exception>

Throws:

E extends java.lang.Exception

parseScript

protected abstract S parseScript(java.net.URL res)
                          throws E extends java.lang.Exception

Compiles a script into the compiled form.

Throws:

E extends java.lang.Exception

getResource

protected java.net.URL getResource(java.lang.String name)

Specified by:

getResource in class CachingScriptLoader<S,E extends java.lang.Exception>