Class KeyCharacterCombinationBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.graphics.KeyCharacterCombinationBuilder

public class KeyCharacterCombinationBuilder
extends Object

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

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

Methods inherited from class java.lang.Object

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

Method Details

create

public static KeyCharacterCombinationBuilder create(String character,
 KeyCombination.ModifierValue shift,
 KeyCombination.ModifierValue control,
 KeyCombination.ModifierValue alt,
 KeyCombination.ModifierValue meta,
 KeyCombination.ModifierValue shortcut)

Accepts the constructor arguments of KeyCharacterCombination(String, KeyCombination.ModifierValue, KeyCombination.ModifierValue, KeyCombination.ModifierValue, KeyCombination.ModifierValue, KeyCombination.ModifierValue) and returns an instance of KeyCharacterCombinationBuilder.

Returns:

an instance of the KeyCharacterCombinationBuilder.

create

public static KeyCharacterCombinationBuilder create(String character,
 KeyCombination.Modifier... modifiers)

Accepts the constructor arguments of KeyCharacterCombination(String, KeyCombination.Modifier...) and returns an instance of KeyCharacterCombinationBuilder.

Returns:

an instance of the KeyCharacterCombinationBuilder.

build

public KeyCharacterCombination build()

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

apply

public KeyCharacterCombinationBuilder apply(Consumer<KeyCharacterCombination> func)

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

Returns:

builder instance