com.codelanx.codelanxlib.config

Interface Config

All Superinterfaces:

PluginFile

public interface Config
extends PluginFile

Represents a single value that is dynamically retrieved from a FileDataType. This value can be of any type, and the class should typically be implemented through an enum

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

Method Summary

Modifier and Type	Method and Description
default <G,T extends Collection<G>> T	as(Class<? extends Collection> collection, Class<G> type) Attempts to return the Config value as a casted type.
default <K,V,M extends Map<K,V>> M	as(Class<? extends Map> map, Class<K> key, Class<V> value) Attempts to return the Config value as a casted type.
default <T> T	as(Class<T> c) Attempts to return the Config value as a casted type.
static Map<String,Object>	getConfigSectionValue(Object o) Returns a Map representative of the passed Object that represents a section of a YAML file.
default Config	retrieve(FileDataType t) Facade method for retrieve(FileDataType, Config)
static <T extends FileDataType> Config	retrieve(T file, Config config) Retrieves an anonymous value which can utilize a Config parameter to retrieve data from any source
default Config	set(Object val) Sets a value in the FileDataType

Methods inherited from interface com.codelanx.codelanxlib.config.PluginFile

get, getConfig, getData, getDefault, getFileLocation, getPath, init, save, save

Method Detail

as

default <T> T as(Class<T> c)

Attempts to return the Config value as a casted type. If the value cannot be casted it will attempt to return the default value. If the default value is inappropriate for the class, the method will throw a ClassCastException.

Type Parameters:

T - The type of the casting class

Parameters:

c - The class type to cast to

Returns:

A casted value, or null if unable to cast. If the passed class parameter is of a primitive type or autoboxed primitive, then a casted value of -1 is returned, or false for booleans. If the passed class parameter is for String, then Object.toString() is called on the value instead

Since:

0.1.0

as

default <G,T extends Collection<G>> T as(Class<? extends Collection> collection,
                                         Class<G> type)

Attempts to return the Config value as a casted type. If the value cannot be casted it will attempt to return the default value. If the default value is inappropriate for the class, the method will throw a ClassCastException. This exception is also throwing if the type used for the members contained within the collection are incorrect

Type Parameters:

T - The type of the casting class

G - The type of the collection's contents

Parameters:

collection - The collection type to cast to

type - The generic bounding for the collection

Returns:

A casted value, or null if unable to cast. If the passed class parameter is of a primitive type or autoboxed primitive, then a casted value of -1 is returned, or false for booleans. If the passed class parameter is for String, then Object.toString() is called on the value instead

Since:

0.1.0

as

default <K,V,M extends Map<K,V>> M as(Class<? extends Map> map,
                                      Class<K> key,
                                      Class<V> value)

Attempts to return the Config value as a casted type. If the value cannot be casted it will attempt to return the default value. If the default value is inappropriate for the class, the method will throw a ClassCastException. This exception is also throwing if the type used for the members contained within the collection are incorrect

Type Parameters:

K - The type of the keys for this map

V - The type of the values for this map

M - The type of the map

Parameters:

map - The class object of the map type to use

key - The class object of the key types

value - The class object of the value types

Returns:

A casted value, or null if unable to cast. If the passed class parameter is of a primitive type or autoboxed primitive, then a casted value of -1 is returned, or false for booleans. If the passed class parameter is for String, then Object.toString() is called on the value instead

Since:

0.1.0

set

default Config set(Object val)

Sets a value in the FileDataType

Parameters:

val - The value to set

Returns:

The previous Config value

Since:

0.1.0

getConfigSectionValue

static Map<String,Object> getConfigSectionValue(Object o)

Returns a Map representative of the passed Object that represents a section of a YAML file. This method neglects the implementation of the section (whether it be ConfigurationSection or just a Map), and returns the appropriate value.

Parameters:

o - The object to interpret

Returns:

A Map representing the section

Since:

0.1.0

retrieve

static <T extends FileDataType> Config retrieve(T file,
                                                Config config)

Retrieves an anonymous value which can utilize a Config parameter to retrieve data from any source

Type Parameters:

T - Represents a FileDataType passed to the method

Parameters:

file - The FileDataType to use

config - The Config value to search with

Returns:

An anonymous class wrapping of the configuration and keys

Since:

0.1.0

retrieve

default Config retrieve(FileDataType t)

Facade method for retrieve(FileDataType, Config)

Parameters:

t - A FileDataType to retrieve this config value from

Returns:

A config value that can be used to retrieve values from

Since:

0.1.0

See Also:

retrieve(FileDataType, Config)