Class AudioEqualizerBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.media.AudioEqualizerBuilder

public class AudioEqualizerBuilder
extends Object

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

You can use method chaining to call the builder methods for configuring the AudioEqualizer. Finally, invoke the build method to generate an instance of the AudioEqualizer 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
final AudioEqualizerBuilder	addBands(Collection<? extends EqualizerBand> col)	Calls the addAll method on the ObservableList returned by the AudioEqualizer#getBands() method.
final AudioEqualizerBuilder	addBands(EqualizerBand... elements)	Calls the addAll method on the ObservableList returned by the AudioEqualizer#getBands() method.
AudioEqualizerBuilder	apply(Consumer<AudioEqualizer> func)	Applies a function to the AudioEqualizer instance being constructed.
AudioEqualizer	build()	Builds and returns an instance of the AudioEqualizer class.
AudioEqualizerBuilder	enabled(boolean value)	A builder method that invokes the setEnabled method on the instance being constructed.
AudioEqualizerBuilder	enabledPropertyApply(Consumer<BooleanProperty> op)	Applies a function to the enabledProperty of the instance being constructed.

Methods inherited from class java.lang.Object

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

Method Details

build

public AudioEqualizer build()

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

apply

public AudioEqualizerBuilder apply(Consumer<AudioEqualizer> func)

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

Returns:

builder instance

enabled

public AudioEqualizerBuilder enabled(boolean value)

A builder method that invokes the setEnabled method on the instance being constructed.

Returns:

builder instance

addBands

public final AudioEqualizerBuilder addBands(EqualizerBand... elements)

Calls the addAll method on the ObservableList returned by the AudioEqualizer#getBands() method.

Returns:

builder instance

addBands

public final AudioEqualizerBuilder addBands(Collection<? extends EqualizerBand> col)

Calls the addAll method on the ObservableList returned by the AudioEqualizer#getBands() method.

Returns:

builder instance

enabledPropertyApply

public AudioEqualizerBuilder enabledPropertyApply(Consumer<BooleanProperty> op)

Applies a function to the enabledProperty of the instance being constructed. This serves as a shorthand form of the apply method.

Example:

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

// Use shorthand form
.enabledPropertyApply(prop -> prop.bind(anotherProperty))

Returns:

builder instance