Class BackgroundBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.graphics.BackgroundBuilder

public class BackgroundBuilder
extends Object

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

You can use method chaining to call the builder methods for configuring the Background. Finally, invoke the build method to generate an instance of the Background 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
BackgroundBuilder	apply(Consumer<Background> func)	Applies a function to the Background instance being constructed.
Background	build()	Builds and returns an instance of the Background class.
static BackgroundBuilder	create(List<BackgroundFill> fills, List<BackgroundImage> images)	Accepts the constructor arguments of Background(List, List) and returns an instance of BackgroundBuilder.
static BackgroundBuilder	create(BackgroundFill... fills)	Accepts the constructor arguments of Background(BackgroundFill...) and returns an instance of BackgroundBuilder.
static BackgroundBuilder	create(BackgroundFill[] fills, BackgroundImage[] images)	Accepts the constructor arguments of Background(BackgroundFill..., BackgroundImage...) and returns an instance of BackgroundBuilder.
static BackgroundBuilder	create(BackgroundImage... images)	Accepts the constructor arguments of Background(BackgroundImage...) and returns an instance of BackgroundBuilder.

Methods inherited from class Object

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

Method Details

create

public static BackgroundBuilder create(List<BackgroundFill> fills,
 List<BackgroundImage> images)

Accepts the constructor arguments of Background(List, List) and returns an instance of BackgroundBuilder.

Returns:

an instance of the BackgroundBuilder.

create

public static BackgroundBuilder create(BackgroundFill... fills)

Accepts the constructor arguments of Background(BackgroundFill...) and returns an instance of BackgroundBuilder.

Returns:

an instance of the BackgroundBuilder.

create

public static BackgroundBuilder create(BackgroundFill[] fills,
 BackgroundImage[] images)

Accepts the constructor arguments of Background(BackgroundFill..., BackgroundImage...) and returns an instance of BackgroundBuilder.

Returns:

an instance of the BackgroundBuilder.

create

public static BackgroundBuilder create(BackgroundImage... images)

Accepts the constructor arguments of Background(BackgroundImage...) and returns an instance of BackgroundBuilder.

Returns:

an instance of the BackgroundBuilder.

build

public Background build()

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

apply

public BackgroundBuilder apply(Consumer<Background> func)

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

Returns:

builder instance