org.hkijena.jipipe.extensions.parameters.api.optional

Class OptionalParameter<T>

java.lang.Object

org.hkijena.jipipe.extensions.parameters.api.optional.OptionalParameter<T>

Type Parameters:

T - the underlying parameter

Direct Known Subclasses:

OptionalBooleanParameter, OptionalByteParameter, OptionalColorMapParameter, OptionalColorParameter, OptionalDataInfoRefParameter, OptionalDefaultExpressionParameter, OptionalDoubleParameter, OptionalFloatParameter, OptionalIntegerParameter, OptionalIntegerRange, OptionalIntModificationParameter, OptionalLongParameter, OptionalNodeInfoRefParameter, OptionalPathParameter, OptionalPythonEnvironment, OptionalQuantity, OptionalREnvironment, OptionalShortParameter, OptionalStringParameter

public abstract class OptionalParameter<T>
extends Object

A parameter that is optional

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OptionalParameter.Deserializer<T> Deserializes the parameter
static class	OptionalParameter.Serializer Serializes the parameter

Constructor Summary

Constructors

Constructor and Description
OptionalParameter(Class<T> contentClass)
OptionalParameter(OptionalParameter<T> other) Produces a shallow copy You have to implement deep content copying yourself

Method Summary

Modifier and Type	Method and Description
T	getContent()
Class<T>	getContentClass()
T	getContentOrDefault(T defaultValue) Returns the content if enabled, otherwise the default value
boolean	isEnabled()
void	setContent(T content)
void	setEnabled(boolean enabled)
T	setNewInstance() Adds a new instance of the content class Override this method for types that cannot be default-constructed
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionalParameter

public OptionalParameter(Class<T> contentClass)

Parameters:

contentClass - the stored content

OptionalParameter

public OptionalParameter(OptionalParameter<T> other)

Produces a shallow copy You have to implement deep content copying yourself

Parameters:

other - the original

Method Detail

setNewInstance

public T setNewInstance()

Adds a new instance of the content class Override this method for types that cannot be default-constructed

Returns:

the instance

getContentClass

public Class<T> getContentClass()

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getContent

public T getContent()

setContent

public void setContent(T content)

getContentOrDefault

public T getContentOrDefault(T defaultValue)

Returns the content if enabled, otherwise the default value

Parameters:

defaultValue - the default value

Returns:

the content if enabled, otherwise the default value

toString

public String toString()

Overrides:

toString in class Object