Package ai.timefold.solver.core.api.domain.valuerange

Class ValueRangeFactory

java.lang.Object

ai.timefold.solver.core.api.domain.valuerange.ValueRangeFactory

public final class ValueRangeFactory
extends Object

Factory for CountableValueRange.

Constructor Summary

Constructors

Constructor	Description
ValueRangeFactory()

Method Summary

Modifier and Type	Method	Description
static @NonNull CountableValueRange<BigDecimal>	createBigDecimalValueRange(@NonNull BigDecimal from, @NonNull BigDecimal to)	Build a CountableValueRange of all BigDecimal values (of a specific scale) between 2 bounds.
static @NonNull CountableValueRange<BigDecimal>	createBigDecimalValueRange(@NonNull BigDecimal from, @NonNull BigDecimal to, @NonNull BigDecimal incrementUnit)	Build a CountableValueRange of a subset of BigDecimal values (of a specific scale) between 2 bounds.
static @NonNull CountableValueRange<BigInteger>	createBigIntegerValueRange(@NonNull BigInteger from, @NonNull BigInteger to)	Build a CountableValueRange of all BigInteger values between 2 bounds.
static @NonNull CountableValueRange<BigInteger>	createBigIntegerValueRange(@NonNull BigInteger from, @NonNull BigInteger to, @NonNull BigInteger incrementUnit)	Build a CountableValueRange of a subset of BigInteger values between 2 bounds.
static @NonNull CountableValueRange<Boolean>	createBooleanValueRange()	Build a CountableValueRange of both boolean values.
static @NonNull ValueRange<Double>	createDoubleValueRange(double from, double to)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer createBigDecimalValueRange(BigDecimal, BigDecimal).
static @NonNull CountableValueRange<Integer>	createIntValueRange(int from, int to)	Build a CountableValueRange of all int values between 2 bounds.
static @NonNull CountableValueRange<Integer>	createIntValueRange(int from, int to, int incrementUnit)	Build a CountableValueRange of a subset of int values between 2 bounds.
static CountableValueRange<LocalDateTime>	createLocalDateTimeValueRange(@NonNull LocalDateTime from, @NonNull LocalDateTime to, long incrementUnitAmount, @NonNull TemporalUnit incrementUnitType)	Build a CountableValueRange of a subset of LocalDateTime values between 2 bounds.
static @NonNull CountableValueRange<LocalDate>	createLocalDateValueRange(@NonNull LocalDate from, @NonNull LocalDate to, long incrementUnitAmount, @NonNull TemporalUnit incrementUnitType)	Build a CountableValueRange of a subset of LocalDate values between 2 bounds.
static CountableValueRange<LocalTime>	createLocalTimeValueRange(@NonNull LocalTime from, @NonNull LocalTime to, long incrementUnitAmount, @NonNull TemporalUnit incrementUnitType)	Build a CountableValueRange of a subset of LocalTime values between 2 bounds.
static @NonNull CountableValueRange<Long>	createLongValueRange(long from, long to)	Build a CountableValueRange of all long values between 2 bounds.
static @NonNull CountableValueRange<Long>	createLongValueRange(long from, long to, long incrementUnit)	Build a CountableValueRange of a subset of long values between 2 bounds.
static <Temporal_ extends Temporal & Comparable<? super Temporal_>> @NonNull CountableValueRange<Temporal_>	createTemporalValueRange(@NonNull Temporal_ from, @NonNull Temporal_ to, long incrementUnitAmount, @NonNull TemporalUnit incrementUnitType)	Build a CountableValueRange of a subset of Temporal values (such as LocalDate or LocalDateTime) between 2 bounds.

Methods inherited from class java.lang.Object

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

Constructor Details

ValueRangeFactory

public ValueRangeFactory()

Method Details

createBooleanValueRange

public static @NonNull CountableValueRange<Boolean> createBooleanValueRange()

Build a CountableValueRange of both boolean values.

createIntValueRange

public static @NonNull CountableValueRange<Integer> createIntValueRange(int from,
 int to)

Build a CountableValueRange of all int values between 2 bounds.

Parameters:

from - inclusive minimum

to - exclusive maximum, >= from

createIntValueRange

public static @NonNull CountableValueRange<Integer> createIntValueRange(int from,
 int to,
 int incrementUnit)

Build a CountableValueRange of a subset of int values between 2 bounds.

Parameters:

from - inclusive minimum

to - exclusive maximum, >= from

incrementUnit - > 0

createLongValueRange

public static @NonNull CountableValueRange<Long> createLongValueRange(long from,
 long to)

Build a CountableValueRange of all long values between 2 bounds.

Parameters:

from - inclusive minimum

to - exclusive maximum, >= from

