Class BackgroundSizeBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.graphics.BackgroundSizeBuilder

public class BackgroundSizeBuilder
extends Object

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

You can use method chaining to call the builder methods for configuring the BackgroundSize. Finally, invoke the build method to generate an instance of the BackgroundSize 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
BackgroundSizeBuilder	apply(Consumer<BackgroundSize> func)	Applies a function to the BackgroundSize instance being constructed.
BackgroundSize	build()	Builds and returns an instance of the BackgroundSize class.
static BackgroundSizeBuilder	create(double width, double height, boolean widthAsPercentage, boolean heightAsPercentage, boolean contain, boolean cover)	Accepts the constructor arguments of BackgroundSize(double, double, boolean, boolean, boolean, boolean) and returns an instance of BackgroundSizeBuilder.

Methods inherited from class java.lang.Object

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

Method Details

create

public static BackgroundSizeBuilder create(double width,
 double height,
 boolean widthAsPercentage,
 boolean heightAsPercentage,
 boolean contain,
 boolean cover)

Accepts the constructor arguments of BackgroundSize(double, double, boolean, boolean, boolean, boolean) and returns an instance of BackgroundSizeBuilder.

Returns:

an instance of the BackgroundSizeBuilder.

build

public BackgroundSize build()

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

apply

public BackgroundSizeBuilder apply(Consumer<BackgroundSize> func)

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

Returns:

builder instance