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

Class ImageInputBuilder

java.lang.Object
io.github.sosuisen.jfxbuilder.graphics.ImageInputBuilder
public class ImageInputBuilder extends Object
The ImageInputBuilder class constructs instances of the ImageInput 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 ImageInput constructor and returns an instance of the ImageInputBuilder.

You can use method chaining to call the builder methods for configuring the ImageInput. Finally, invoke the build method to generate an instance of the ImageInput 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 Details

    • create

      public static ImageInputBuilder create()
      Returns an instance of the ImageInputBuilder.
      Returns:
      an instance of the ImageInputBuilder.

    • create

      public static ImageInputBuilder create(Image source)
      Accepts the constructor arguments of ImageInput(Image) and returns an instance of ImageInputBuilder.
      Returns:
      an instance of the ImageInputBuilder.

    • create

      public static ImageInputBuilder create(Image source, double x, double y)
      Accepts the constructor arguments of ImageInput(Image, double, double) and returns an instance of ImageInputBuilder.
      Returns:
      an instance of the ImageInputBuilder.

    • build

      public ImageInput build()
      Builds and returns an instance of the ImageInput 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 ImageInput class

    • apply

      public ImageInputBuilder apply(Consumer<ImageInput> func)
      Applies a function to the ImageInput instance being constructed. Most operations on the instance can be performed using this method.
      Returns:
      builder instance

    • source

      public ImageInputBuilder source(Image value)
      A builder method that invokes the setSource method on the instance being constructed.
      Returns:
      builder instance

    • x

      public ImageInputBuilder x(double value)
      A builder method that invokes the setX method on the instance being constructed.
      Returns:
      builder instance

    • y

      public ImageInputBuilder y(double value)
      A builder method that invokes the setY method on the instance being constructed.
      Returns:
      builder instance

    • sourcePropertyApply

      public ImageInputBuilder sourcePropertyApply(Consumer<ObjectProperty<Image>> op)
      Applies a function to the sourceProperty of the instance being constructed. This serves as a shorthand form of the apply method.

      Example: 

      // Use apply
.apply(obj -> obj.sourceProperty().bind(anotherProperty))

// Use shorthand form
.sourcePropertyApply(prop -> prop.bind(anotherProperty))
      Returns:
      builder instance

    • xPropertyApply

      public ImageInputBuilder xPropertyApply(Consumer<DoubleProperty> op)
      Applies a function to the xProperty of the instance being constructed. This serves as a shorthand form of the apply method.

      Example: 

      // Use apply
.apply(obj -> obj.xProperty().bind(anotherProperty))

// Use shorthand form
.xPropertyApply(prop -> prop.bind(anotherProperty))
      Returns:
      builder instance

    • yPropertyApply

      public ImageInputBuilder yPropertyApply(Consumer<DoubleProperty> op)
      Applies a function to the yProperty of the instance being constructed. This serves as a shorthand form of the apply method.

      Example: 

      // Use apply
.apply(obj -> obj.yProperty().bind(anotherProperty))

// Use shorthand form
.yPropertyApply(prop -> prop.bind(anotherProperty))
      Returns:
      builder instance