org.hkijena.jipipe.plugins.parameters.library.primitives.ranges

Class IntegerRange

java.lang.Object

org.hkijena.jipipe.plugins.parameters.library.primitives.ranges.IntegerRange

All Implemented Interfaces:

JIPipeCustomTextDescriptionParameter

public class IntegerRange
extends Object
implements JIPipeCustomTextDescriptionParameter

Parameter that contains an integer range as string. The format is the following: [range];[range];... with range being an integer or [from]-[to] where from and to are inclusive. Returns the list of integers defined by the string. Empty ranges are ignored. Spaces are ignored. Negative values must be enclosed in brackets

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IntegerRange.VariablesInfo

Constructor Summary

Constructors

Constructor and Description
IntegerRange() Creates a new instance with a null value
IntegerRange(IntegerRange other) Creates a copy
IntegerRange(String value) Creates a new instance and initializes it

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
JIPipeExpressionParameter	getExpression()
List<Integer>	getIntegers(int min, int max, JIPipeExpressionVariablesMap variables) Generates the list of integers based on the value
static List<Integer>	getIntegersFromRangeString(String value) Converts a range string of format [range];[range];... to a list of integers
String	getTextDescription() Gets the parameter as custom text description
String	getValue()
int	hashCode()
boolean	isUseExpression()
void	setExpression(JIPipeExpressionParameter expression)
void	setUseExpression(boolean useExpression)
void	setValue(String value)
String	toString()
List<Integer>	tryGetIntegers(int min, int max, JIPipeExpressionVariablesMap variables) Generates the list of integers based on the value.

Methods inherited from class java.lang.Object

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

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

getTextDescriptionOf

Constructor Detail

IntegerRange

public IntegerRange()

Creates a new instance with a null value

IntegerRange

public IntegerRange(String value)

Creates a new instance and initializes it

Parameters:

value - the value

IntegerRange

public IntegerRange(IntegerRange other)

Creates a copy

Parameters:

other - the original

Method Detail

getIntegersFromRangeString

public static List<Integer> getIntegersFromRangeString(String value)

Converts a range string of format [range];[range];... to a list of integers

Parameters:

value - the range string

Returns:

the list of integers

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isUseExpression

public boolean isUseExpression()

setUseExpression

public void setUseExpression(boolean useExpression)

getExpression

public JIPipeExpressionParameter getExpression()

setExpression

public void setExpression(JIPipeExpressionParameter expression)

getValue

public String getValue()

setValue

public void setValue(String value)

tryGetIntegers

public List<Integer> tryGetIntegers(int min,
                                    int max,
                                    JIPipeExpressionVariablesMap variables)

Generates the list of integers based on the value. Throws no exceptions.

Parameters:

min - the min value the integers can have

max - the max value the integers can have

variables - the variables for the expression-based variant

Returns:

null if the format is wrong

getIntegers

public List<Integer> getIntegers(int min,
                                 int max,
                                 JIPipeExpressionVariablesMap variables)
                          throws NumberFormatException

Generates the list of integers based on the value

Parameters:

min - the min value the integers can have

max - the max value the integers can have

variables - the variables for the expression-based variant

Returns:

the generated integers

Throws:

NumberFormatException - if the format is wrong

toString

public String toString()

Overrides:

toString in class Object

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