org.hkijena.jipipe.extensions.parameters.library.collections

Class ParameterCollectionList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<T>

org.hkijena.jipipe.extensions.parameters.api.collections.ListParameter<JIPipeDynamicParameterCollection>

org.hkijena.jipipe.extensions.parameters.library.collections.ParameterCollectionList

All Implemented Interfaces:

Serializable, Cloneable, Iterable<JIPipeDynamicParameterCollection>, Collection<JIPipeDynamicParameterCollection>, List<JIPipeDynamicParameterCollection>, RandomAccess, JIPipeValidatable

public class ParameterCollectionList
extends ListParameter<JIPipeDynamicParameterCollection>

A list of multiple JIPipeParameterCollection items (internally JIPipeDynamicParameterCollection. We suggest to use this parameter instead of defining custom pairs (PairParameter or functions (FunctionParameter

You should provide a template JIPipeParameterCollection class (that is instantiable) to automatically populate newly created JIPipeDynamicParameterCollection with values. Provide this class via the containingCollection() static method

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParameterCollectionList.Deserializer
static class	ParameterCollectionList.Serializer

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
ParameterCollectionList()
ParameterCollectionList(ParameterCollectionList other)

Method Summary

Modifier and Type	Method and Description
void	addFromTemplate(JIPipeParameterCollection source)
JIPipeDynamicParameterCollection	addNewInstance() Adds a new instance of the content class Override this method for types that cannot be default-constructed
void	applyTemplateToItems() Applies the entries of the current template to all items (adding/removing/changing items)
static ParameterCollectionList	containingCollection(Class<? extends JIPipeParameterCollection> klass) Creates an instance from a template collection class.
static ParameterCollectionList	containingSingle(Class<?> klass) Creates an instance that contains a parameter of a specific value
JIPipeDynamicParameterCollection	getTemplate() Returns the template object for new items
<T extends JIPipeParameterCollection> List<T>	mapToCollection(Class<T> klass) Maps the items to a JIPipeParameterCollection type.
void	setTemplate(JIPipeDynamicParameterCollection template) Sets the template for new items

Methods inherited from class org.hkijena.jipipe.extensions.parameters.api.collections.ListParameter

getContentClass, getCustomInstanceGenerator, reportValidity, setCustomInstanceGenerator

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hkijena.jipipe.api.JIPipeValidatable

generateValidityReport

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

ParameterCollectionList

public ParameterCollectionList()

ParameterCollectionList

public ParameterCollectionList(ParameterCollectionList other)

Method Detail

containingCollection

public static ParameterCollectionList containingCollection(Class<? extends JIPipeParameterCollection> klass)

Creates an instance from a template collection class. Each item contains the same parameters as the template. Please note that nested parameters (groups) are flattened.

Parameters:

klass - the template collection. must be instantiable.

Returns:

the list

containingSingle

public static ParameterCollectionList containingSingle(Class<?> klass)

Creates an instance that contains a parameter of a specific value

Parameters:

klass - the type of parameter that is contained

Returns:

the list

getTemplate

public JIPipeDynamicParameterCollection getTemplate()

Returns the template object for new items

Returns:

the template

setTemplate

public void setTemplate(JIPipeDynamicParameterCollection template)

Sets the template for new items

Parameters:

template - the template

mapToCollection

public <T extends JIPipeParameterCollection> List<T> mapToCollection(Class<T> klass)

Maps the items to a JIPipeParameterCollection type. Useful if you created this list based on a template.

Type Parameters:

T - the collection class

Parameters:

klass - the collection class

Returns:

list of mapped objects

addNewInstance

public JIPipeDynamicParameterCollection addNewInstance()

Description copied from class: ListParameter

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

Overrides:

addNewInstance in class ListParameter<JIPipeDynamicParameterCollection>

Returns:

the instance

addFromTemplate

public void addFromTemplate(JIPipeParameterCollection source)

applyTemplateToItems

public void applyTemplateToItems()

Applies the entries of the current template to all items (adding/removing/changing items)