org.hkijena.jipipe.api.data

Class JIPipeDefaultMutableSlotConfiguration.Builder

java.lang.Object

org.hkijena.jipipe.api.data.JIPipeDefaultMutableSlotConfiguration.Builder

Enclosing class:

JIPipeDefaultMutableSlotConfiguration

public static class JIPipeDefaultMutableSlotConfiguration.Builder
extends Object

A builder for creating a configuration

Method Summary

Modifier and Type	Method and Description
JIPipeDefaultMutableSlotConfiguration.Builder	addFromAnnotations(Class<? extends JIPipeGraphNode> klass) Adds slots from parameter annotations (with autoCreate)
JIPipeDefaultMutableSlotConfiguration.Builder	addInputSlot(AddJIPipeInputSlot annotation) Adds an input slot from an annotation
JIPipeDefaultMutableSlotConfiguration.Builder	addInputSlot(String name, String description, Class<? extends JIPipeData> klass) Adds an input slot
JIPipeDefaultMutableSlotConfiguration.Builder	addInputSlot(String name, String description, Class<? extends JIPipeData> klass, boolean optional) Adds an input slot
JIPipeDefaultMutableSlotConfiguration.Builder	addInputSlot(String name, String description, Class<? extends JIPipeData> klass, boolean optional, boolean userModifiable) Adds an input slot
JIPipeDefaultMutableSlotConfiguration.Builder	addOutputSlot(AddJIPipeOutputSlot annotation) Adds an output slot from an annotation
JIPipeDefaultMutableSlotConfiguration.Builder	addOutputSlot(String name, String description, Class<? extends JIPipeData> klass) Adds an output slot
JIPipeDefaultMutableSlotConfiguration.Builder	addOutputSlot(String name, String description, Class<? extends JIPipeData> klass, boolean userModifiable) Adds an output slot
JIPipeDefaultMutableSlotConfiguration.Builder	addOutputSlot(String name, String description, Class<? extends JIPipeData> klass, String inheritedSlot) Deprecated. Slot inheritance is non-functional
JIPipeDefaultMutableSlotConfiguration.Builder	addOutputSlot(String name, String description, Class<? extends JIPipeData> klass, String inheritedSlot, Map<Class<? extends JIPipeData>,Class<? extends JIPipeData>> inheritanceConversions) Deprecated. Slot inheritance is non-functional
JIPipeDefaultMutableSlotConfiguration.Builder	addOutputSlot(String name, String description, Class<? extends JIPipeData> klass, String inheritedSlot, Map<Class<? extends JIPipeData>,Class<? extends JIPipeData>> inheritanceConversions, boolean userModifiable) Deprecated. Slot inheritance is non-functional
JIPipeDefaultMutableSlotConfiguration.Builder	addSlot(JIPipeDataSlotInfo definition) Adds a slot
JIPipeDefaultMutableSlotConfiguration	build()
JIPipeDefaultMutableSlotConfiguration.Builder	restrictInputSlotCount(int maxCount) Restrict the number of input slots
JIPipeDefaultMutableSlotConfiguration.Builder	restrictInputTo(Class<? extends JIPipeData>... types) Restricts the slot to specified data types
JIPipeDefaultMutableSlotConfiguration.Builder	restrictInputTo(Collection<Class<? extends JIPipeData>> types) Restricts the slot to specified data types
JIPipeDefaultMutableSlotConfiguration.Builder	restrictOutputSlotCount(int maxCount) Restrict the number output slots
JIPipeDefaultMutableSlotConfiguration.Builder	restrictOutputTo(Class<? extends JIPipeData>... types) Restricts the slot to specified data types
JIPipeDefaultMutableSlotConfiguration.Builder	restrictOutputTo(Collection<Class<? extends JIPipeData>> types) Restricts the slot to specified data types
JIPipeDefaultMutableSlotConfiguration.Builder	seal() Seals input and output
JIPipeDefaultMutableSlotConfiguration.Builder	sealInput() Seals input
JIPipeDefaultMutableSlotConfiguration.Builder	sealOutput() Seals output
JIPipeDefaultMutableSlotConfiguration.Builder	withoutInput() Disables input
JIPipeDefaultMutableSlotConfiguration.Builder	withoutOutput() Disables output

Methods inherited from class java.lang.Object

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

Method Detail

addInputSlot

public JIPipeDefaultMutableSlotConfiguration.Builder addInputSlot(String name,
                                                                  String description,
                                                                  Class<? extends JIPipeData> klass)

Adds an input slot

Parameters:

name - Unique slot name

description - the description

klass - Slot data class

Returns:

The builder

addInputSlot

public JIPipeDefaultMutableSlotConfiguration.Builder addInputSlot(String name,
                                                                  String description,
                                                                  Class<? extends JIPipeData> klass,
                                                                  boolean optional)

Adds an input slot

Parameters:

name - Unique slot name

description - the description

klass - Slot data class

optional - Make the slot optional

Returns:

The builder

addInputSlot

public JIPipeDefaultMutableSlotConfiguration.Builder addInputSlot(AddJIPipeInputSlot annotation)

Adds an input slot from an annotation

Parameters:

annotation - the annotation

Returns:

The builder

addInputSlot

public JIPipeDefaultMutableSlotConfiguration.Builder addInputSlot(String name,
                                                                  String description,
                                                                  Class<? extends JIPipeData> klass,
                                                                  boolean optional,
                                                                  boolean userModifiable)

Adds an input slot

Parameters:

name - Unique slot name

description - the description

klass - Slot data class

optional - Make the slot optional (default false in other overload)

userModifiable - Make slot user-modifiable (default true in other overload)

Returns:

The builder

addOutputSlot

