com.elmakers.mine.bukkit.api.magic

Interface MaterialSetManager

public interface MaterialSetManager

Container of material sets.

Method Summary

Modifier and Type	Method and Description
MaterialSet	fromConfig(String name) Loads or creates a material set from a configuration string.
MaterialSet	fromConfig(String name, MaterialSet fallback)
MaterialSet	fromConfigEmpty(String name) Loads or creates a material set from a configuration string.
MaterialMap	getMaterialMap(String name) Looks up a material map by its name.
MaterialSet	getMaterialSet(String name) Looks up a material set by its name.
MaterialSet	getMaterialSet(String name, MaterialSet fallback)
MaterialSet	getMaterialSetEmpty(String name)
Collection<String>	getMaterialSets()
MaterialMap	mapFromConfig(org.bukkit.configuration.ConfigurationSection configuration, String key) Loads or creates a material map from a configuration section.

Method Detail

getMaterialSets

Collection<String> getMaterialSets()

Returns:

An unmodifiable collection of the keys of the available material sets.

getMaterialSet

@Nullable
MaterialSet getMaterialSet(@Nonnull
                                     String name)

Looks up a material set by its name.

Parameters:

name - The name of the material set. One of getMaterialSets().

Returns:

The material set, or null when it is not available.

getMaterialSet

@Nonnull
MaterialSet getMaterialSet(@Nonnull
                                    String name,
                                    @Nonnull
                                    MaterialSet fallback)

getMaterialSetEmpty

@Nonnull
MaterialSet getMaterialSetEmpty(@Nonnull
                                         String name)

getMaterialMap

@Nullable
MaterialMap getMaterialMap(@Nonnull
                                     String name)

Looks up a material map by its name.

Parameters:

name - The name of the material map. One of getMaterialSets().

Returns:

The material map, or null when it is not available or if it is not a map

fromConfig

@Nullable
MaterialSet fromConfig(@Nullable
                                 String name)

Loads or creates a material set from a configuration string.

Parameters:

name - The material set name or parameters.

Returns:

When the name is empty, or an empty string null is returned. In all other cases a MaterialSet is returned. It will either be one named exactly like name, or parsed by the string.

fromConfig

@Nonnull
MaterialSet fromConfig(@Nullable
                                String name,
                                @Nonnull
                                MaterialSet fallback)

fromConfigEmpty

@Nonnull
MaterialSet fromConfigEmpty(@Nullable
                                     String name)

Loads or creates a material set from a configuration string.

Parameters:

name - The material set name or parameters.

Returns:

Instead of returning null, this method returns an empty material set.

See Also:

fromConfig(String)

mapFromConfig

@Nullable
MaterialMap mapFromConfig(org.bukkit.configuration.ConfigurationSection configuration,
                                    String key)

Loads or creates a material map from a configuration section.

Parameters:

configuration - The configuration to load from.

key - The configuration key containing the config to load from. Must be a string (referencing a configured material map) or a configuration section (creating an ad-hoc map)