Class LinearGradientBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.graphics.LinearGradientBuilder

public class LinearGradientBuilder
extends Object

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

You can use method chaining to call the builder methods for configuring the LinearGradient. Finally, invoke the build method to generate an instance of the LinearGradient 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
LinearGradientBuilder	apply(Consumer<LinearGradient> func)	Applies a function to the LinearGradient instance being constructed.
LinearGradient	build()	Builds and returns an instance of the LinearGradient class.
static LinearGradientBuilder	create(double startX, double startY, double endX, double endY, boolean proportional, CycleMethod cycleMethod, List<Stop> stops)	Accepts the constructor arguments of LinearGradient(double, double, double, double, boolean, CycleMethod, List) and returns an instance of LinearGradientBuilder.
static LinearGradientBuilder	create(double startX, double startY, double endX, double endY, boolean proportional, CycleMethod cycleMethod, Stop... stops)	Accepts the constructor arguments of LinearGradient(double, double, double, double, boolean, CycleMethod, Stop...) and returns an instance of LinearGradientBuilder.

Methods inherited from class Object

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

Method Details

create

public static LinearGradientBuilder create(double startX,
 double startY,
 double endX,
 double endY,
 boolean proportional,
 CycleMethod cycleMethod,
 List<Stop> stops)

Accepts the constructor arguments of LinearGradient(double, double, double, double, boolean, CycleMethod, List) and returns an instance of LinearGradientBuilder.

Returns:

an instance of the LinearGradientBuilder.

create

public static LinearGradientBuilder create(double startX,
 double startY,
 double endX,
 double endY,
 boolean proportional,
 CycleMethod cycleMethod,
 Stop... stops)

Accepts the constructor arguments of LinearGradient(double, double, double, double, boolean, CycleMethod, Stop...) and returns an instance of LinearGradientBuilder.

Returns:

an instance of the LinearGradientBuilder.

build

public LinearGradient build()

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

apply

public LinearGradientBuilder apply(Consumer<LinearGradient> func)

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

Returns:

builder instance