Package cc.carm.lib.configuration.core.value.type

Class ConfiguredList<V>

java.lang.Object

cc.carm.lib.configuration.core.value.ValueManifest<T>

cc.carm.lib.configuration.core.value.ConfigValue<T>

cc.carm.lib.configuration.core.value.impl.CachedConfigValue<java.util.List<V>>

cc.carm.lib.configuration.core.value.type.ConfiguredList<V>

All Implemented Interfaces:

java.lang.Iterable<V>, java.util.Collection<V>, java.util.List<V>

public class ConfiguredList<V>
extends CachedConfigValue<java.util.List<V>>
implements java.util.List<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected @NotNull ConfigDataFunction<java.lang.Object,V>	parser
protected @NotNull ConfigDataFunction<V,java.lang.Object>	serializer
protected @NotNull java.lang.Class<V>	valueClass

Fields inherited from class cc.carm.lib.configuration.core.value.impl.CachedConfigValue

cachedValue, parsedTime

Fields inherited from class cc.carm.lib.configuration.core.value.ValueManifest

configPath, defaultValue, headerComments, inlineComment, provider

Constructor Summary

Constructors

Constructor	Description
ConfiguredList(@NotNull ValueManifest<java.util.List<V>> manifest, @NotNull java.lang.Class<V> valueClass, @NotNull ConfigDataFunction<java.lang.Object,V> parser, @NotNull ConfigDataFunction<V,java.lang.Object> serializer)

Method Summary

Modifier and Type	Method	Description
void	add(int index, V element)
boolean	add(V v)
boolean	addAll(int index, @NotNull java.util.Collection<? extends V> c)
boolean	addAll(@NotNull java.util.Collection<? extends V> c)
static <V> @NotNull ConfigListBuilder<V>	builderOf(@NotNull java.lang.Class<V> valueClass)
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsAll(@NotNull java.util.Collection<?> c)
@NotNull java.util.List<V>	copy()
@NotNull java.util.List<V>	get()	得到该配置的设定值(即读取到的值)。
V	get(int index)
<T> T	handle(java.util.function.Function<java.util.List<V>,T> function)
int	indexOf(java.lang.Object o)
boolean	isEmpty()
@NotNull java.util.Iterator<V>	iterator()
int	lastIndexOf(java.lang.Object o)
@NotNull java.util.ListIterator<V>	listIterator()
@NotNull java.util.ListIterator<V>	listIterator(int index)
@NotNull java.util.List<V>	modify(java.util.function.Consumer<java.util.List<V>> consumer)
static <V> @NotNull ConfiguredList<V>	of(@NotNull java.lang.Class<V> valueClass, @NotNull java.util.Collection<V> defaults)
static <V> @NotNull ConfiguredList<V>	of(@NotNull java.lang.Class<V> valueClass, @NotNull V... defaults)
V	remove(int index)
boolean	remove(java.lang.Object o)
boolean	removeAll(@NotNull java.util.Collection<?> c)
boolean	retainAll(@NotNull java.util.Collection<?> c)
V	set(int index, V element)
void	set(@Nullable java.util.List<V> value)	设定该配置的值。
int	size()
@NotNull java.util.List<V>	subList(int fromIndex, int toIndex)
@NotNull java.lang.Object @NotNull []	toArray()
<T> @NotNull T @NotNull []	toArray(@NotNull T[] a)

Methods inherited from class cc.carm.lib.configuration.core.value.impl.CachedConfigValue

getCachedOrDefault, getCachedOrDefault, getCachedValue, getDefaultFirst, isExpired, updateCache

Methods inherited from class cc.carm.lib.configuration.core.value.ConfigValue

builder, getNotNull, getOptional, getOrDefault, initialize, isDefault, setDefault, setDefault

Methods inherited from class cc.carm.lib.configuration.core.value.ValueManifest

getConfigPath, getConfiguration, getDefaultValue, getHeaderComments, getInlineComment, getProvider, getValue, initialize, of, of, setDefaultValue, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

equals, hashCode, replaceAll, sort, spliterator

Field Detail

valueClass

@NotNull
protected final @NotNull java.lang.Class<V> valueClass

parser

@NotNull
protected final @NotNull ConfigDataFunction<java.lang.Object,V> parser

serializer

@NotNull
protected final @NotNull ConfigDataFunction<V,java.lang.Object> serializer

Constructor Detail

ConfiguredList

public ConfiguredList(@NotNull
                      @NotNull ValueManifest<java.util.List<V>> manifest,
                      @NotNull
                      @NotNull java.lang.Class<V> valueClass,
                      @NotNull
                      @NotNull ConfigDataFunction<java.lang.Object,V> parser,
                      @NotNull
                      @NotNull ConfigDataFunction<V,java.lang.Object> serializer)

