Package space.arim.dazzleconf.serialiser

Interface FlexibleType

public interface FlexibleType

A type which may be adapted to some other. Inbuilt type conversion is extended by the ValueSerialisers.

All methods throw BadValueException if type conversion failed at some point.

Author:

A248

Method Summary

Modifier and Type	Method	Description
default BadValueException.Builder	badValueExceptionBuilder()	Helper method to begin creating a BadValueException which describes this value.
String	getAssociatedKey()	Gets the key associated with this flexible type.
boolean	getBoolean()	Gets the value as a boolean
byte	getByte()	Gets the value as a byte
char	getCharacter()	Gets the value as a character
Collection<FlexibleType>	getCollection()	Gets the value as a collection of further flexible types.
<E> Collection<E>	getCollection(FlexibleTypeFunction<? extends E> elementProcessor)	Gets the value as a collection of further flexible types (getCollection()) and processes it by converting each flexible type element to a result element.
double	getDouble()	Gets the value as a double
<T extends Enum<T>> T	getEnum(Class<T> enumClass)	Gets the value as an enum type
float	getFloat()	Gets the value as a float
int	getInteger()	Gets the value as an integer
List<FlexibleType>	getList()	Gets the value as a list of further flexible types.
<E> List<E>	getList(FlexibleTypeFunction<? extends E> elementProcessor)	Gets the value as a list of further flexible types (getList()) and processes it by converting each flexible type element to a result element.
long	getLong()	Gets the value as a long
Map<FlexibleType,FlexibleType>	getMap()	Gets the value as a map of further flexible types.
<K, V> Map<K,V>	getMap(FlexibleTypeMapEntryFunction<? extends K,? extends V> entryProcessor)	Gets the value as a map of further flexible types (getMap()) and processes it by converting each pair of flexible types to a map entry.
<T> T	getObject(Class<T> clazz)	Gets this type as some arbitrary object.
Set<FlexibleType>	getSet()	Gets the value as a set of further flexible types.
<E> Set<E>	getSet(FlexibleTypeFunction<? extends E> elementProcessor)	Gets the value as a set of further flexible types (getSet()) and processes it by converting each flexible type element to a result element.
short	getShort()	Gets the value as a short
String	getString()	Gets the value as a string

Method Details

getAssociatedKey

String getAssociatedKey()

Gets the key associated with this flexible type. This is not necessarily the key this object is actually located at. Rather, the associated key is intended to inform the user where the error took place. The returned string may be an absolute key path; its exact details are not specified.

Use badValueExceptionBuilder() to include the key in BadValueExceptions

Returns:

the informative key for this flexible type

badValueExceptionBuilder

default BadValueException.Builder badValueExceptionBuilder()

Helper method to begin creating a BadValueException which describes this value. Uses getAssociatedKey()

Returns:

an exception builder for BadValueException with the key already set

getString

String getString()
          throws BadValueException

Gets the value as a string

Returns:

the string

Throws:

BadValueException - if type conversion failed

getBoolean

boolean getBoolean()
            throws BadValueException

Gets the value as a boolean

Returns:

the boolean

Throws:

BadValueException - if type conversion failed

getByte

byte getByte()
      throws BadValueException

Gets the value as a byte

Returns:

the byte

Throws:

BadValueException - if type conversion failed

getShort

short getShort()
        throws BadValueException

Gets the value as a short

Returns:

the short

Throws:

BadValueException - if type conversion failed

getInteger

int getInteger()
        throws BadValueException

Gets the value as an integer

Returns:

the integer

Throws:

BadValueException - if type conversion failed

getLong

long getLong()
      throws BadValueException

Gets the value as a long

Returns:

the long

Throws:

BadValueException - if type conversion failed

getFloat

float getFloat()
        throws BadValueException

Gets the value as a float

Returns:

the float

Throws:

BadValueException - if type conversion failed

getDouble

double getDouble()
          throws BadValueException

Gets the value as a double

Returns:

the double

Throws:

BadValueException - if type conversion failed

getCharacter

char getCharacter()
           throws BadValueException

Gets the value as a character

Returns:

the character

Throws:

BadValueException - if type conversion failed

