Package com.mrivanplays.annotationconfig.yaml

Class SectionObjectList<T>

java.lang.Object

com.mrivanplays.annotationconfig.yaml.SectionObjectList<T>

All Implemented Interfaces:

Iterable<Map.Entry<String,T>>

public final class SectionObjectList<T>
extends Object
implements Iterable<Map.Entry<String,T>>

Represents a section list. A YAML example:

 foo:
   bar:
     baz: aa
     lorem: ipsum
     dolor: sit
     amet: lorem
   ipsum:
     baz: bb
     lorem: dolor
     dolor: lorem
     amet: ipsum
 

How to use: you have to register a SectionObjectListSerializer with the help of a TypeToken in order for this list to properly (de)serialize.

Since:

v2.1.1

Author:

MrIvanPlays

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SectionObjectList.SectionObjectListBuilder<T>	Represents a builder of SectionObjectList

Method Summary

Modifier and Type	Method	Description
Map<String,T>	getAsMap()	Returns an unmodifiable representation of this SectionObjectList as a Map
Class<? extends T>	getObjectsType()	Returns the Class type of the value objects held in this section object list.
Iterator<Map.Entry<String,T>>	iterator()
static <T> SectionObjectList.SectionObjectListBuilder<T>	newBuilderForType(Class<? extends T> type)	Creates a new SectionObjectList.SectionObjectListBuilder with pre-defined Class type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Details

newBuilderForType

public static <T>
SectionObjectList.SectionObjectListBuilder<T> newBuilderForType(Class<? extends T> type)

Creates a new SectionObjectList.SectionObjectListBuilder with pre-defined Class type.

Type Parameters:

T - object type

Parameters:

type - type

Returns:

new builder

getObjectsType

public Class<? extends T> getObjectsType()

Returns the Class type of the value objects held in this section object list.

Returns:

objects type

getAsMap

public Map<String,T> getAsMap()

Returns an unmodifiable representation of this SectionObjectList as a Map

Returns:

as map

iterator

public Iterator<Map.Entry<String,T>> iterator()

Specified by:

iterator in interface Iterable<T>