Class KeyCodeCombinationBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.graphics.KeyCodeCombinationBuilder

public class KeyCodeCombinationBuilder
extends Object

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

You can use method chaining to call the builder methods for configuring the KeyCodeCombination. Finally, invoke the build method to generate an instance of the KeyCodeCombination 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
KeyCodeCombinationBuilder	apply(Consumer<KeyCodeCombination> func)	Applies a function to the KeyCodeCombination instance being constructed.
KeyCodeCombination	build()	Builds and returns an instance of the KeyCodeCombination class.
static KeyCodeCombinationBuilder	create(KeyCode code, KeyCombination.Modifier... modifiers)	Accepts the constructor arguments of KeyCodeCombination(KeyCode, KeyCombination.Modifier...) and returns an instance of KeyCodeCombinationBuilder.
static KeyCodeCombinationBuilder	create(KeyCode code, KeyCombination.ModifierValue shift, KeyCombination.ModifierValue control, KeyCombination.ModifierValue alt, KeyCombination.ModifierValue meta, KeyCombination.ModifierValue shortcut)	Accepts the constructor arguments of KeyCodeCombination(KeyCode, KeyCombination.ModifierValue, KeyCombination.ModifierValue, KeyCombination.ModifierValue, KeyCombination.ModifierValue, KeyCombination.ModifierValue) and returns an instance of KeyCodeCombinationBuilder.

Methods inherited from class Object

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

Method Details

create

public static KeyCodeCombinationBuilder create(KeyCode code,
 KeyCombination.ModifierValue shift,
 KeyCombination.ModifierValue control,
 KeyCombination.ModifierValue alt,
 KeyCombination.ModifierValue meta,
 KeyCombination.ModifierValue shortcut)

Accepts the constructor arguments of KeyCodeCombination(KeyCode, KeyCombination.ModifierValue, KeyCombination.ModifierValue, KeyCombination.ModifierValue, KeyCombination.ModifierValue, KeyCombination.ModifierValue) and returns an instance of KeyCodeCombinationBuilder.

Returns:

an instance of the KeyCodeCombinationBuilder.

create

public static KeyCodeCombinationBuilder create(KeyCode code,
 KeyCombination.Modifier... modifiers)

Accepts the constructor arguments of KeyCodeCombination(KeyCode, KeyCombination.Modifier...) and returns an instance of KeyCodeCombinationBuilder.

Returns:

an instance of the KeyCodeCombinationBuilder.

build

public KeyCodeCombination build()

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

apply

public KeyCodeCombinationBuilder apply(Consumer<KeyCodeCombination> func)

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

Returns:

builder instance