org.thales.punch.settings.impl

Class SettingsListImpl

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<Object>

org.thales.punch.settings.impl.SettingsListImpl

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Object>, Collection<Object>, List<Object>, RandomAccess, ISettingsList

Direct Known Subclasses:

NamedSettingsListImpl

public class SettingsListImpl
extends ArrayList<Object>
implements ISettingsList

Our implementation of ISettingsList.

Author:

dimi

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	originatorName This can be overridden by NamedSettingsListImpl.

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SettingsListImpl() Only used internally.
protected	SettingsListImpl(List<Object> list, String name) Only used internally.

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)
protected String	getChildName(int index)
static SettingsListImpl	getNewInstance()
String	getOriginatorName()
protected ISettingsList	newSettingsListChild(List<Object> list, String name) Returns a new instance of appropriate Settings list implementation for this settings tree Initialized with same content as a provided list containing The returned object has not been added to the THIS settings map
protected ISettingsList	newSettingsListChild(String name) Returns a new instance of appropriate Settings list implementation for this settings tree The returned object has not been added to the THIS settings map
protected ISettingsMap	newSettingsMapChild(Map<String,Object> map, String name) Returns a new instance of appropriate Settings map implementation for this settings tree Initialized with same content as a provided map containing The returned object has not been added to the THIS settings map
protected ISettingsMap	newSettingsMapChild(String name) Returns a new instance of appropriate Settings map implementation for this settings tree The returned object has not been added to the THIS settings map
void	setOriginatorName(String originatorName)

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

Field Detail

originatorName

protected String originatorName

This can be overridden by NamedSettingsListImpl.

Constructor Detail

SettingsListImpl

protected SettingsListImpl(List<Object> list,
                           String name)

Only used internally. Use the SettingsListBuilder class to create new ones.

Parameters:

list - The settings list to shallow copy

name - The name context to tag all logs/exceptions concerning properties of this map

SettingsListImpl

protected SettingsListImpl()

Only used internally. Use the SettingsListBuilder class to create new ones.

Method Detail

getOriginatorName

public String getOriginatorName()

Specified by:

getOriginatorName in interface ISettingsList

Returns:

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

asStringSettingsList

public List<String> asStringSettingsList()

Specified by:

asStringSettingsList in interface ISettingsList

Returns:

list if all items are Strings (possibly nulls)

asSettingsMapList

public List<ISettingsMap> asSettingsMapList()

Specified by:

asSettingsMapList in interface ISettingsList

Returns:

list if all items are SettingsMap

getChildName

protected String getChildName(int index)

setOriginatorName

public void setOriginatorName(String originatorName)

Specified by:

setOriginatorName in interface ISettingsList

Parameters:

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

getAsBoolean

public Boolean getAsBoolean(int index)

Specified by:

getAsBoolean in interface ISettingsList

Parameters:

index - the element index

Returns:

setting at provided index in list, guaranteed a Boolean class

getAsString

public String getAsString(int index)

Specified by:

getAsString in interface ISettingsList

Parameters:

index - the element index

Returns:

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

getAsLong

public Long getAsLong(int index)

Specified by:

getAsLong in interface ISettingsList

Parameters:

index - the element index

Returns:

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

getAsInteger

public Integer getAsInteger(int index)

Specified by:

getAsInteger in interface ISettingsList

Parameters:

index - the element index

Returns:

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

getAsSettingsList

public ISettingsList getAsSettingsList(int index)

Description copied from interface: ISettingsList

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

Specified by:

getAsSettingsList in interface ISettingsList

Parameters:

index - the element index

Returns:

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

getAsSettingsMap

public ISettingsMap getAsSettingsMap(int index)

Description copied from interface: ISettingsList

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

Specified by:

getAsSettingsMap in interface ISettingsList

Parameters:

index - the element index

Returns:

the element if found, possibly null

newSettingsMapChild

protected ISettingsMap newSettingsMapChild(Map<String,Object> map,
                                           String name)

Returns a new instance of appropriate Settings map implementation for this settings tree Initialized with same content as a provided map containing The returned object has not been added to the THIS settings map

Parameters:

map - an Objects map containing settings, used to initialize the new settings map

name - a name

Returns:

return an ISettingsMap

newSettingsListChild

protected ISettingsList newSettingsListChild(List<Object> list,
                                             String name)

Returns a new instance of appropriate Settings list implementation for this settings tree Initialized with same content as a provided list containing The returned object has not been added to the THIS settings map

Parameters:

list - a list

name - a name

Returns:

return an ISettingsList

newSettingsMapChild

protected ISettingsMap newSettingsMapChild(String name)

Returns a new instance of appropriate Settings map implementation for this settings tree The returned object has not been added to the THIS settings map

Parameters:

name - a name

Returns:

return an ISettingsMap

newSettingsListChild

protected ISettingsList newSettingsListChild(String name)

Returns a new instance of appropriate Settings list implementation for this settings tree The returned object has not been added to the THIS settings map

Parameters:

name - a name

Returns:

return an ISettingsList

asFlatValuesMap

public Map<String,Object> asFlatValuesMap()

Specified by:

asFlatValuesMap in interface ISettingsList

Returns:

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

asFlatValuesMap

public Map<String,Object> asFlatValuesMap(String indexedBy)

Specified by:

asFlatValuesMap in interface ISettingsList

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

public String asJsonString()

Specified by:

asJsonString in interface ISettingsList

Returns:

a Json representation of this settings map.

asJsonString

public String asJsonString(IJsonSerializer s)

Description copied from interface: ISettingsList

This variant accept a serializer to deal with unsupported types.

Specified by:

asJsonString in interface ISettingsList

Parameters:

s - your serializer

Returns:

a Json representation of this settings map.

getNewInstance

public static SettingsListImpl getNewInstance()

Returns:

a new instance. Do not use this, pass through the SettingsListBuilder class.