ch.jalu.configme.properties

Class StringSetProperty

java.lang.Object

ch.jalu.configme.properties.BaseProperty<Set<T>>

ch.jalu.configme.properties.SetProperty<String>

ch.jalu.configme.properties.StringSetProperty

All Implemented Interfaces:

Property<Set<String>>

Direct Known Subclasses:

LowercaseStringSetProperty

public class StringSetProperty
extends SetProperty<String>

String set property. The sets are immutable.

Constructor Summary

Constructors

Constructor and Description
StringSetProperty(@NotNull String path, @NotNull Set<String> defaultValue) Constructor.
StringSetProperty(@NotNull String path, String... defaultValue) Constructor.

Method Summary

Modifier and Type	Method and Description
@NotNull Object	toExportValue(@NotNull Set<String> value) Converts the given value to a representation that is suitable for exporting by a property resource.

Methods inherited from class ch.jalu.configme.properties.SetProperty

getFromReader, setCollector

Methods inherited from class ch.jalu.configme.properties.BaseProperty

determineValue, getDefaultValue, getPath, isValidValue, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.jalu.configme.properties.Property

isValidInResource

Constructor Detail

StringSetProperty

public StringSetProperty(@NotNull
                         @NotNull String path,
                         @NotNull
                         String... defaultValue)

Constructor.

Parameters:

path - the path of the property

defaultValue - the values that make up the entries of the default set

StringSetProperty

public StringSetProperty(@NotNull
                         @NotNull String path,
                         @NotNull
                         @NotNull Set<String> defaultValue)

Constructor.

Parameters:

path - the path of the property

defaultValue - the values that make up the entries of the default set

Method Detail

toExportValue

@NotNull
public @NotNull Object toExportValue(@NotNull
                                              @NotNull Set<String> value)

Description copied from interface: Property

Converts the given value to a representation that is suitable for exporting by a property resource. The return value should contain the data in the given value represented with only basic types (String, Number, Boolean), as well as lists and maps thereof.

The values which are suitable for returning depend on the support of the used property resource. By default, the supported types include null, String, Integer, Double, Boolean; Collection of the aforementioned types; Map with String keys and values of any of the aforementioned types. Maps and collections can be nested at any arbitrary level. Null signifies that the property/value should be skipped in the export.

Specified by:

toExportValue in interface Property<Set<String>>

Overrides:

toExportValue in class SetProperty<String>

Parameters:

value - the value to convert to an export value

Returns:

value to use for export, null to skip the property