getEnum

<T extends Enum<T>> T getEnum(Class<T> enumClass)
                       throws BadValueException

Gets the value as an enum type

Type Parameters:

T - the enum type

Parameters:

enumClass - the enum class

Returns:

the enum value

Throws:

BadValueException - if conversion to the enum failed

NullPointerException - if enumClass is null

getList

List<FlexibleType> getList()
                    throws BadValueException

Gets the value as a list of further flexible types. This operation may fail if the underlying config value is not a collection and ConfigurationOptions.createSingleElementCollections() is false.

Returns:

the list of flexible types

Throws:

BadValueException - if this value cannot be made into a list

getList

<E> List<E> getList(FlexibleTypeFunction<? extends E> elementProcessor)
             throws BadValueException

Gets the value as a list of further flexible types (getList()) and processes it by converting each flexible type element to a result element.

Type Parameters:

E - the element type

Parameters:

elementProcessor - the processor to convert elements

Returns:

the list result

Throws:

BadValueException - if the list cannot be made or any flexible type cannot be made into a result

NullPointerException - if elementProcessor is null

getSet

Set<FlexibleType> getSet()
                  throws BadValueException

Gets the value as a set of further flexible types. This operation may fail if the underlying config value is not a collection and ConfigurationOptions.createSingleElementCollections() is false.

Returns:

the set of flexible types

Throws:

BadValueException - if this value cannot be made into a set

getSet

<E> Set<E> getSet(FlexibleTypeFunction<? extends E> elementProcessor)
           throws BadValueException

Gets the value as a set of further flexible types (getSet()) and processes it by converting each flexible type element to a result element.

Type Parameters:

E - the element type

Parameters:

elementProcessor - the processor to convert elements

Returns:

the set result

Throws:

BadValueException - if the set cannot be made or any flexible type cannot be made into a result

NullPointerException - if elementProcessor is null

getCollection

Collection<FlexibleType> getCollection()
                                throws BadValueException

Gets the value as a collection of further flexible types. This operation may fail if the underlying config value is not a collection and ConfigurationOptions.createSingleElementCollections() is false.

Returns:

the collection of flexible types

Throws:

BadValueException - if this value cannot be made into a collection

getCollection

<E> Collection<E> getCollection(FlexibleTypeFunction<? extends E> elementProcessor)
                         throws BadValueException

Gets the value as a collection of further flexible types (getCollection()) and processes it by converting each flexible type element to a result element.

Type Parameters:

E - the element type

Parameters:

elementProcessor - the processor to convert elements

Returns:

the collection result

Throws:

BadValueException - if the collection cannot be made or any flexible type cannot be made into a result

NullPointerException - if elementProcessor is null

getMap

Map<FlexibleType,FlexibleType> getMap()
                               throws BadValueException

Gets the value as a map of further flexible types. This operation may fail if the underlying config value is not a map.

Returns:

the map of flexible types

Throws:

BadValueException - if this value cannot be made into a map

getMap

<K,
V> Map<K,V> getMap(FlexibleTypeMapEntryFunction<? extends K,? extends V> entryProcessor)
                throws BadValueException

Gets the value as a map of further flexible types (getMap()) and processes it by converting each pair of flexible types to a map entry.

Type Parameters:

K - the value type

V - the value type

Parameters:

entryProcessor - the processor to convert map entries

Returns:

the map result

Throws:

BadValueException - if the map cannot be made or any flexible type cannot be made into a result

NullPointerException - if entryProcessor is null

getObject

<T> T getObject(Class<T> clazz)
         throws BadValueException

Gets this type as some arbitrary object. This may call other configured ValueSerialisers which have been configured for the defined type.

If clazz is String, a primitive, or an enum, this is the same as calling getString(), the corresponding primitive getter, or getEnum(Class). Otherwise, the appropriate serializer is used; if none is found, IllDefinedConfigException is thrown.

Type Parameters:

T - the target type of the object

Parameters:

clazz - the target type's class

Returns:

the object

Throws:

BadValueException - if type conversion failed

IllDefinedConfigException - if no value serializer could be found for the type

NullPointerException - if clazz is null