org.scijava.script.process

Class DirectiveScriptProcessor

java.lang.Object

org.scijava.script.process.DirectiveScriptProcessor

All Implemented Interfaces:

SciJavaPlugin, ScriptProcessor

Direct Known Subclasses:

ScriptDirectiveScriptProcessor

public abstract class DirectiveScriptProcessor
extends Object
implements ScriptProcessor

Abstract base class for ScriptProcessor plugins that parse lines of the form #@directive(...) ....

Author:

Curtis Rueden

Constructor Summary

Constructors

Constructor and Description
DirectiveScriptProcessor(Predicate<String> directivesToMatch)

Method Summary

Modifier and Type	Method and Description
protected <T> T	as(Object v, Class<T> type) Coerces some object into another object of the given type.
protected <T> List<T>	asList(Object v, Class<T> type) Coerces some object into a list of objects of the given type.
void	begin(ScriptInfo scriptInfo)
protected ScriptInfo	info() Gets the active ScriptInfo instance.
protected boolean	is(String key, String desired) Checks whether some key matches the desired value, ignoring case.
String	process(String line)
protected abstract String	process(String directive, Map<String,Object> attrs, String theRest) Processes the given directive.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scijava.script.process.ScriptProcessor

end

Constructor Detail

DirectiveScriptProcessor

public DirectiveScriptProcessor(Predicate<String> directivesToMatch)

Method Detail

begin

public void begin(ScriptInfo scriptInfo)

Specified by:

begin in interface ScriptProcessor

process

public String process(String line)

Specified by:

process in interface ScriptProcessor

process

protected abstract String process(String directive,
                                  Map<String,Object> attrs,
                                  String theRest)

Processes the given directive.

info

protected ScriptInfo info()

Gets the active ScriptInfo instance.

is

protected boolean is(String key,
                     String desired)

Checks whether some key matches the desired value, ignoring case.

as

protected <T> T as(Object v,
                   Class<T> type)

Coerces some object into another object of the given type.

asList

protected <T> List<T> asList(Object v,
                             Class<T> type)

Coerces some object into a list of objects of the given type.