org.hkijena.jipipe.extensions.parameters.api.functions

Class FunctionParameterParameterAccess<I,P,O>

java.lang.Object

org.hkijena.jipipe.extensions.parameters.api.functions.FunctionParameterParameterAccess<I,P,O>

Type Parameters:

I - input type

P - parameter type

O - output type

All Implemented Interfaces:

JIPipeParameterAccess

public class FunctionParameterParameterAccess<I,P,O>
extends Object
implements JIPipeParameterAccess

Access to a FunctionParameter parameter

Constructor Summary

Constructors

Constructor and Description
FunctionParameterParameterAccess(JIPipeParameterAccess parent)

Method Summary

Modifier and Type	Method and Description
<T> T	get(Class<T> klass) Gets the parameter value
<T extends Annotation> T	getAnnotationOfType(Class<T> klass) Gets an annotation for this parameter
Collection<Annotation>	getAnnotations() Gets all available annotations for this parameter
<T extends Annotation> List<T>	getAnnotationsOfType(Class<T> klass) Gets annotations for this parameter (including the field class) Please note that there is no guarantee that repeatable annotations are resolved properly.
String	getDescription() Returns a description
Class<?>	getFieldClass() Returns the parameter data type
FunctionParameter<I,P,O>	getFunctionParameter()
String	getKey() Returns the unique ID of this parameter
String	getName() Returns the parameter name that is displayed to the user
JIPipeParameterAccess	getParent()
double	getPriority() Returns the priority for (de)serializing this parameter.
String	getShortKey() Returns a short form of the ID used, for example to generate a parameter string.
JIPipeParameterCollection	getSource() Gets the object that holds the parameter
int	getUIOrder() Controls how the parameter is ordered within the user interface
boolean	isHidden() Returns if the parameter should be hidden from the user
boolean	isImportant() Returns true if the parameter should be marked in the UI as important
<T> boolean	set(T value) Sets the parameter value

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterAccess

comparePriority, getPersistence, isPinned

Constructor Detail

FunctionParameterParameterAccess

public FunctionParameterParameterAccess(JIPipeParameterAccess parent)

Method Detail

getKey

public String getKey()

Description copied from interface: JIPipeParameterAccess

Returns the unique ID of this parameter

Specified by:

getKey in interface JIPipeParameterAccess

Returns:

Unique parameter key

getName

public String getName()

Description copied from interface: JIPipeParameterAccess

Returns the parameter name that is displayed to the user

Specified by:

getName in interface JIPipeParameterAccess

Returns:

Parameter name

getDescription

public String getDescription()

Description copied from interface: JIPipeParameterAccess

Returns a description

Specified by:

getDescription in interface JIPipeParameterAccess

Returns:

Parameter description

isHidden

public boolean isHidden()

Description copied from interface: JIPipeParameterAccess

Returns if the parameter should be hidden from the user

Specified by:

isHidden in interface JIPipeParameterAccess

Returns:

Parameter visibility

isImportant

public boolean isImportant()

Description copied from interface: JIPipeParameterAccess

Returns true if the parameter should be marked in the UI as important

Specified by:

isImportant in interface JIPipeParameterAccess

Returns:

if the parameter is important

getAnnotationOfType

public <T extends Annotation> T getAnnotationOfType(Class<T> klass)

Description copied from interface: JIPipeParameterAccess

Gets an annotation for this parameter

Specified by:

getAnnotationOfType in interface JIPipeParameterAccess

Type Parameters:

T - Annotation type

Parameters:

klass - Annotation class

Returns:

Annotation or null if not found

getAnnotationsOfType

public <T extends Annotation> List<T> getAnnotationsOfType(Class<T> klass)

Description copied from interface: JIPipeParameterAccess

Gets annotations for this parameter (including the field class) Please note that there is no guarantee that repeatable annotations are resolved properly. This is an oversight of Java and cannot be resolved on our side. We recommend to check both for the repeatable and container annotations.

Specified by:

getAnnotationsOfType in interface JIPipeParameterAccess

Type Parameters:

T - the annotation class

Parameters:

klass - the annotation class

Returns:

the list of annotations

getAnnotations

public Collection<Annotation> getAnnotations()

Description copied from interface: JIPipeParameterAccess

Gets all available annotations for this parameter

Specified by:

getAnnotations in interface JIPipeParameterAccess

Returns:

the annotations

getFieldClass

public Class<?> getFieldClass()

Description copied from interface: JIPipeParameterAccess

Returns the parameter data type

Specified by:

getFieldClass in interface JIPipeParameterAccess

Returns:

Parameter class

get

public <T> T get(Class<T> klass)

Description copied from interface: JIPipeParameterAccess

Gets the parameter value

Specified by:

get in interface JIPipeParameterAccess

Type Parameters:

T - Parameter data type

Parameters:

klass - Parameter data type

Returns:

Parameter value

set

public <T> boolean set(T value)

Description copied from interface: JIPipeParameterAccess

Sets the parameter value

Specified by:

set in interface JIPipeParameterAccess

Type Parameters:

T - Parameter data type

Parameters:

value - Parameter value

Returns:

If setting the value was successful

getSource

public JIPipeParameterCollection getSource()

Description copied from interface: JIPipeParameterAccess

Gets the object that holds the parameter

Specified by:

getSource in interface JIPipeParameterAccess

Returns:

the object that holds the parameter

getPriority

public double getPriority()

Description copied from interface: JIPipeParameterAccess

Returns the priority for (de)serializing this parameter. Please use the priority constants provided by Priority

Specified by:

getPriority in interface JIPipeParameterAccess

Returns:

the priority

getShortKey

public String getShortKey()

Description copied from interface: JIPipeParameterAccess

Returns a short form of the ID used, for example to generate a parameter string. Might return getKey() if none was provided

Specified by:

getShortKey in interface JIPipeParameterAccess

Returns:

a short form of the ID used, for example to generate a parameter string

getUIOrder

public int getUIOrder()

Description copied from interface: JIPipeParameterAccess

Controls how the parameter is ordered within the user interface

Specified by:

getUIOrder in interface JIPipeParameterAccess

Returns:

a low number indicates that this parameter is put first, while a high number indicates that this parameter is put last

getFunctionParameter

public FunctionParameter<I,P,O> getFunctionParameter()

getParent

public JIPipeParameterAccess getParent()