Package org.spongepowered.api

Interface ResourceKey.Builder

All Superinterfaces:

AbstractBuilder<ResourceKey>, Buildable.Builder<ResourceKey>, Builder<ResourceKey,ResourceKey.Builder>, ResettableBuilder<ResourceKey,ResourceKey.Builder>

Enclosing interface:

ResourceKey

public static interface ResourceKey.Builder
extends Builder<ResourceKey,ResourceKey.Builder>

A builder to create ResourceKeys.

Method Summary

Modifier and Type	Method	Description
ResourceKey	build()	Builds the ResourceKey.
ResourceKey.Builder	namespace(String namespace)	Sets the key's namespace.
default ResourceKey.Builder	namespace(org.spongepowered.plugin.PluginContainer container)	Sets the key's namespace based on the provided PluginContainer's identifier.
ResourceKey.Builder	value(String value)	Sets the key's value.

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

reset

Method Detail

namespace

ResourceKey.Builder namespace(String namespace)

Sets the key's namespace.

If using a ResourceKey.MINECRAFT_NAMESPACE or ResourceKey.SPONGE_NAMESPACE, it is preferable to use ResourceKey.minecraft(String) or ResourceKey.sponge(String) instead.

Parameters:

namespace - The namespace to use

Returns:

This builder, for chaining

namespace

default ResourceKey.Builder namespace(org.spongepowered.plugin.PluginContainer container)

Sets the key's namespace based on the provided PluginContainer's identifier.

Parameters:

container - The plugin container to fetch from

Returns:

This builder, for chaining

value

ResourceKey.Builder value(String value)

Sets the key's value.

Parameters:

value - The value to use

Returns:

This builder, for chaining

build

ResourceKey build()
           throws IllegalStateException

Builds the ResourceKey.

Specified by:

build in interface AbstractBuilder<ResourceKey>

Specified by:

build in interface Buildable.Builder<ResourceKey>

Returns:

The built resource key

Throws:

IllegalStateException - If namespace(String) or value(String) are not set.