Class BorderWidthsBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.graphics.BorderWidthsBuilder

public class BorderWidthsBuilder
extends Object

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

You can use method chaining to call the builder methods for configuring the BorderWidths. Finally, invoke the build method to generate an instance of the BorderWidths 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
BorderWidthsBuilder	apply(Consumer<BorderWidths> func)	Applies a function to the BorderWidths instance being constructed.
BorderWidths	build()	Builds and returns an instance of the BorderWidths class.
static BorderWidthsBuilder	create(double width)	Accepts the constructor arguments of BorderWidths(double) and returns an instance of BorderWidthsBuilder.
static BorderWidthsBuilder	create(double top, double right, double bottom, double left)	Accepts the constructor arguments of BorderWidths(double, double, double, double) and returns an instance of BorderWidthsBuilder.
static BorderWidthsBuilder	create(double top, double right, double bottom, double left, boolean topAsPercentage, boolean rightAsPercentage, boolean bottomAsPercentage, boolean leftAsPercentage)	Accepts the constructor arguments of BorderWidths(double, double, double, double, boolean, boolean, boolean, boolean) and returns an instance of BorderWidthsBuilder.

Methods inherited from class Object

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

Method Details

create

public static BorderWidthsBuilder create(double width)

Accepts the constructor arguments of BorderWidths(double) and returns an instance of BorderWidthsBuilder.

Returns:

an instance of the BorderWidthsBuilder.

create

public static BorderWidthsBuilder create(double top,
 double right,
 double bottom,
 double left)

Accepts the constructor arguments of BorderWidths(double, double, double, double) and returns an instance of BorderWidthsBuilder.

Returns:

an instance of the BorderWidthsBuilder.

create

public static BorderWidthsBuilder create(double top,
 double right,
 double bottom,
 double left,
 boolean topAsPercentage,
 boolean rightAsPercentage,
 boolean bottomAsPercentage,
 boolean leftAsPercentage)

Accepts the constructor arguments of BorderWidths(double, double, double, double, boolean, boolean, boolean, boolean) and returns an instance of BorderWidthsBuilder.

Returns:

an instance of the BorderWidthsBuilder.

build

public BorderWidths build()

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

apply

public BorderWidthsBuilder apply(Consumer<BorderWidths> func)

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

Returns:

builder instance