org.forgerock.script.source

Class EmbeddedScriptSource

java.lang.Object

org.forgerock.script.source.EmbeddedScriptSource

All Implemented Interfaces:

ScriptSource, SourceUnit

public class EmbeddedScriptSource
extends Object
implements ScriptSource

A script whose source is not in a file, or resource, but embedded in configuration string, database entry, or other "in-line" entity.

Field Summary

Fields inherited from interface org.forgerock.script.source.SourceUnit

ATTR_NAME, ATTR_REQUEST_BINDING, ATTR_REVISION, ATTR_SOURCE, ATTR_TYPE, ATTR_VISIBILITY, AUTO_DETECT

Constructor Summary

Constructors

Constructor and Description
EmbeddedScriptSource(ScriptEntry.Visibility visibility, String source, ScriptName scriptName)
EmbeddedScriptSource(String source, ScriptName scriptName)

Method Summary

Modifier and Type	Method and Description
ScriptName[]	getDependencies()
ScriptName	getName()
SourceContainer	getParentContainer() Get the parent container if there is one.
Reader	getReader() Returns a new Reader on the underlying source object.
URL	getSource()
URI	getSourceURI()
ScriptEntry.Visibility	getVisibility()
String	guessType()

Methods inherited from class java.lang.Object

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

Constructor Detail

EmbeddedScriptSource

public EmbeddedScriptSource(String source,
                            ScriptName scriptName)

EmbeddedScriptSource

public EmbeddedScriptSource(ScriptEntry.Visibility visibility,
                            String source,
                            ScriptName scriptName)

Method Detail

guessType

public String guessType()

Specified by:

guessType in interface ScriptSource

getSource

public URL getSource()

Specified by:

getSource in interface SourceUnit

getSourceURI

public URI getSourceURI()

Specified by:

getSourceURI in interface SourceUnit

getReader

public Reader getReader()
                 throws IOException

Description copied from interface: ScriptSource

Returns a new Reader on the underlying source object. Returns null if the source can't be reopened.

Specified by:

getReader in interface ScriptSource

Returns:

the reader to the resource

Throws:

IOException - if there was an error opening for stream

getName

public ScriptName getName()

Specified by:

getName in interface SourceUnit

getVisibility

public ScriptEntry.Visibility getVisibility()

Specified by:

getVisibility in interface SourceUnit

getDependencies

public ScriptName[] getDependencies()

Specified by:

getDependencies in interface ScriptSource

Returns:

getParentContainer

public SourceContainer getParentContainer()

Description copied from interface: SourceUnit

Get the parent container if there is one.

Specified by:

getParentContainer in interface SourceUnit

Returns:

the parent container where this instance belongs to, or null if there is no parent.