org.esa.snap.ui.tooladapter.model

Class CustomParameterClass

java.lang.Object

org.esa.snap.ui.tooladapter.model.CustomParameterClass

public class CustomParameterClass
extends Object

Enum-like class holding the possible types of operator parameters

Field Summary

Fields

Modifier and Type	Field and Description
static CustomParameterClass	AfterTemplateFileClass Represents a template file that is supposed to be executed after the actual tool execution
static CustomParameterClass	BeforeTemplateFileClass Represents a template file that is supposed to be executed before the actual tool execution
static CustomParameterClass	BooleanClass Represents a boolean parameter
static CustomParameterClass	FileListClass Represents a file list parameter
static CustomParameterClass	FloatClass Represents a float parameter
static CustomParameterClass	IntegerClass Represents an integer parameter
static CustomParameterClass	ListClass Represents a string list parameter
static CustomParameterClass	RegularFileClass Represents a file parameter
static CustomParameterClass	StringClass Represents a string/text parameter
static CustomParameterClass	TemplateFileClass Represents a the template file of the actual tool execution

Method Summary

Modifier and Type	Method and Description
static CustomParameterClass	getObject(Class<?> aClass, String typeMask) Returns the CustomParameterClass instance matching the given type mask
Class<?>	getParameterClass()
String	getTypeMask() Returns the type mask of the parameter
boolean	isParameter() Checks if the parameter is a regular parameter
boolean	isTemplateAfter() Checks if the parameter is a template-after parameter
boolean	isTemplateBefore() Checks if the parameter is a template-before parameter
boolean	isTemplateParameter() Checks if the parameter is a template parameter

Methods inherited from class java.lang.Object

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

Field Detail

BeforeTemplateFileClass

public static final CustomParameterClass BeforeTemplateFileClass

Represents a template file that is supposed to be executed before the actual tool execution

AfterTemplateFileClass

public static final CustomParameterClass AfterTemplateFileClass

Represents a template file that is supposed to be executed after the actual tool execution

TemplateFileClass

public static final CustomParameterClass TemplateFileClass

Represents a the template file of the actual tool execution

RegularFileClass

public static final CustomParameterClass RegularFileClass

Represents a file parameter

FileListClass

public static final CustomParameterClass FileListClass

Represents a file list parameter

StringClass

public static final CustomParameterClass StringClass

Represents a string/text parameter

IntegerClass

public static final CustomParameterClass IntegerClass

Represents an integer parameter

ListClass

public static final CustomParameterClass ListClass

Represents a string list parameter

BooleanClass

public static final CustomParameterClass BooleanClass

Represents a boolean parameter

FloatClass

public static final CustomParameterClass FloatClass

Represents a float parameter

Method Detail

getParameterClass

public Class<?> getParameterClass()

Returns:

The Java class of the parameter

isTemplateParameter

public boolean isTemplateParameter()

Checks if the parameter is a template parameter

isTemplateBefore

public boolean isTemplateBefore()

Checks if the parameter is a template-before parameter

isTemplateAfter

public boolean isTemplateAfter()

Checks if the parameter is a template-after parameter

isParameter

public boolean isParameter()

Checks if the parameter is a regular parameter

getTypeMask

public String getTypeMask()

Returns the type mask of the parameter

getObject

public static CustomParameterClass getObject(Class<?> aClass,
                                             String typeMask)

Returns the CustomParameterClass instance matching the given type mask