@Deprecated
public JIPipeDefaultMutableSlotConfiguration.Builder addOutputSlot(String name,
                                                                               String description,
                                                                               Class<? extends JIPipeData> klass,
                                                                               String inheritedSlot)

Deprecated. Slot inheritance is non-functional

Adds an output slot

Parameters:

name - Unique slot name

description - the description

klass - Slot data class

inheritedSlot - From which slot the data type is inherited. Slot name of an input or '*' to select the first available slot. Can be null or empty.

Returns:

The builder

addOutputSlot

@Deprecated
public JIPipeDefaultMutableSlotConfiguration.Builder addOutputSlot(String name,
                                                                               String description,
                                                                               Class<? extends JIPipeData> klass,
                                                                               String inheritedSlot,
                                                                               Map<Class<? extends JIPipeData>,Class<? extends JIPipeData>> inheritanceConversions)

Deprecated. Slot inheritance is non-functional

Adds an output slot

Parameters:

name - Unique slot name

description - the description

klass - Slot data class

inheritedSlot - From which slot the data type is inherited. Slot name of an input or '*' to select the first available slot. Can be null or empty.

inheritanceConversions - Instructions on how to convert inherited slot types.

Returns:

The builder

addOutputSlot

@Deprecated
public JIPipeDefaultMutableSlotConfiguration.Builder addOutputSlot(String name,
                                                                               String description,
                                                                               Class<? extends JIPipeData> klass,
                                                                               String inheritedSlot,
                                                                               Map<Class<? extends JIPipeData>,Class<? extends JIPipeData>> inheritanceConversions,
                                                                               boolean userModifiable)

Deprecated. Slot inheritance is non-functional

Adds an output slot

Parameters:

name - Unique slot name

description - the description

klass - Slot data class

inheritedSlot - From which slot the data type is inherited. Slot name of an input or '*' to select the first available slot. Can be null or empty.

inheritanceConversions - Instructions on how to convert inherited slot types.

userModifiable - Make slot user-modifiable (default true in other overloads)

Returns:

The builder

addOutputSlot

public JIPipeDefaultMutableSlotConfiguration.Builder addOutputSlot(String name,
                                                                   String description,
                                                                   Class<? extends JIPipeData> klass)

Adds an output slot

Parameters:

name - Unique slot name

description - the description

klass - Slot data class

Returns:

The builder

addOutputSlot

public JIPipeDefaultMutableSlotConfiguration.Builder addOutputSlot(AddJIPipeOutputSlot annotation)

Adds an output slot from an annotation

Parameters:

annotation - the annotation

Returns:

The builder

addOutputSlot

public JIPipeDefaultMutableSlotConfiguration.Builder addOutputSlot(String name,
                                                                   String description,
                                                                   Class<? extends JIPipeData> klass,
                                                                   boolean userModifiable)

Adds an output slot

Parameters:

name - Unique slot name

description - the description

klass - Slot data class

userModifiable - Make slot user-modifiable (default true in other overloads)

Returns:

The builder

addSlot

public JIPipeDefaultMutableSlotConfiguration.Builder addSlot(JIPipeDataSlotInfo definition)

Adds a slot

Parameters:

definition - Slot definition

Returns:

The builder

restrictInputSlotCount

public JIPipeDefaultMutableSlotConfiguration.Builder restrictInputSlotCount(int maxCount)

Restrict the number of input slots

Parameters:

maxCount - Maximum input slot number

Returns:

The builder

restrictOutputSlotCount

public JIPipeDefaultMutableSlotConfiguration.Builder restrictOutputSlotCount(int maxCount)

Restrict the number output slots

Parameters:

maxCount - Maximum output slot number

Returns:

The builder

withoutInput

public JIPipeDefaultMutableSlotConfiguration.Builder withoutInput()

Disables input

Returns:

The builder

withoutOutput

public JIPipeDefaultMutableSlotConfiguration.Builder withoutOutput()

Disables output

Returns:

The builder

seal

public JIPipeDefaultMutableSlotConfiguration.Builder seal()

Seals input and output

Returns:

The builder

sealInput

public JIPipeDefaultMutableSlotConfiguration.Builder sealInput()

Seals input

Returns:

The builder

sealOutput

public JIPipeDefaultMutableSlotConfiguration.Builder sealOutput()

Seals output

Returns:

The builder

restrictInputTo

@SafeVarargs
public final JIPipeDefaultMutableSlotConfiguration.Builder restrictInputTo(Class<? extends JIPipeData>... types)

Restricts the slot to specified data types

Parameters:

types - Allowed data types

Returns:

The builder

restrictInputTo

public final JIPipeDefaultMutableSlotConfiguration.Builder restrictInputTo(Collection<Class<? extends JIPipeData>> types)

Restricts the slot to specified data types

Parameters:

types - Allowed data types

Returns:

The builder

restrictOutputTo

@SafeVarargs
public final JIPipeDefaultMutableSlotConfiguration.Builder restrictOutputTo(Class<? extends JIPipeData>... types)

Restricts the slot to specified data types

Parameters:

types - Allowed data types

Returns:

The builder

restrictOutputTo

public final JIPipeDefaultMutableSlotConfiguration.Builder restrictOutputTo(Collection<Class<? extends JIPipeData>> types)

Restricts the slot to specified data types

Parameters:

types - Allowed data types

Returns:

The builder

build

public JIPipeDefaultMutableSlotConfiguration build()

Returns:

The JIPipeDefaultMutableSlotConfiguration instance

addFromAnnotations

public JIPipeDefaultMutableSlotConfiguration.Builder addFromAnnotations(Class<? extends JIPipeGraphNode> klass)

Adds slots from parameter annotations (with autoCreate)

Parameters:

klass - the node class

Returns:

the builder