org.thales.punch.settings.api

Interface ISettingsList

All Superinterfaces:

Collection<Object>, Iterable<Object>, List<Object>

All Known Implementing Classes:

JsonSettingsListImpl, NamedSettingsListImpl, SettingsListImpl

public interface ISettingsList
extends List<Object>

A list of configuration items. If you need one checkout SettingsListBuilder.

Author:

dimi

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	asFlatValuesMap()
Map<String,Object>	asFlatValuesMap(String indexedBy)
String	asJsonString()
String	asJsonString(IJsonSerializer s) This variant accept a serializer to deal with unsupported types.
List<ISettingsMap>	asSettingsMapList()
List<String>	asStringSettingsList()
Boolean	getAsBoolean(int index)
Integer	getAsInteger(int index)
Long	getAsLong(int index)
ISettingsList	getAsSettingsList(int index) Return the ith element of a list, expecting it to be a ISettingsList.
ISettingsMap	getAsSettingsMap(int index) Return the ith element of a list, expecting it to be a ISettingsMap.
String	getAsString(int index)
String	getOriginatorName()
void	setOriginatorName(String name)

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

asStringSettingsList

List<String> asStringSettingsList()

Returns:

list if all items are Strings (possibly nulls)

Throws:

UnexpectedSettingTypeException - if any item is not a string

asSettingsMapList

List<ISettingsMap> asSettingsMapList()

Returns:

list if all items are SettingsMap

Throws:

UnexpectedSettingTypeException - if any item is not a SettingsMap

getAsBoolean

Boolean getAsBoolean(int index)

Parameters:

index - the element index

Returns:

setting at provided index in list, guaranteed a Boolean class

Throws:

UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property

getAsString

String getAsString(int index)

Parameters:

index - the element index

Returns:

setting at provided index in list, guaranteed null or a String class

Throws:

UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property

getAsLong

Long getAsLong(int index)

Parameters:

index - the element index

Returns:

setting at provided index in list, guaranteed null or a Long class

Throws:

UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property

getAsInteger

Integer getAsInteger(int index)

Parameters:

index - the element index

Returns:

setting at provided index in list, guaranteed null or of Integer class

Throws:

UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property

getAsSettingsList

ISettingsList getAsSettingsList(int index)

Return the ith element of a list, expecting it to be a ISettingsList.

Parameters:

index - the element index

Returns:

setting at provided index in list, guaranteed null or an extension of SettingsList

Throws:

UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property

getAsSettingsMap

ISettingsMap getAsSettingsMap(int index)

Return the ith element of a list, expecting it to be a ISettingsMap.

Parameters:

index - the element index

Returns:

the element if found, possibly null

Throws:

UnexpectedSettingTypeException - runtime exception if requested type is not actual type of non-null property

setOriginatorName

void setOriginatorName(String name)

Parameters:

name - that should be used to identify naming context in exception/log strings by default, name is class name.

getOriginatorName

String getOriginatorName()

Returns:

current value of string used to identify naming context in exception/log strings.

asFlatValuesMap

Map<String,Object> asFlatValuesMap()

Returns:

a value map indexed by dotted key path "0"."subsetting"."setting" => value with 0-based indexing of list children

asFlatValuesMap

Map<String,Object> asFlatValuesMap(String indexedBy)

Parameters:

indexedBy - a character that will be used as seperator

Returns:

a value map indexed by dotted key path "0"."subsetting"."setting" => value with 0-based indexing of list children

asJsonString

String asJsonString()

Returns:

a Json representation of this settings map.

asJsonString

String asJsonString(IJsonSerializer s)

This variant accept a serializer to deal with unsupported types.

Parameters:

s - your serializer

Returns:

a Json representation of this settings map.