createLongValueRange

public static @NonNull CountableValueRange<Long> createLongValueRange(long from,
 long to,
 long incrementUnit)

Build a CountableValueRange of a subset of long values between 2 bounds.

Parameters:

from - inclusive minimum

to - exclusive maximum, >= from

incrementUnit - > 0

createDoubleValueRange

@Deprecated(forRemoval=true,
            since="1.1.0")
public static @NonNull ValueRange<Double> createDoubleValueRange(double from,
 double to)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer createBigDecimalValueRange(BigDecimal, BigDecimal).

Build an uncountable ValueRange of all double values between 2 bounds.

Parameters:

from - inclusive minimum

to - exclusive maximum, >= from

createBigIntegerValueRange

public static @NonNull CountableValueRange<BigInteger> createBigIntegerValueRange(@NonNull BigInteger from,
 @NonNull BigInteger to)

Build a CountableValueRange of all BigInteger values between 2 bounds.

Parameters:

from - inclusive minimum

to - exclusive maximum, >= from

createBigIntegerValueRange

public static @NonNull CountableValueRange<BigInteger> createBigIntegerValueRange(@NonNull BigInteger from,
 @NonNull BigInteger to,
 @NonNull BigInteger incrementUnit)

Build a CountableValueRange of a subset of BigInteger values between 2 bounds.

Parameters:

from - inclusive minimum

to - exclusive maximum, >= from

incrementUnit - > 0

createBigDecimalValueRange

public static @NonNull CountableValueRange<BigDecimal> createBigDecimalValueRange(@NonNull BigDecimal from,
 @NonNull BigDecimal to)

Build a CountableValueRange of all BigDecimal values (of a specific scale) between 2 bounds. All parameters must have the same BigDecimal.scale().

Parameters:

from - inclusive minimum

to - exclusive maximum, >= from

createBigDecimalValueRange

public static @NonNull CountableValueRange<BigDecimal> createBigDecimalValueRange(@NonNull BigDecimal from,
 @NonNull BigDecimal to,
 @NonNull BigDecimal incrementUnit)

Build a CountableValueRange of a subset of BigDecimal values (of a specific scale) between 2 bounds. All parameters must have the same BigDecimal.scale().

Parameters:

from - inclusive minimum

to - exclusive maximum, >= from

incrementUnit - > 0

createLocalDateValueRange

public static @NonNull CountableValueRange<LocalDate> createLocalDateValueRange(@NonNull LocalDate from,
 @NonNull LocalDate to,
 long incrementUnitAmount,
 @NonNull TemporalUnit incrementUnitType)

Build a CountableValueRange of a subset of LocalDate values between 2 bounds.

Facade for createTemporalValueRange(Temporal, Temporal, long, TemporalUnit).

Parameters:

from - inclusive minimum

to - exclusive maximum, >= from

incrementUnitAmount - > 0

incrementUnitType - must be supported

createLocalTimeValueRange

public static CountableValueRange<LocalTime> createLocalTimeValueRange(@NonNull LocalTime from,
 @NonNull LocalTime to,
 long incrementUnitAmount,
 @NonNull TemporalUnit incrementUnitType)

Build a CountableValueRange of a subset of LocalTime values between 2 bounds.

Facade for createTemporalValueRange(Temporal, Temporal, long, TemporalUnit).

Parameters:

from - inclusive minimum

to - exclusive maximum, >= from

incrementUnitAmount - > 0

incrementUnitType - must be supported

createLocalDateTimeValueRange

public static CountableValueRange<LocalDateTime> createLocalDateTimeValueRange(@NonNull LocalDateTime from,
 @NonNull LocalDateTime to,
 long incrementUnitAmount,
 @NonNull TemporalUnit incrementUnitType)

Build a CountableValueRange of a subset of LocalDateTime values between 2 bounds.

Facade for createTemporalValueRange(Temporal, Temporal, long, TemporalUnit).

Parameters:

from - inclusive minimum

to - exclusive maximum, >= from

incrementUnitAmount - > 0

incrementUnitType - must be supported

createTemporalValueRange

public static <Temporal_ extends Temporal & Comparable<? super Temporal_>>
@NonNull CountableValueRange<Temporal_> createTemporalValueRange(@NonNull Temporal_ from,
 @NonNull Temporal_ to,
 long incrementUnitAmount,
 @NonNull TemporalUnit incrementUnitType)

Build a CountableValueRange of a subset of Temporal values (such as LocalDate or LocalDateTime) between 2 bounds. All parameters must have the same TemporalUnit.

Parameters:

from - inclusive minimum

to - exclusive maximum, >= from

incrementUnitAmount - > 0

incrementUnitType - must be supported by from and to