Class BackgroundPositionBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.graphics.BackgroundPositionBuilder

public class BackgroundPositionBuilder
extends Object

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

You can use method chaining to call the builder methods for configuring the BackgroundPosition. Finally, invoke the build method to generate an instance of the BackgroundPosition 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
BackgroundPositionBuilder	apply(Consumer<BackgroundPosition> func)	Applies a function to the BackgroundPosition instance being constructed.
BackgroundPosition	build()	Builds and returns an instance of the BackgroundPosition class.
static BackgroundPositionBuilder	create(Side horizontalSide, double horizontalPosition, boolean horizontalAsPercentage, Side verticalSide, double verticalPosition, boolean verticalAsPercentage)	Accepts the constructor arguments of BackgroundPosition(Side, double, boolean, Side, double, boolean) and returns an instance of BackgroundPositionBuilder.

Methods inherited from class java.lang.Object

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

Method Details

create

public static BackgroundPositionBuilder create(Side horizontalSide,
 double horizontalPosition,
 boolean horizontalAsPercentage,
 Side verticalSide,
 double verticalPosition,
 boolean verticalAsPercentage)

Accepts the constructor arguments of BackgroundPosition(Side, double, boolean, Side, double, boolean) and returns an instance of BackgroundPositionBuilder.

Returns:

an instance of the BackgroundPositionBuilder.

build

public BackgroundPosition build()

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

apply

public BackgroundPositionBuilder apply(Consumer<BackgroundPosition> func)

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

Returns:

builder instance