Module io.github.sosuisen.api.jfxbuilder.graphics

Package io.github.sosuisen.jfxbuilder.graphics

Class ImagePatternBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.graphics.ImagePatternBuilder

public class ImagePatternBuilder
extends Object

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

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

Methods inherited from class java.lang.Object

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

Method Details

create

public static ImagePatternBuilder create(Image image)

Accepts the constructor arguments of ImagePattern(Image) and returns an instance of ImagePatternBuilder.

Returns:

an instance of the ImagePatternBuilder.

create

public static ImagePatternBuilder create(Image image,
 double x,
 double y,
 double width,
 double height,
 boolean proportional)

Accepts the constructor arguments of ImagePattern(Image, double, double, double, double, boolean) and returns an instance of ImagePatternBuilder.

Returns:

an instance of the ImagePatternBuilder.

build

public ImagePattern build()

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

apply

public ImagePatternBuilder apply(Consumer<ImagePattern> func)

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

Returns:

builder instance