com.elmakers.mine.bukkit.api.magic

Interface MagicProperties

All Known Subinterfaces:

CasterProperties, MageClass, MageClassTemplate, MagicConfigurable, ModifierTemplate, Wand, WandTemplate

public interface MagicProperties

Method Summary

Modifier and Type	Method and Description
void	describe(org.bukkit.command.CommandSender sender) Print all properties to a CommandSender in a human-readable format.
void	describe(org.bukkit.command.CommandSender sender, Set<String> ignoreProperties) Print all properties except those in a specific set.
boolean	getBoolean(String key)
boolean	getBoolean(String key, boolean defaultValue)
double	getDouble(String key)
double	getDouble(String key, double defaultValue)
float	getFloat(String key)
float	getFloat(String key, float defaultValue)
int	getInt(String key)
int	getInt(String key, int defaultValue)
long	getLong(String key)
long	getLong(String key, long defaultValue)
Object	getProperty(String key) Return the raw value of a key in the store, or null if the key is not present.
<T> T	getProperty(String key, Class<T> type) Get a property only if it is of a specific type.
<T> T	getProperty(String key, T defaultValue) Get a property, specifying a default value.
List<org.bukkit.configuration.ConfigurationSection>	getSectionList(String key)
String	getString(String key)
String	getString(String key, String defaultValue)
List<String>	getStringList(String key)
boolean	hasProperty(String key) Check to see if this property store contains a specific property.
boolean	isEmpty() Check to see if there is any data here at all.

Method Detail

hasProperty

boolean hasProperty(@Nonnull
                    String key)

Check to see if this property store contains a specific property.

If this is an inherited store (such as a Wand to a WandTemplate), inherited properties are checked as well.

Parameters:

key - The key to check

Returns:

true if this store has the specified key.

getProperty

@Nullable
Object getProperty(@Nonnull
                             String key)

Return the raw value of a key in the store, or null if the key is not present.

Parameters:

key - The key to retrieve

Returns:

The raw value stored for the given key, or null if not present.

getProperty

@Nullable
<T> T getProperty(@Nonnull
                            String key,
                            @Nonnull
                            Class<T> type)

Get a property only if it is of a specific type.

Type Parameters:

T - The property type.

Parameters:

key - The key to retrieve

type - The class the value is expected to be

Returns:

An Optional wrapper for the value

getProperty

@Nonnull
<T> T getProperty(@Nonnull
                           String key,
                           @Nonnull
                           T defaultValue)

Get a property, specifying a default value.

Type Parameters:

T - The property type.

Parameters:

key - The key to retrieve

defaultValue - The value to return if the key is not present in the store or is not the correct type.

Returns:

The value, if present and of the correct type, otherwise returns defaultValue

describe

void describe(org.bukkit.command.CommandSender sender)

Print all properties to a CommandSender in a human-readable format.

Parameters:

sender - Where to print properties.

describe

void describe(org.bukkit.command.CommandSender sender,
              @Nullable
              Set<String> ignoreProperties)

Print all properties except those in a specific set.

Useful for differentiating between inherited and non-inherited properties.

Parameters:

sender - Where to print properties.

ignoreProperties - A set of properties to ignore

isEmpty

boolean isEmpty()

Check to see if there is any data here at all.

Returns:

False if there are any keys set on this property holder directly.

getDouble

double getDouble(String key,
                 double defaultValue)

getDouble

double getDouble(String key)

getFloat

float getFloat(String key,
               float defaultValue)

getFloat

float getFloat(String key)

getInt

int getInt(String key,
           int defaultValue)

getInt

int getInt(String key)

getLong

long getLong(String key,
             long defaultValue)

getLong

long getLong(String key)

getBoolean

boolean getBoolean(String key,
                   boolean defaultValue)

getBoolean

boolean getBoolean(String key)

getString

String getString(String key,
                 String defaultValue)

getString

String getString(String key)

getStringList

@Nullable
List<String> getStringList(String key)

getSectionList

@Nullable
List<org.bukkit.configuration.ConfigurationSection> getSectionList(String key)