org.hkijena.jipipe.plugins.parameters.api.collections

Class ListParameter<T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<T>

org.hkijena.jipipe.plugins.parameters.api.collections.ListParameter<T>

All Implemented Interfaces:

Serializable, Cloneable, Iterable<T>, Collection<T>, List<T>, RandomAccess, JIPipeCustomTextDescriptionParameter, JIPipeValidatable

Direct Known Subclasses:

ColorListParameter, ConvertingTableColumnProcessorParameterList, DoubleAndDoublePairParameter.List, DoubleList, ExpressionAndExpressionPairParameter.List, ExpressionTableColumnGeneratorProcessorParameterList, ExpressionTableColumnProcessorParameterList, FileChooserBookmarkList, FixedMargin.List, FloatList, GraphNodeReferenceParameter.List, HyperstackDimensionPairParameter.List, IlastikEnvironment.List, InnerMargin.List, IntegerAndIntegerPairParameter.List, IntegerList, IntegratingTableColumnProcessorParameterList, IntRangeAndIntegerPairParameter.List, JIPipeArtifactRepositoryReferenceList, JIPipeAuthorMetadata.List, JIPipeDataDirectoryEnvironment.List, JIPipeExpressionParameter.List, JIPipeImageJUpdateSiteDependency.List, JIPipeNodeTemplate.List, JIPipePythonAdapterLibraryEnvironment.List, LongList, Margin.List, MeasurementColumnSortOrder.List, NamedStringQueryExpression.List, NamedTextAnnotationGeneratorExpression.List, OMEROCredentialsEnvironment.List, OptionalJIPipeAuthorMetadata.List, ParameterCollectionList, PathList, PluginCategoriesEnumParameter.List, PretrainedCellpose2SegmentationModelList, PretrainedCellpose3DenoiseModelList, PretrainedCellpose3SegmentationModelList, PretrainedOmnipose0ModelList, ProcessEnvironment.List, PythonEnvironment.List, RectangleList, REnvironment.List, ResultsTableDataList, SpotFeatureFilterParameter.List, SpotFeaturePenaltyParameter.List, StringAndStringPairParameter.List, StringList, StringOrDouble.List, StringPatternExtraction.List, StringPatternExtractionFunction.List, StringQueryExpressionAndSortOrderPairParameter.List, StringQueryExpressionAndStringPairParameter.List, StringQueryExpressionAndStringQueryPairParameter.List, TableColumnGeneratorProcessorParameterList, TableColumnSourceExpressionParameter.List, TesseractOCREnvironment.List, TrackFeatureFilterParameter.List, TSOAXEnvironment.List, Vector2dParameter.List, Vector2iParameter.List, Vector3dParameter.List, Vector3iParameter.List

public abstract class ListParameter<T>
extends ArrayList<T>
implements JIPipeValidatable, JIPipeCustomTextDescriptionParameter

A parameter that is a collection of another parameter type

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
ListParameter(Class<T> contentClass)

Method Summary

Modifier and Type	Method and Description
T	addNewInstance() Adds a new instance of the content class Override this method for types that cannot be default-constructed
Class<T>	getContentClass()
Supplier<T>	getCustomInstanceGenerator()
String	getTextDescription() Gets the parameter as custom text description
void	reportValidity(JIPipeValidationReportContext reportContext, JIPipeValidationReport report) Generates a validity report
void	setCustomInstanceGenerator(Supplier<T> customInstanceGenerator)

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.validation.JIPipeValidatable

generateValidityReport

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeCustomTextDescriptionParameter

getTextDescriptionOf

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

ListParameter

public ListParameter(Class<T> contentClass)

Parameters:

contentClass - the stored content

Method Detail

getContentClass

public Class<T> getContentClass()

addNewInstance

public T addNewInstance()

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

Returns:

the instance

reportValidity

public void reportValidity(JIPipeValidationReportContext reportContext,
                           JIPipeValidationReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Parameters:

reportContext - the report context

report - the report to be added to

getTextDescription

public String getTextDescription()

Description copied from interface: JIPipeCustomTextDescriptionParameter

Gets the parameter as custom text description

Specified by:

getTextDescription in interface JIPipeCustomTextDescriptionParameter

Returns:

the text description

getCustomInstanceGenerator

public Supplier<T> getCustomInstanceGenerator()

setCustomInstanceGenerator

public void setCustomInstanceGenerator(Supplier<T> customInstanceGenerator)