com.elmakers.mine.bukkit.api.magic

Interface MagicConfigurable

All Superinterfaces:

MagicProperties

All Known Subinterfaces:

CasterProperties, MageClass, Wand

public interface MagicConfigurable
extends MagicProperties

Method Summary

Modifier and Type	Method and Description
void	configure(org.bukkit.configuration.ConfigurationSection configuration) Transfer all properties from a configuration to this store, overwriting any values already present in the store.
void	configure(String key, Object value) Configure a single property.
MagicConfigurable	getStorage(MagicPropertyType storageType) Retrieve the storage associated with a given type
boolean	removeProperty(String key) Remove a property from this store.
boolean	upgrade(org.bukkit.configuration.ConfigurationSection configuration) Transfer properties from a configuration to this store, following a set of upgrade rules: String values are replaced unless they match with a case-insensitve comparison Numeric values are only replaced if they are greater than the ones present already in the store Certain other special rules apply to specific properties, such as spells are merged.
boolean	upgrade(String key, Object value) Upgrade a single property.

Methods inherited from interface com.elmakers.mine.bukkit.api.magic.MagicProperties

describe, describe, getBoolean, getBoolean, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getProperty, getProperty, getProperty, getSectionList, getString, getString, getStringList, hasProperty, isEmpty

Method Detail

configure

void configure(@Nonnull
               org.bukkit.configuration.ConfigurationSection configuration)

Transfer all properties from a configuration to this store, overwriting any values already present in the store.

Parameters:

configuration - The configuration to copy.

configure

void configure(@Nonnull
               String key,
               @Nonnull
               Object value)

Configure a single property.

Do not use this to remove properties, use removeProperty instead.

Do not use this for setting a Map or ConfigurationSection, nested properties should use the above configure method.

Parameters:

key - The property to configure.

value - The new property value.

upgrade

boolean upgrade(@Nonnull
                org.bukkit.configuration.ConfigurationSection configuration)

Transfer properties from a configuration to this store, following a set of upgrade rules:

1. String values are replaced unless they match with a case-insensitve comparison
2. Numeric values are only replaced if they are greater than the ones present already in the store
3. Certain other special rules apply to specific properties, such as spells are merged.

Anything else is copied over directly, overwriting what is in the store.

Parameters:

configuration - The configuration to copy into this store

Returns:

true if any property was changed, false means the upgrade was rejected.

upgrade

boolean upgrade(@Nonnull
                String key,
                @Nonnull
                Object value)

Upgrade a single property.

Do not use this to remove properties, use removeProperty instead.

Parameters:

key - The property to upgrade.

value - The new value to set, if it is an improvement over the current value.

Returns:

true if the property was changed, false means the upgrade was rejected.

removeProperty

boolean removeProperty(String key)

Remove a property from this store.

If this property is inherited, it cannot be removed. If this property exists but an inherited value also exists, the property will now have the inherited value.

Parameters:

key - The key to remove

Returns:

true if the property existed and was removed.

getStorage

MagicConfigurable getStorage(MagicPropertyType storageType)

Retrieve the storage associated with a given type