org.hkijena.jipipe.api.nodes

Annotation Type AddJIPipeOutputSlot

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Repeatable(value=AddJIPipeOutputSlots.class)
public @interface AddJIPipeOutputSlot

Annotates an JIPipeGraphNode with an output slot.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<? extends JIPipeData>	value The data class

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	create If true, JIPipeGraphNode automatically configures its slots based on annotations (unless a custom JIPipeSlotConfiguration is provided.
String	description An optional description.
String	inheritedSlot Deprecated. non-functional as of JIPipe version 1.78.0
String	name An optional slot name.
JIPipeDataSlotRole	role Assigns a role to the slot for internal usage within the node's code.

Element Detail

value

public abstract Class<? extends JIPipeData> value

The data class

Returns:

data class

name

public abstract String name

An optional slot name. Cannot be empty if autoCreate is true.

Returns:

slot name

Default:

""

description

public abstract String description

An optional description.

Returns:

slot description

Default:

""

inheritedSlot

@Deprecated
public abstract String inheritedSlot

Deprecated. non-functional as of JIPipe version 1.78.0

An optional inherited slot. Used if autoCreate is true Either can be a valid input slot name to inherit the type of the input slot, or can be '*' to inherit the type of the first slot

Returns:

inherited slot

Default:

""

create

public abstract boolean create

If true, JIPipeGraphNode automatically configures its slots based on annotations (unless a custom JIPipeSlotConfiguration is provided.

Returns:

if auto-configuration is enabled

Default:

false

role

public abstract JIPipeDataSlotRole role

Assigns a role to the slot for internal usage within the node's code. For example, this allows to distinguish data and parametric inputs from each other

Returns:

the role. Leave at Data if there is no special role.

Default:

org.hkijena.jipipe.api.data.JIPipeDataSlotRole.Data