org.hkijena.jipipe.api.parameters

Enum JIPipeParameterSerializationMode

java.lang.Object

java.lang.Enum<JIPipeParameterSerializationMode>

org.hkijena.jipipe.api.parameters.JIPipeParameterSerializationMode

All Implemented Interfaces:

Serializable, Comparable<JIPipeParameterSerializationMode>

public enum JIPipeParameterSerializationMode
extends Enum<JIPipeParameterSerializationMode>

Determines how a parameter of JIPipeParameterCollection is serialized

Enum Constant Summary

Enum Constants

Enum Constant and Description
Default The parameter is serialized as collection, meaning that sub-parameters are unwrapped.
None The parameter is not serialized
Object The parameter is serialized into an object instead of exploded into the root object.

Method Summary

Modifier and Type	Method and Description
static JIPipeParameterSerializationMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static JIPipeParameterSerializationMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Default

public static final JIPipeParameterSerializationMode Default

The parameter is serialized as collection, meaning that sub-parameters are unwrapped. This is equal to the behavior of 'Object' for non JIPipeParameterCollection objects. This is the default and most robust method, as the minimal amount of information is lost on API changes.

Object

public static final JIPipeParameterSerializationMode Object

The parameter is serialized into an object instead of exploded into the root object. Requires that the parameter inherits from JsonDeserializable. This is less robust than the Collection method, but might be preferred for certain types.

None

public static final JIPipeParameterSerializationMode None

The parameter is not serialized

Method Detail

values

public static JIPipeParameterSerializationMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JIPipeParameterSerializationMode c : JIPipeParameterSerializationMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JIPipeParameterSerializationMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null