Class SpinnerValueFactoryListSpinnerValueFactoryBuilder<T>

java.lang.Object

io.github.sosuisen.jfxbuilder.controls.SpinnerValueFactoryListSpinnerValueFactoryBuilder<T>

public class SpinnerValueFactoryListSpinnerValueFactoryBuilder<T>
extends Object

The SpinnerValueFactoryListSpinnerValueFactoryBuilder class constructs instances of the ListSpinnerValueFactory 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 ListSpinnerValueFactory constructor and returns an instance of the SpinnerValueFactoryListSpinnerValueFactoryBuilder.

You can use method chaining to call the builder methods for configuring the ListSpinnerValueFactory. Finally, invoke the build method to generate an instance of the ListSpinnerValueFactory 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
final SpinnerValueFactoryListSpinnerValueFactoryBuilder<T>	addItems(Collection<? extends T> col)	Calls the addAll method on the ObservableList returned by the ListSpinnerValueFactory#getItems() method.
final SpinnerValueFactoryListSpinnerValueFactoryBuilder<T>	addItems(T... elements)	Calls the addAll method on the ObservableList returned by the ListSpinnerValueFactory#getItems() method.
SpinnerValueFactoryListSpinnerValueFactoryBuilder<T>	apply(Consumer<SpinnerValueFactory.ListSpinnerValueFactory<T>> func)	Applies a function to the ListSpinnerValueFactory instance being constructed.
SpinnerValueFactory.ListSpinnerValueFactory<T>	build()	Builds and returns an instance of the ListSpinnerValueFactory class.
SpinnerValueFactoryListSpinnerValueFactoryBuilder<T>	converter(StringConverter<T> newValue)	A builder method that invokes the setConverter method on the instance being constructed.
SpinnerValueFactoryListSpinnerValueFactoryBuilder<T>	converterPropertyApply(Consumer<ObjectProperty<StringConverter<T>>> op)	Applies a function to the converterProperty of the instance being constructed.
static <T> SpinnerValueFactoryListSpinnerValueFactoryBuilder<T>	create(ObservableList<T> items)	Accepts the constructor arguments of ListSpinnerValueFactory(ObservableList) and returns an instance of SpinnerValueFactoryListSpinnerValueFactoryBuilder<T>.
SpinnerValueFactoryListSpinnerValueFactoryBuilder<T>	items(ObservableList<T> value)	A builder method that invokes the setItems method on the instance being constructed.
SpinnerValueFactoryListSpinnerValueFactoryBuilder<T>	itemsPropertyApply(Consumer<ObjectProperty<ObservableList<T>>> op)	Applies a function to the itemsProperty of the instance being constructed.
SpinnerValueFactoryListSpinnerValueFactoryBuilder<T>	value(T newValue)	A builder method that invokes the setValue method on the instance being constructed.
SpinnerValueFactoryListSpinnerValueFactoryBuilder<T>	valuePropertyApply(Consumer<ObjectProperty<T>> op)	Applies a function to the valueProperty of the instance being constructed.
SpinnerValueFactoryListSpinnerValueFactoryBuilder<T>	wrapAround(boolean value)	A builder method that invokes the setWrapAround method on the instance being constructed.
SpinnerValueFactoryListSpinnerValueFactoryBuilder<T>	wrapAroundPropertyApply(Consumer<BooleanProperty> op)	Applies a function to the wrapAroundProperty of the instance being constructed.

Methods inherited from class Object

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

Method Details

create

public static <T>
SpinnerValueFactoryListSpinnerValueFactoryBuilder<T> create(ObservableList<T> items)

Accepts the constructor arguments of ListSpinnerValueFactory(ObservableList) and returns an instance of SpinnerValueFactoryListSpinnerValueFactoryBuilder<T>.

Returns:

an instance of the SpinnerValueFactoryListSpinnerValueFactoryBuilder<T>.

build

public SpinnerValueFactory.ListSpinnerValueFactory<T> build()

Builds and returns an instance of the ListSpinnerValueFactory 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 ListSpinnerValueFactory class

apply

public SpinnerValueFactoryListSpinnerValueFactoryBuilder<T> apply(Consumer<SpinnerValueFactory.ListSpinnerValueFactory<T>> func)

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

Returns:

builder instance

converter

public SpinnerValueFactoryListSpinnerValueFactoryBuilder<T> converter(StringConverter<T> newValue)

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

Returns:

builder instance

items

public SpinnerValueFactoryListSpinnerValueFactoryBuilder<T> items(ObservableList<T> value)

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

Returns:

builder instance

value

public SpinnerValueFactoryListSpinnerValueFactoryBuilder<T> value(T newValue)

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

Returns:

builder instance

wrapAround

public SpinnerValueFactoryListSpinnerValueFactoryBuilder<T> wrapAround(boolean value)

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

Returns:

builder instance

addItems

@SafeVarargs
public final SpinnerValueFactoryListSpinnerValueFactoryBuilder<T> addItems(T... elements)

Calls the addAll method on the ObservableList returned by the ListSpinnerValueFactory#getItems() method.

Returns:

builder instance

addItems

public final SpinnerValueFactoryListSpinnerValueFactoryBuilder<T> addItems(Collection<? extends T> col)

Calls the addAll method on the ObservableList returned by the ListSpinnerValueFactory#getItems() method.

Returns:

builder instance

converterPropertyApply

public SpinnerValueFactoryListSpinnerValueFactoryBuilder<T> converterPropertyApply(Consumer<ObjectProperty<StringConverter<T>>> 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

itemsPropertyApply

public SpinnerValueFactoryListSpinnerValueFactoryBuilder<T> itemsPropertyApply(Consumer<ObjectProperty<ObservableList<T>>> op)

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

Example:

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

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

Returns:

builder instance

valuePropertyApply

public SpinnerValueFactoryListSpinnerValueFactoryBuilder<T> valuePropertyApply(Consumer<ObjectProperty<T>> 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 SpinnerValueFactoryListSpinnerValueFactoryBuilder<T> 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