Class XYChartSeriesBuilder<X,Y>

java.lang.Object

io.github.sosuisen.jfxbuilder.controls.XYChartSeriesBuilder<X,Y>

public class XYChartSeriesBuilder<X,Y>
extends Object

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

You can use method chaining to call the builder methods for configuring the Series. Finally, invoke the build method to generate an instance of the Series 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 XYChartSeriesBuilder<X,Y>	addData(Collection<? extends XYChart.Data<X,Y>> col)	Calls the addAll method on the ObservableList returned by the Series#getData() method.
final XYChartSeriesBuilder<X,Y>	addData(XYChart.Data<X,Y>... elements)	Calls the addAll method on the ObservableList returned by the Series#getData() method.
XYChartSeriesBuilder<X,Y>	apply(Consumer<XYChart.Series<X,Y>> func)	Applies a function to the Series instance being constructed.
XYChart.Series<X,Y>	build()	Builds and returns an instance of the Series class.
XYChartSeriesBuilder<X,Y>	chartPropertyApply(Consumer<ReadOnlyObjectProperty<XYChart<X,Y>>> op)	Applies a function to the chartProperty of the instance being constructed.
static <X,Y> XYChartSeriesBuilder<X,Y>	create()	Returns an instance of the XYChartSeriesBuilder<X, Y>.
static <X,Y> XYChartSeriesBuilder<X,Y>	create(String name, ObservableList<XYChart.Data<X,Y>> data)	Accepts the constructor arguments of Series(String, ObservableList) and returns an instance of XYChartSeriesBuilder<X, Y>.
static <X,Y> XYChartSeriesBuilder<X,Y>	create(ObservableList<XYChart.Data<X,Y>> data)	Accepts the constructor arguments of Series(ObservableList) and returns an instance of XYChartSeriesBuilder<X, Y>.
XYChartSeriesBuilder<X,Y>	data(ObservableList<XYChart.Data<X,Y>> value)	A builder method that invokes the setData method on the instance being constructed.
XYChartSeriesBuilder<X,Y>	dataPropertyApply(Consumer<ObjectProperty<ObservableList<XYChart.Data<X,Y>>>> op)	Applies a function to the dataProperty of the instance being constructed.
XYChartSeriesBuilder<X,Y>	name(String value)	A builder method that invokes the setName method on the instance being constructed.
XYChartSeriesBuilder<X,Y>	namePropertyApply(Consumer<StringProperty> op)	Applies a function to the nameProperty of the instance being constructed.
XYChartSeriesBuilder<X,Y>	node(Node value)	A builder method that invokes the setNode method on the instance being constructed.
XYChartSeriesBuilder<X,Y>	nodePropertyApply(Consumer<ObjectProperty<Node>> op)	Applies a function to the nodeProperty of the instance being constructed.
static <X,Y> XYChartSeriesBuilder<X,Y>	withData(Collection<? extends XYChart.Data<X,Y>> col)	Creates an instance of the builder, then calls the addAll method on the ObservableList returned by the Series#getData() method.
static <X,Y> XYChartSeriesBuilder<X,Y>	withData(XYChart.Data<X,Y>... elements)	Creates an instance of the builder, then calls the addAll method on the ObservableList returned by the Series#getData() method.

Methods inherited from class Object

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

Method Details

create

public static <X,Y> XYChartSeriesBuilder<X,Y> create()

Returns an instance of the XYChartSeriesBuilder<X, Y>.

Returns:

an instance of the XYChartSeriesBuilder<X, Y>.

create

public static <X,Y> XYChartSeriesBuilder<X,Y> create(String name,
 ObservableList<XYChart.Data<X,Y>> data)

Accepts the constructor arguments of Series(String, ObservableList) and returns an instance of XYChartSeriesBuilder<X, Y>.

Returns:

an instance of the XYChartSeriesBuilder<X, Y>.

create

public static <X,Y> XYChartSeriesBuilder<X,Y> create(ObservableList<XYChart.Data<X,Y>> data)

Accepts the constructor arguments of Series(ObservableList) and returns an instance of XYChartSeriesBuilder<X, Y>.

Returns:

an instance of the XYChartSeriesBuilder<X, Y>.

build

public XYChart.Series<X,Y> build()

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

apply

public XYChartSeriesBuilder<X,Y> apply(Consumer<XYChart.Series<X,Y>> func)

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

Returns:

builder instance

data

public XYChartSeriesBuilder<X,Y> data(ObservableList<XYChart.Data<X,Y>> value)

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

Returns:

builder instance

name

public XYChartSeriesBuilder<X,Y> name(String value)

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

Returns:

builder instance

node

public XYChartSeriesBuilder<X,Y> node(Node value)

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

Returns:

builder instance

addData

@SafeVarargs
public final XYChartSeriesBuilder<X,Y> addData(XYChart.Data<X,Y>... elements)

Calls the addAll method on the ObservableList returned by the Series#getData() method.

Returns:

builder instance

addData

public final XYChartSeriesBuilder<X,Y> addData(Collection<? extends XYChart.Data<X,Y>> col)

Calls the addAll method on the ObservableList returned by the Series#getData() method.

Returns:

builder instance

withData

@SafeVarargs
public static <X,Y> XYChartSeriesBuilder<X,Y> withData(XYChart.Data<X,Y>... elements)

Creates an instance of the builder, then calls the addAll method on the ObservableList returned by the Series#getData() method.

Returns:

builder instance

withData

public static <X,Y> XYChartSeriesBuilder<X,Y> withData(Collection<? extends XYChart.Data<X,Y>> col)

Creates an instance of the builder, then calls the addAll method on the ObservableList returned by the Series#getData() method.

Returns:

builder instance

chartPropertyApply

public XYChartSeriesBuilder<X,Y> chartPropertyApply(Consumer<ReadOnlyObjectProperty<XYChart<X,Y>>> op)

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

Example:

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

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

Returns:

builder instance

dataPropertyApply

public XYChartSeriesBuilder<X,Y> dataPropertyApply(Consumer<ObjectProperty<ObservableList<XYChart.Data<X,Y>>>> op)

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

Example:

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

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

Returns:

builder instance

namePropertyApply

public XYChartSeriesBuilder<X,Y> namePropertyApply(Consumer<StringProperty> op)

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

Example:

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

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

Returns:

builder instance

nodePropertyApply

public XYChartSeriesBuilder<X,Y> nodePropertyApply(Consumer<ObjectProperty<Node>> op)

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

Example:

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

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

Returns:

builder instance