org.hkijena.jipipe.plugins.parameters.api.scripts

Class ScriptParameter

java.lang.Object

org.hkijena.jipipe.plugins.parameters.api.scripts.ScriptParameter

Direct Known Subclasses:

ImageJMacro, OpenCLKernelScript, PythonScript, RScriptParameter

public abstract class ScriptParameter
extends Object

A parameter that contains some kind of script

Constructor Summary

Constructors

Constructor and Description
ScriptParameter() Creates a new empty code
ScriptParameter(ScriptParameter other) Copies the code

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getCode()
String	getCode(Path workDirectory) Gets the code.
abstract String	getExtension() Returns the default extension for this script
OptionalPathParameter	getExternalScriptFile()
abstract org.scijava.script.ScriptLanguage	getLanguage() The language info.
abstract String	getLanguageName() Returns the human-readable name of the language
abstract String	getMimeType() Returns the MIME type of this script
int	hashCode()
boolean	isCollapsed()
void	makeExternalScriptFileRelative(Path workDirectory) Converts the external script file reference into a relative path
void	setCode(String code)
void	setCollapsed(boolean collapsed)
void	setExternalScriptFile(OptionalPathParameter externalScriptFile)

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptParameter

public ScriptParameter()

Creates a new empty code

ScriptParameter

public ScriptParameter(ScriptParameter other)

Copies the code

Parameters:

other - the original

Method Detail

getCode

public String getCode()

setCode

public void setCode(String code)

getCode

public String getCode(Path workDirectory)

Gets the code. Supports relative external script paths

Parameters:

workDirectory - the work directory

Returns:

the code

makeExternalScriptFileRelative

public void makeExternalScriptFileRelative(Path workDirectory)

Converts the external script file reference into a relative path

Parameters:

workDirectory - the current work directory

getMimeType

public abstract String getMimeType()

Returns the MIME type of this script

Returns:

the MIME type of this script

getLanguageName

public abstract String getLanguageName()

Returns the human-readable name of the language

Returns:

the human-readable name of the language

getExtension

public abstract String getExtension()

Returns the default extension for this script

Returns:

the default extension (including the dot)

isCollapsed

public boolean isCollapsed()

setCollapsed

public void setCollapsed(boolean collapsed)

getExternalScriptFile

public OptionalPathParameter getExternalScriptFile()

setExternalScriptFile

public void setExternalScriptFile(OptionalPathParameter externalScriptFile)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getLanguage

public abstract org.scijava.script.ScriptLanguage getLanguage()

The language info. Optional.

Returns:

The language info