org.hkijena.jipipe.api.parameters

Class JIPipeManualParameterAccess.Builder

java.lang.Object

org.hkijena.jipipe.api.parameters.JIPipeManualParameterAccess.Builder

Enclosing class:

JIPipeManualParameterAccess

public static class JIPipeManualParameterAccess.Builder
extends Object

A builder for JIPipeManualParameterAccess

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
JIPipeManualParameterAccess.Builder	addAnnotation(Annotation annotation)
JIPipeManualParameterAccess	build() Returns the finished object Requires following properties to be set: source, field class, getter, setter
JIPipeManualParameterAccess.Builder	dummyAccess(Class<?> fieldClass) Sets up a dummy access.
JIPipeManualParameterAccess.Builder	reflectionAccess(JIPipeParameterCollection source, Method getter, Method setter) Sets up access via reflection The field class is extracted from the getter return type
JIPipeManualParameterAccess.Builder	setAnnotationSupplier(Function<Class<? extends Annotation>,Annotation> supplier)
JIPipeManualParameterAccess.Builder	setDescription(String description) Sets the description
JIPipeManualParameterAccess.Builder	setFieldClass(Class<?> fieldClass) Sets the field class
JIPipeManualParameterAccess.Builder	setGetter(Supplier<Object> getter) Sets the getter
JIPipeManualParameterAccess.Builder	setHidden(boolean hidden) Sets the visibility
JIPipeManualParameterAccess.Builder	setImportant(boolean important) Allows to make the parameter important (only for UI)
JIPipeManualParameterAccess.Builder	setKey(String key) Sets the unique key
JIPipeManualParameterAccess.Builder	setName(String name) Sets the name
JIPipeManualParameterAccess.Builder	setPriority(double priority) Sets the priority
<T> JIPipeManualParameterAccess.Builder	setSetter(Consumer<T> setter) Sets the setter
JIPipeManualParameterAccess.Builder	setSetter(Function<Object,Boolean> setter) Sets the setter
JIPipeManualParameterAccess.Builder	setShortKey(String shortKey) Sets the short key
JIPipeManualParameterAccess.Builder	setSource(JIPipeParameterCollection source) Sets the parameter source
JIPipeManualParameterAccess.Builder	setUIOrder(int uiOrder) Sets the UI order

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setSource

public JIPipeManualParameterAccess.Builder setSource(JIPipeParameterCollection source)

Sets the parameter source

Parameters:

source - the source

Returns:

this

setPriority

public JIPipeManualParameterAccess.Builder setPriority(double priority)

Sets the priority

Parameters:

priority - the priority

Returns:

this

setUIOrder

public JIPipeManualParameterAccess.Builder setUIOrder(int uiOrder)

Sets the UI order

Parameters:

uiOrder - the ui order

Returns:

this

setFieldClass

public JIPipeManualParameterAccess.Builder setFieldClass(Class<?> fieldClass)

Sets the field class

Parameters:

fieldClass - the field class

Returns:

this

setName

public JIPipeManualParameterAccess.Builder setName(String name)

Sets the name

Parameters:

name - the name

Returns:

this

setDescription

public JIPipeManualParameterAccess.Builder setDescription(String description)

Sets the description

Parameters:

description - the description

Returns:

this

setShortKey

public JIPipeManualParameterAccess.Builder setShortKey(String shortKey)

Sets the short key

Parameters:

shortKey - the sort key

Returns:

this

setHidden

public JIPipeManualParameterAccess.Builder setHidden(boolean hidden)

Sets the visibility

Parameters:

hidden - the visibility

Returns:

this

setImportant

public JIPipeManualParameterAccess.Builder setImportant(boolean important)

Allows to make the parameter important (only for UI)

Parameters:

important - if the parameter should be highlighted in the UI

Returns:

this

setGetter

public JIPipeManualParameterAccess.Builder setGetter(Supplier<Object> getter)

Sets the getter

Parameters:

getter - the getter

Returns:

this

setSetter

public JIPipeManualParameterAccess.Builder setSetter(Function<Object,Boolean> setter)

Sets the setter

Parameters:

setter - the setter

Returns:

this

setKey

public JIPipeManualParameterAccess.Builder setKey(String key)

Sets the unique key

Parameters:

key - the key

Returns:

this

setSetter

public <T> JIPipeManualParameterAccess.Builder setSetter(Consumer<T> setter)

Sets the setter

Parameters:

setter - the setter

Returns:

this

addAnnotation

public JIPipeManualParameterAccess.Builder addAnnotation(Annotation annotation)

setAnnotationSupplier

public JIPipeManualParameterAccess.Builder setAnnotationSupplier(Function<Class<? extends Annotation>,Annotation> supplier)

reflectionAccess

public JIPipeManualParameterAccess.Builder reflectionAccess(JIPipeParameterCollection source,
                                                            Method getter,
                                                            Method setter)

Sets up access via reflection The field class is extracted from the getter return type

Parameters:

source - the source object

getter - the getter method

setter - the setter method

Returns:

this

dummyAccess

public JIPipeManualParameterAccess.Builder dummyAccess(Class<?> fieldClass)

Sets up a dummy access. The source is set to an JIPipeDummyParameterCollection instance.

Parameters:

fieldClass - the field class to store

Returns:

this

build

public JIPipeManualParameterAccess build()

Returns the finished object Requires following properties to be set: source, field class, getter, setter

Returns:

the finished object