Package de.eimmer

Class FeuerwerkEffekt.Builder

java.lang.Object

de.eimmer.FeuerwerkEffekt.Builder

Enclosing class:

FeuerwerkEffekt

public static final class FeuerwerkEffekt.Builder
extends Object

This is a builder for FireworkEffects.

See Also:

• FeuerwerkEffekt.builder()

Method Summary

Modifier and Type	Method	Description
FeuerwerkEffekt	build()	Create a FeuerwerkEffekt from the current contents of this builder.
FeuerwerkEffekt.Builder	flicker(boolean flicker)	Set whether the firework effect should flicker.
FeuerwerkEffekt.Builder	trail(boolean trail)	Set whether the firework effect should have a trail.
FeuerwerkEffekt.Builder	with(FeuerwerkEffekt.Type type)	Specify the type of the firework effect.
FeuerwerkEffekt.Builder	withColor(Farbe farbe)	Add a primary farbe to the firework effect.
FeuerwerkEffekt.Builder	withColor(Farbe... farbes)	Add several primary farbes to the firework effect.
FeuerwerkEffekt.Builder	withColor(Iterable<?> colors)	Add several primary farbes to the firework effect.
FeuerwerkEffekt.Builder	withFade(Farbe farbe)	Add a fade farbe to the firework effect.
FeuerwerkEffekt.Builder	withFade(Farbe... farbes)	Add several fade farbes to the firework effect.
FeuerwerkEffekt.Builder	withFade(Iterable<?> colors)	Add several fade farbes to the firework effect.
FeuerwerkEffekt.Builder	withFlicker()	Add a flicker to the firework effect.
FeuerwerkEffekt.Builder	withTrail()	Add a trail to the firework effect.

Methods inherited from class java.lang.Object

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

Method Details

with

@NotNull
public FeuerwerkEffekt.Builder with(@NotNull
 FeuerwerkEffekt.Type type)
                             throws IllegalArgumentException

Specify the type of the firework effect.

Parameters:

type - The effect type

Returns:

This object, for chaining

Throws:

IllegalArgumentException - If type is null

withFlicker

@NotNull
public FeuerwerkEffekt.Builder withFlicker()

Add a flicker to the firework effect.

Returns:

This object, for chaining

flicker

@NotNull
public FeuerwerkEffekt.Builder flicker(boolean flicker)

Set whether the firework effect should flicker.

Parameters:

flicker - true if it should flicker, false if not

Returns:

This object, for chaining

withTrail

@NotNull
public FeuerwerkEffekt.Builder withTrail()

Add a trail to the firework effect.

Returns:

This object, for chaining

trail

@NotNull
public FeuerwerkEffekt.Builder trail(boolean trail)

Set whether the firework effect should have a trail.

Parameters:

trail - true if it should have a trail, false for no trail

Returns:

This object, for chaining

withColor

@NotNull
public FeuerwerkEffekt.Builder withColor(@NotNull
 Farbe farbe)
                                  throws IllegalArgumentException

Add a primary farbe to the firework effect.

Parameters:

farbe - The farbe to add

Returns:

This object, for chaining

Throws:

IllegalArgumentException - If farbe is null

withColor

@NotNull
public FeuerwerkEffekt.Builder withColor(@NotNull
 Farbe... farbes)
                                  throws IllegalArgumentException

Add several primary farbes to the firework effect.

Parameters:

farbes - The farbes to add

Returns:

This object, for chaining

Throws:

IllegalArgumentException - If farbes is null

IllegalArgumentException - If any color is null (may be thrown after changes have occurred)

withColor

@NotNull
public FeuerwerkEffekt.Builder withColor(@NotNull
 Iterable<?> colors)
                                  throws IllegalArgumentException

Add several primary farbes to the firework effect.

Parameters:

colors - An iterable object whose iterator yields the desired farbes

Returns:

This object, for chaining

Throws:

IllegalArgumentException - If farbes is null

IllegalArgumentException - If any color is null (may be thrown after changes have occurred)

withFade

@NotNull
public FeuerwerkEffekt.Builder withFade(@NotNull
 Farbe farbe)
                                 throws IllegalArgumentException

Add a fade farbe to the firework effect.

Parameters:

farbe - The farbe to add

Returns:

This object, for chaining

Throws:

IllegalArgumentException - If farbes is null

IllegalArgumentException - If any farbe is null (may be thrown after changes have occurred)

withFade

@NotNull
public FeuerwerkEffekt.Builder withFade(@NotNull
 Farbe... farbes)
                                 throws IllegalArgumentException

Add several fade farbes to the firework effect.

Parameters:

farbes - The farbes to add

Returns:

This object, for chaining

Throws:

IllegalArgumentException - If farbes is null

IllegalArgumentException - If any color is null (may be thrown after changes have occurred)

withFade

@NotNull
public FeuerwerkEffekt.Builder withFade(@NotNull
 Iterable<?> colors)
                                 throws IllegalArgumentException

Add several fade farbes to the firework effect.

Parameters:

colors - An iterable object whose iterator yields the desired farbes

Returns:

This object, for chaining

Throws:

IllegalArgumentException - If farbes is null

IllegalArgumentException - If any color is null (may be thrown after changes have occurred)

build

@NotNull
public FeuerwerkEffekt build()

Create a FeuerwerkEffekt from the current contents of this builder.

To successfully build, you must have specified at least one color.

Returns:

The representative firework effect