org.spongepowered.api.advancement.criteria.trigger

Interface Trigger.Builder<C extends FilteredTriggerConfiguration>

Type Parameters:

C - The configuration type

All Superinterfaces:

ResettableBuilder<Trigger<C>,Trigger.Builder<C>>

Enclosing interface:

Trigger<C extends FilteredTriggerConfiguration>

public static interface Trigger.Builder<C extends FilteredTriggerConfiguration>
extends ResettableBuilder<Trigger<C>,Trigger.Builder<C>>

A builder to create Triggers.

Method Summary

Modifier and Type	Method and Description
Trigger<C>	build() Builds a Trigger.
<T extends FilteredTriggerConfiguration & DataSerializable> Trigger.Builder<T>	dataSerializableConfig(Class<T> dataConfigClass) Sets the class for the FilteredTriggerConfiguration as a DataSerializable.
Trigger.Builder<FilteredTriggerConfiguration.Empty>	emptyConfig() Sets the class for the FilteredTriggerConfiguration to use FilteredTriggerConfiguration.Empty.
default Trigger.Builder<C>	from(Trigger<C> value) Deprecated.
Trigger.Builder<C>	id(String id) Sets the identifier of the Trigger (without the namespace).
<T extends FilteredTriggerConfiguration> Trigger.Builder<T>	jsonSerializableConfig(Class<T> configClass) Sets the class for the FilteredTriggerConfiguration as a json serializable.
<T extends FilteredTriggerConfiguration> Trigger.Builder<T>	jsonSerializableConfig(Class<T> configClass, com.google.gson.Gson gson) Sets the class for the FilteredTriggerConfiguration as a json serializable.
Trigger.Builder<C>	listener(Consumer<CriterionEvent.Trigger<C>> eventListener) Adds the Consumer to handle the triggers.
Trigger.Builder<C>	name(String name) Sets the name of the Trigger.
<T extends FilteredTriggerConfiguration> Trigger.Builder<T>	typeSerializableConfig(Class<T> configClass) Sets the class for the FilteredTriggerConfiguration as a config serializable.
<T extends FilteredTriggerConfiguration> Trigger.Builder<T>	typeSerializableConfig(Class<T> configClass, TypeSerializerCollection typeSerializerCollection) Sets the class for the FilteredTriggerConfiguration as a config serializable.

Methods inherited from interface org.spongepowered.api.util.ResettableBuilder

reset

Method Detail

dataSerializableConfig

<T extends FilteredTriggerConfiguration & DataSerializable> Trigger.Builder<T> dataSerializableConfig(Class<T> dataConfigClass)

Sets the class for the FilteredTriggerConfiguration as a DataSerializable. The configuration will be constructed using the DataBuilder that is registered for the DataSerializable.

Type Parameters:

T - The configuration type

Parameters:

dataConfigClass - The configuration class

Returns:

This builder, for chaining

typeSerializableConfig

<T extends FilteredTriggerConfiguration> Trigger.Builder<T> typeSerializableConfig(Class<T> configClass)

Sets the class for the FilteredTriggerConfiguration as a config serializable. This configuration will be constructed using Configurate (with TypeSerializers).

Type Parameters:

T - The configuration type

Parameters:

configClass - The configuration class

Returns:

This builder, for chaining

typeSerializableConfig

<T extends FilteredTriggerConfiguration> Trigger.Builder<T> typeSerializableConfig(Class<T> configClass,
                                                                                   TypeSerializerCollection typeSerializerCollection)

Sets the class for the FilteredTriggerConfiguration as a config serializable. This configuration will be constructed using Configurate (with TypeSerializers) with a specific TypeSerializerCollection instead of the global one.

Type Parameters:

T - The configuration type

Parameters:

configClass - The configuration class

typeSerializerCollection - The type serializer collection

Returns:

This builder, for chaining

jsonSerializableConfig

<T extends FilteredTriggerConfiguration> Trigger.Builder<T> jsonSerializableConfig(Class<T> configClass,
                                                                                   com.google.gson.Gson gson)

Sets the class for the FilteredTriggerConfiguration as a json serializable. This configuration will be constructed using the provided Gson instance.

Type Parameters:

T - The configuration type

Parameters:

configClass - The configuration class

gson - The gson instance to use

Returns:

This builder, for chaining

jsonSerializableConfig

<T extends FilteredTriggerConfiguration> Trigger.Builder<T> jsonSerializableConfig(Class<T> configClass)

Sets the class for the FilteredTriggerConfiguration as a json serializable. This configuration will be constructed using the default Gson instance.

Type Parameters:

T - The configuration type

Parameters:

configClass - The configuration class

Returns:

This builder, for chaining

emptyConfig

Trigger.Builder<FilteredTriggerConfiguration.Empty> emptyConfig()

Sets the class for the FilteredTriggerConfiguration to use FilteredTriggerConfiguration.Empty.

Returns:

This builder, for chaining

listener

Trigger.Builder<C> listener(Consumer<CriterionEvent.Trigger<C>> eventListener)

Adds the Consumer to handle the triggers. If no handler is provided then will the result of the trigger always be true, which results in triggering the Criterion.

The Cause of the event should be used to determine whether the configuration matches the requirements to trigger the criterion.

Parameters:

eventListener - The event listener

Returns:

This builder, for chaining

id

Trigger.Builder<C> id(String id)

Sets the identifier of the Trigger (without the namespace).

Parameters:

id - The identifier

Returns:

This builder, for chaining

name

Trigger.Builder<C> name(String name)

Sets the name of the Trigger. Defaults to the identifier (id(String)).

Parameters:

name - The name

Returns:

This builder, for chaining

build

Trigger<C> build()

Builds a Trigger.

Returns:

The trigger type

from

@Deprecated
default Trigger.Builder<C> from(Trigger<C> value)
                                     throws UnsupportedOperationException

Deprecated.

Description copied from interface: ResettableBuilder

Resets this builder to the values of the given built object.

Specified by:

from in interface ResettableBuilder<Trigger<C extends FilteredTriggerConfiguration>,Trigger.Builder<C extends FilteredTriggerConfiguration>>

Parameters:

value - The built object

Returns:

This builder, for chaining

Throws:

UnsupportedOperationException