Method Detail

builderOf

@NotNull
public static <V> @NotNull ConfigListBuilder<V> builderOf(@NotNull
                                                          @NotNull java.lang.Class<V> valueClass)

of

@NotNull
public static <V> @NotNull ConfiguredList<V> of(@NotNull
                                                @NotNull java.lang.Class<V> valueClass,
                                                @NotNull
                                                @NotNull java.util.Collection<V> defaults)

of

@SafeVarargs
@NotNull
public static <V> @NotNull ConfiguredList<V> of(@NotNull
                                                @NotNull java.lang.Class<V> valueClass,
                                                @NotNull
                                                @NotNull V... defaults)

get

@NotNull
public @NotNull java.util.List<V> get()

Description copied from class: ConfigValue

得到该配置的设定值(即读取到的值)。
若初始化时未写入默认值，则可以通过 ConfigValue.getOrDefault() 方法在该设定值为空时获取默认值。

Specified by:

get in class ConfigValue<java.util.List<V>>

Returns:

设定值

get

public V get(int index)

Specified by:

get in interface java.util.List<V>

copy

@NotNull
public @NotNull java.util.List<V> copy()

handle

@NotNull
public <T> T handle(java.util.function.Function<java.util.List<V>,T> function)

modify

@NotNull
public @NotNull java.util.List<V> modify(java.util.function.Consumer<java.util.List<V>> consumer)

set

public void set(@Nullable
                @Nullable java.util.List<V> value)

Description copied from class: ConfigValue

设定该配置的值。
设定后，不会自动保存配置文件；若需要保存，请调用 ConfigurationProvider.save() 方法。

Specified by:

set in class ConfigValue<java.util.List<V>>

Parameters:

value - 配置的值

set

public V set(int index,
             V element)

Specified by:

set in interface java.util.List<V>

size

public int size()

Specified by:

size in interface java.util.Collection<V>

Specified by:

size in interface java.util.List<V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<V>

Specified by:

isEmpty in interface java.util.List<V>

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<V>

Specified by:

contains in interface java.util.List<V>

iterator

@NotNull
public @NotNull java.util.Iterator<V> iterator()

Specified by:

iterator in interface java.util.Collection<V>

Specified by:

iterator in interface java.lang.Iterable<V>

Specified by:

iterator in interface java.util.List<V>

toArray

@NotNull
public @NotNull java.lang.Object @NotNull [] toArray()

Specified by:

toArray in interface java.util.Collection<V>

Specified by:

toArray in interface java.util.List<V>

toArray

@NotNull
public <T> @NotNull T @NotNull [] toArray(@NotNull
                                          @NotNull T[] a)

Specified by:

toArray in interface java.util.Collection<V>

Specified by:

toArray in interface java.util.List<V>

containsAll

public boolean containsAll(@NotNull
                           @NotNull java.util.Collection<?> c)

Specified by:

containsAll in interface java.util.Collection<V>

Specified by:

containsAll in interface java.util.List<V>

add

public boolean add(V v)

Specified by:

add in interface java.util.Collection<V>

Specified by:

add in interface java.util.List<V>

add

public void add(int index,
                V element)

Specified by:

add in interface java.util.List<V>

addAll

public boolean addAll(@NotNull
                      @NotNull java.util.Collection<? extends V> c)

Specified by:

addAll in interface java.util.Collection<V>

Specified by:

addAll in interface java.util.List<V>

addAll

public boolean addAll(int index,
                      @NotNull
                      @NotNull java.util.Collection<? extends V> c)

Specified by:

addAll in interface java.util.List<V>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<V>

Specified by:

remove in interface java.util.List<V>

remove

public V remove(int index)

Specified by:

remove in interface java.util.List<V>

removeAll

public boolean removeAll(@NotNull
                         @NotNull java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<V>

Specified by:

removeAll in interface java.util.List<V>

retainAll

public boolean retainAll(@NotNull
                         @NotNull java.util.Collection<?> c)

Specified by:

retainAll in interface java.util.Collection<V>

Specified by:

retainAll in interface java.util.List<V>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<V>

Specified by:

clear in interface java.util.List<V>

indexOf

public int indexOf(java.lang.Object o)

Specified by:

indexOf in interface java.util.List<V>

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Specified by:

lastIndexOf in interface java.util.List<V>

listIterator

@NotNull
public @NotNull java.util.ListIterator<V> listIterator()

Specified by:

listIterator in interface java.util.List<V>

listIterator

@NotNull
public @NotNull java.util.ListIterator<V> listIterator(int index)

Specified by:

listIterator in interface java.util.List<V>

subList

@NotNull
public @NotNull java.util.List<V> subList(int fromIndex,
                                          int toIndex)

Specified by:

subList in interface java.util.List<V>