org.cloudburstmc.server.form

Class Form.FormBuilder<F extends Form<R>,T extends Form.FormBuilder<F,T,R>,R>

java.lang.Object

org.cloudburstmc.server.form.Form.FormBuilder<F,T,R>

Direct Known Subclasses:

CustomForm.CustomFormBuilder, ModalForm.ModalFormBuilder, SimpleForm.SimpleFormBuilder

Enclosing class:

Form<R>

public abstract static class Form.FormBuilder<F extends Form<R>,T extends Form.FormBuilder<F,T,R>,R>
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Consumer<Player>>	closeListeners
protected List<Consumer<Player>>	errorListeners
protected List<BiConsumer<Player,R>>	listeners
protected String	title

Constructor Summary

Constructors

Constructor and Description
FormBuilder()

Method Summary

Modifier and Type	Method and Description
abstract F	build()
T	onClose(Consumer<Player> listener) Called when the form is closed
T	onError(Consumer<Player> listener) Called when an error occurs during the response processing That could be caused either by a plugin or wrong response (which shouldn't occur in case of vanilla client)
T	onSubmit(BiConsumer<Player,R> listener) Called when the form is successfully submitted
protected abstract T	self()
T	title(String title) Set a title of the form

Methods inherited from class java.lang.Object

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

Field Detail

title

protected String title

listeners

protected final List<BiConsumer<Player,R>> listeners

closeListeners

protected final List<Consumer<Player>> closeListeners

errorListeners

protected final List<Consumer<Player>> errorListeners

Constructor Detail

FormBuilder

public FormBuilder()

Method Detail

title

public T title(@Nonnull
               String title)

Set a title of the form

Parameters:

title - form title

Returns:

self builder instance

onSubmit

public T onSubmit(@Nonnull
                  BiConsumer<Player,R> listener)

Called when the form is successfully submitted

Parameters:

listener - callback function

Returns:

builder instance

onClose

public T onClose(@Nonnull
                 Consumer<Player> listener)

Called when the form is closed

Parameters:

listener - callback function

Returns:

builder instance

onError

public T onError(@Nonnull
                 Consumer<Player> listener)

Called when an error occurs during the response processing That could be caused either by a plugin or wrong response (which shouldn't occur in case of vanilla client)

Parameters:

listener - callback function

Returns:

builder instance

build

public abstract F build()

Returns:

a new Form instance of given generic type

self

protected abstract T self()