ch.jalu.configme.properties

Class PropertyInitializer

java.lang.Object

ch.jalu.configme.properties.PropertyInitializer

public class PropertyInitializer
extends Object

Convenience class for instantiating Property objects. You can use a static import for the methods for a short, convenient way to declare properties.

If you use additional property types, it may make the most sense to write your own property initializer class similar to this one, or extend this class to keep the default methods.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PropertyInitializer()

Method Summary

Modifier and Type	Method and Description
static <B> Property<B>	newBeanProperty(Class<B> beanClass, String path, B defaultValue) Creates a new bean property.
static Property<List<String>>	newListProperty(String path, String... defaultValues) Creates a new String list property.
static Property<Set<String>>	newLowercaseStringSetProperty(String path, String... defaultValues) Creates a new String set property where all values are lowercase.
static <E extends Enum<E>> Property<E>	newProperty(Class<E> clazz, String path, E defaultValue) Creates a new enum property.
static Property<Boolean>	newProperty(String path, boolean defaultValue) Creates a new boolean property.
static Property<Double>	newProperty(String path, double defaultValue) Creates a new double property.
static Property<Integer>	newProperty(String path, int defaultValue) Creates a new integer property.
static Property<String>	newProperty(String path, String defaultValue) Creates a new String property.
static Property<Optional<Boolean>>	optionalBooleanProperty(String path)
static <E extends Enum<E>> Property<Optional<E>>	optionalEnumProperty(Class<E> clazz, String path)
static Property<Optional<Integer>>	optionalIntegerProperty(String path)
static Property<Optional<String>>	optionalStringProperty(String path)

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyInitializer

protected PropertyInitializer()

Method Detail

newProperty

public static Property<Boolean> newProperty(String path,
                                            boolean defaultValue)

Creates a new boolean property.

Parameters:

path - the property's path

defaultValue - the default value

Returns:

the created property

newProperty

public static Property<Integer> newProperty(String path,
                                            int defaultValue)

Creates a new integer property.

Parameters:

path - the property's path

defaultValue - the default value

Returns:

the created property

newProperty

public static Property<Double> newProperty(String path,
                                           double defaultValue)

Creates a new double property.

Parameters:

path - the property's path

defaultValue - the default value

Returns:

the created property

newProperty

public static Property<String> newProperty(String path,
                                           String defaultValue)

Creates a new String property.

Parameters:

path - the property's path

defaultValue - the default value

Returns:

the created property

newProperty

public static <E extends Enum<E>> Property<E> newProperty(Class<E> clazz,
                                                          String path,
                                                          E defaultValue)

Creates a new enum property.

Type Parameters:

E - the enum type

Parameters:

clazz - the enum class

path - the property's path

defaultValue - the default value

Returns:

the created enum property

newListProperty

public static Property<List<String>> newListProperty(String path,
                                                     String... defaultValues)

Creates a new String list property.

Parameters:

path - the property's path

defaultValues - the items in the default list

Returns:

the created list property

newLowercaseStringSetProperty

public static Property<Set<String>> newLowercaseStringSetProperty(String path,
                                                                  String... defaultValues)

Creates a new String set property where all values are lowercase.

Parameters:

path - the property's path

defaultValues - the items in the default set

Returns:

the created set property

newBeanProperty

public static <B> Property<B> newBeanProperty(Class<B> beanClass,
                                              String path,
                                              B defaultValue)

Creates a new bean property.

Type Parameters:

B - the bean type

Parameters:

beanClass - the JavaBean class

path - the property's path

defaultValue - default value

Returns:

the created bean property

optionalBooleanProperty

public static Property<Optional<Boolean>> optionalBooleanProperty(String path)

optionalIntegerProperty

public static Property<Optional<Integer>> optionalIntegerProperty(String path)

optionalStringProperty

public static Property<Optional<String>> optionalStringProperty(String path)

optionalEnumProperty

public static <E extends Enum<E>> Property<Optional<E>> optionalEnumProperty(Class<E> clazz,
                                                                             String path)