org.spongepowered.api.util

Interface CatalogBuilder<C extends CatalogType,B extends ResettableBuilder<C,B>>

All Superinterfaces:

ResettableBuilder<C,B>

All Known Subinterfaces:

Advancement.Builder, AdvancementTree.Builder, DataRegistration.Builder<T,I>, Key.Builder<E,V>, ShapedCraftingRecipe.Builder.EndStep, ShapelessCraftingRecipe.Builder.EndStep, SmeltingRecipe.Builder.EndStep

public interface CatalogBuilder<C extends CatalogType,B extends ResettableBuilder<C,B>>
extends ResettableBuilder<C,B>

A base builder to construct CatalogTypes.

Method Summary

Modifier and Type	Method and Description
C	build() Builds the CatalogType of type C.
default B	from(C value) Deprecated. It's not allowed to duplicate catalog types.
B	id(String id) Sets the id of the CatalogType (without the namespace/plugin id).
B	name(String name) Sets the name of the CatalogType.
B	name(Translation translation) Sets the name of the CatalogType as a Translation.

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

reset

Method Detail

id

B id(String id)

Sets the id of the CatalogType (without the namespace/plugin id).

Parameters:

id - The id

Returns:

This builder for chaining

name

B name(String name)

Sets the name of the CatalogType. Defaults to id(String).

Parameters:

name - The name

Returns:

This builder for chaining

name

B name(Translation translation)

Sets the name of the CatalogType as a Translation. Defaults to id(java.lang.String).

Parameters:

translation - The name translation

Returns:

This builder for chaining

build

C build()
 throws IllegalStateException

Builds the CatalogType of type C.

The last PluginContainer in the cause stack will be used to determine which plugin was used to construct the CatalogType.

Returns:

The built catalog type

Throws:

IllegalStateException - If not all required options were specified

from

@Deprecated
default B from(C value)

Deprecated. It's not allowed to duplicate catalog types.

Description copied from interface: ResettableBuilder

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

Specified by:

from in interface ResettableBuilder<C extends CatalogType,B extends ResettableBuilder<C,B>>

Parameters:

value - The built object

Returns:

This builder, for chaining