Class SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.controls.SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder

public class SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder
extends Object

The SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder class constructs instances of the IntegerSpinnerValueFactory class and offers a fluent interface for creating and configuring it.

This class includes a static create method that accepts the same arguments as the original IntegerSpinnerValueFactory constructor and returns an instance of the SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder.

You can use method chaining to call the builder methods for configuring the IntegerSpinnerValueFactory. Finally, invoke the build method to generate an instance of the IntegerSpinnerValueFactory class.

Note that intermediate builder methods are not evaluated until the build method is called, meaning they are evaluated lazily.

Author:

Hidekazu Kubota <hidekazu.kubota@gmail.com>

Method Summary

Modifier and Type	Method	Description
SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder	amountToStepBy(int value)	A builder method that invokes the setAmountToStepBy method on the instance being constructed.
SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder	amountToStepByPropertyApply(Consumer<IntegerProperty> op)	Applies a function to the amountToStepByProperty of the instance being constructed.
SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder	apply(Consumer<SpinnerValueFactory.IntegerSpinnerValueFactory> func)	Applies a function to the IntegerSpinnerValueFactory instance being constructed.
SpinnerValueFactory.IntegerSpinnerValueFactory	build()	Builds and returns an instance of the IntegerSpinnerValueFactory class.
SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder	converter(StringConverter<Integer> newValue)	A builder method that invokes the setConverter method on the instance being constructed.
SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder	converterPropertyApply(Consumer<ObjectProperty<StringConverter<Integer>>> op)	Applies a function to the converterProperty of the instance being constructed.
static SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder	create(int min, int max)	Accepts the constructor arguments of IntegerSpinnerValueFactory(int, int) and returns an instance of SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder.
static SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder	create(int min, int max, int initialValue)	Accepts the constructor arguments of IntegerSpinnerValueFactory(int, int, int) and returns an instance of SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder.
static SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder	create(int min, int max, int initialValue, int amountToStepBy)	Accepts the constructor arguments of IntegerSpinnerValueFactory(int, int, int, int) and returns an instance of SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder.
SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder	max(int value)	A builder method that invokes the setMax method on the instance being constructed.
SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder	maxPropertyApply(Consumer<IntegerProperty> op)	Applies a function to the maxProperty of the instance being constructed.
SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder	min(int value)	A builder method that invokes the setMin method on the instance being constructed.
SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder	minPropertyApply(Consumer<IntegerProperty> op)	Applies a function to the minProperty of the instance being constructed.
SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder	value(Integer newValue)	A builder method that invokes the setValue method on the instance being constructed.
SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder	valuePropertyApply(Consumer<ObjectProperty<Integer>> op)	Applies a function to the valueProperty of the instance being constructed.
SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder	wrapAround(boolean value)	A builder method that invokes the setWrapAround method on the instance being constructed.
SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder	wrapAroundPropertyApply(Consumer<BooleanProperty> op)	Applies a function to the wrapAroundProperty of the instance being constructed.

Methods inherited from class java.lang.Object

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

Method Details

create

public static SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder create(int min,
 int max)

Accepts the constructor arguments of IntegerSpinnerValueFactory(int, int) and returns an instance of SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder.

Returns:

an instance of the SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder.

create

public static SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder create(int min,
 int max,
 int initialValue)

Accepts the constructor arguments of IntegerSpinnerValueFactory(int, int, int) and returns an instance of SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder.

Returns:

an instance of the SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder.

create

public static SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder create(int min,
 int max,
 int initialValue,
 int amountToStepBy)

Accepts the constructor arguments of IntegerSpinnerValueFactory(int, int, int, int) and returns an instance of SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder.

Returns:

an instance of the SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder.

build

public SpinnerValueFactory.IntegerSpinnerValueFactory build()

Builds and returns an instance of the IntegerSpinnerValueFactory class.

Intermediate builder methods are not evaluated until the build method is called; in other words, they are evaluated lazily.

Returns:

new instance of the IntegerSpinnerValueFactory class

apply

public SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder apply(Consumer<SpinnerValueFactory.IntegerSpinnerValueFactory> func)

Applies a function to the IntegerSpinnerValueFactory instance being constructed. Most operations on the instance can be performed using this method.

Returns:

builder instance

amountToStepBy

public SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder amountToStepBy(int value)

A builder method that invokes the setAmountToStepBy method on the instance being constructed.

Returns:

builder instance

converter

public SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder converter(StringConverter<Integer> newValue)

A builder method that invokes the setConverter method on the instance being constructed.

Returns:

builder instance

max

public SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder max(int value)

A builder method that invokes the setMax method on the instance being constructed.

Returns:

builder instance

min

public SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder min(int value)

A builder method that invokes the setMin method on the instance being constructed.

Returns:

builder instance

value

public SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder value(Integer newValue)

A builder method that invokes the setValue method on the instance being constructed.

Returns:

builder instance

wrapAround

public SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder wrapAround(boolean value)

A builder method that invokes the setWrapAround method on the instance being constructed.

Returns:

builder instance

amountToStepByPropertyApply

public SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder amountToStepByPropertyApply(Consumer<IntegerProperty> op)

Applies a function to the amountToStepByProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

// Use apply
.apply(obj -> obj.amountToStepByProperty().bind(anotherProperty))

// Use shorthand form
.amountToStepByPropertyApply(prop -> prop.bind(anotherProperty))

Returns:

builder instance

converterPropertyApply

public SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder converterPropertyApply(Consumer<ObjectProperty<StringConverter<Integer>>> op)

Applies a function to the converterProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

// Use apply
.apply(obj -> obj.converterProperty().bind(anotherProperty))

// Use shorthand form
.converterPropertyApply(prop -> prop.bind(anotherProperty))

Returns:

builder instance

maxPropertyApply

public SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder maxPropertyApply(Consumer<IntegerProperty> op)

Applies a function to the maxProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

// Use apply
.apply(obj -> obj.maxProperty().bind(anotherProperty))

// Use shorthand form
.maxPropertyApply(prop -> prop.bind(anotherProperty))

Returns:

builder instance

minPropertyApply

public SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder minPropertyApply(Consumer<IntegerProperty> op)

Applies a function to the minProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

// Use apply
.apply(obj -> obj.minProperty().bind(anotherProperty))

// Use shorthand form
.minPropertyApply(prop -> prop.bind(anotherProperty))

Returns:

builder instance

valuePropertyApply

public SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder valuePropertyApply(Consumer<ObjectProperty<Integer>> op)

Applies a function to the valueProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

// Use apply
.apply(obj -> obj.valueProperty().bind(anotherProperty))

// Use shorthand form
.valuePropertyApply(prop -> prop.bind(anotherProperty))

Returns:

builder instance

wrapAroundPropertyApply

public SpinnerValueFactoryIntegerSpinnerValueFactoryBuilder wrapAroundPropertyApply(Consumer<BooleanProperty> op)

Applies a function to the wrapAroundProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

// Use apply
.apply(obj -> obj.wrapAroundProperty().bind(anotherProperty))

// Use shorthand form
.wrapAroundPropertyApply(prop -> prop.bind(anotherProperty))

Returns:

builder instance