org.eth.cyril.util.configuration

Interface ConfigurationArray

All Superinterfaces:

java.lang.Iterable<java.lang.Object>

All Known Subinterfaces:

EditableConfigurationArray

All Known Implementing Classes:

JsonConfigurationArray

public interface ConfigurationArray
extends java.lang.Iterable<java.lang.Object>

A configuration array holds different configuration values indexable by numbers.

Method Summary

Modifier and Type	Method and Description
default java.lang.Object	get(int i) Gets the object stored at index i.
boolean	getBoolean(int i) Gets the boolean stored at index i.
Configuration	getConfiguration(int i) Gets the Configuration stored at index i.
ConfigurationArray	getInner(int i) Gets the ConfigurationArray stored at index i.
java.lang.Number	getNumber(int i) Gets the number stored at index i.
default java.lang.Object[]	getRawData() Gets an array of the raw data stored in this configuration array.
default <T> T[]	getRawDataOfType(java.lang.Class<T> clazz) Gets an array of the raw data stored in this configuration array.
java.lang.String	getString(int i) Gets the String stored at index i.
default boolean	hasBoolean(int i) Returns whether there is a boolean stored at index i.
default boolean	hasConfiguration(int i) Returns whether there is a Configuration stored at index i.
default boolean	hasInner(int i) Returns whether there is a ConfigurationArray stored at index i.
default boolean	hasNumber(int i) Returns whether there is a number stored at index i.
default boolean	hasString(int i) Returns whether there is a String stored at index i.
default java.util.Iterator<java.lang.Object>	iterator() Returns an iterator through the array.
int	size() The size of the array.
default java.util.Optional<java.lang.Boolean>	tryGetBoolean(int i) Safe version to get the boolean stored at index i.
default java.util.Optional<Configuration>	tryGetConfiguration(int i) Safe version to get the Configuration stored at index i.
default java.util.Optional<ConfigurationArray>	tryGetInner(int i) Safe version to get the ConfigurationArray stored at index i.
default java.util.Optional<java.lang.Number>	tryGetNumber(int i) Safe version to get the number stored at index i.
default java.util.Optional<java.lang.String>	tryGetString(int i) Safe version to get the String stored at index i.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

size

int size()

The size of the array. The method get(int) is certain to return an object for any index in [0, size).

getNumber

java.lang.Number getNumber(int i)
                    throws NoSuchPropertyException

Gets the number stored at index i.

Parameters:

i - The index.

Returns:

The number stored at index i.

Throws:

NoSuchPropertyException - If there is no number stored at the given index.

tryGetNumber

default java.util.Optional<java.lang.Number> tryGetNumber(int i)

Safe version to get the number stored at index i.

Parameters:

i - The index.

Returns:

The number stored at index i, or an empty optional if there is no number stored at the given index.

hasNumber

default boolean hasNumber(int i)

Returns whether there is a number stored at index i. If it returns true, then getNumber(int) will not throw an exception and tryGetNumber(int) won't return an empty optional.

Parameters:

i - The index.

Returns:

Whether there is a number stored at index i.

getBoolean

boolean getBoolean(int i)
            throws NoSuchPropertyException

Gets the boolean stored at index i.

Parameters:

i - The index.

Returns:

The boolean stored at index i.

Throws:

NoSuchPropertyException - If there is no boolean stored at the given index.

tryGetBoolean

default java.util.Optional<java.lang.Boolean> tryGetBoolean(int i)

Safe version to get the boolean stored at index i.

Parameters:

i - The index.

Returns:

The boolean stored at index i, or an empty optional if there is no boolean stored at the given index.

hasBoolean

default boolean hasBoolean(int i)

Returns whether there is a boolean stored at index i. If it returns true, then getBoolean(int) will not throw an exception and tryGetBoolean(int) won't return an empty optional.

Parameters:

i - The index.

Returns:

Whether there is a boolean stored at index i.

getString

java.lang.String getString(int i)
                    throws NoSuchPropertyException

Gets the String stored at index i.

Parameters:

i - The index.

Returns:

The String stored at index i.

Throws:

NoSuchPropertyException - If there is no String stored at the given index.

tryGetString

default java.util.Optional<java.lang.String> tryGetString(int i)

Safe version to get the String stored at index i.

Parameters:

i - The index.

Returns:

The String stored at index i, or an empty optional if there is no String stored at the given index.

hasString

default boolean hasString(int i)

Returns whether there is a String stored at index i. If it returns true, then getString(int) will not throw an exception and tryGetString(int) won't return an empty optional.

Parameters:

i - The index.

Returns:

Whether there is a String stored at index i.

getConfiguration

Configuration getConfiguration(int i)
                        throws NoSuchPropertyException

Gets the Configuration stored at index i.

Parameters:

i - The index.

Returns:

The Configuration stored at index i.

Throws:

NoSuchPropertyException - If there is no Configuration stored at the given index.

tryGetConfiguration

default java.util.Optional<Configuration> tryGetConfiguration(int i)

Safe version to get the Configuration stored at index i.

Parameters:

i - The index.

Returns:

The Configuration stored at index i, or an empty optional if there is no Configuration stored at the given index.

hasConfiguration

default boolean hasConfiguration(int i)

Returns whether there is a Configuration stored at index i. If it returns true, then getConfiguration(int) will not throw an exception and tryGetConfiguration(int) won't return an empty optional.

Parameters:

i - The index.

Returns:

Whether there is a Configuration stored at index i.

getInner

ConfigurationArray getInner(int i)
                     throws NoSuchPropertyException

Gets the ConfigurationArray stored at index i.

Parameters:

i - The index.

Returns:

The ConfigurationArray stored at index i.

Throws:

NoSuchPropertyException - If there is no ConfigurationArray stored at the given index.

tryGetInner

default java.util.Optional<ConfigurationArray> tryGetInner(int i)

Safe version to get the ConfigurationArray stored at index i.

Parameters:

i - The index.

Returns:

The ConfigurationArray stored at index i, or an empty optional if there is no ConfigurationArray stored at the given index.

hasInner

default boolean hasInner(int i)

Returns whether there is a ConfigurationArray stored at index i. If it returns true, then getInner(int) will not throw an exception and tryGetInner(int) won't return an empty optional.

Parameters:

i - The index.

Returns:

Whether there is a ConfigurationArray stored at index i.

get

default java.lang.Object get(int i)

Gets the object stored at index i.

Parameters:

i - The index.

Returns:

The object stored at index i.

Throws:

java.lang.IndexOutOfBoundsException - If the given index is not in the interval [0, size()).

getRawData

default java.lang.Object[] getRawData()

Gets an array of the raw data stored in this configuration array. Each element is of one of the types for which getter methods exist.

getRawDataOfType

default <T> T[] getRawDataOfType(java.lang.Class<T> clazz)

Gets an array of the raw data stored in this configuration array. Each element is either a non-null instance of the given type, or null.

iterator

default java.util.Iterator<java.lang.Object> iterator()

Returns an iterator through the array.

Specified by:

iterator in interface java.lang.Iterable<java.lang.Object>