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 <T> PropertyBuilder.ArrayPropertyBuilder<T>	arrayProperty(@NotNull PropertyType<T> type, @NotNull IntFunction<T[]> arrayProducer)
static <T> PropertyBuilder.InlineArrayPropertyBuilder<T>	inlineArrayProperty(@NotNull InlineArrayConverter<T> inlineConverter)
static <T> PropertyBuilder.ListPropertyBuilder<T>	listProperty(@NotNull PropertyType<T> type)
static <T> PropertyBuilder.MapPropertyBuilder<T>	mapProperty(@NotNull PropertyType<T> type)
static <B> @NotNull BeanProperty<B>	newBeanProperty(@NotNull Class<B> beanClass, @NotNull String path, B defaultValue) Creates a new bean property.
static @NotNull StringListProperty	newListProperty(@NotNull String path, @NotNull List<String> defaultValues) Creates a new String list property.
static @NotNull StringListProperty	newListProperty(@NotNull String path, String... defaultValues) Creates a new String list property.
static @NotNull LowercaseStringSetProperty	newLowercaseStringSetProperty(@NotNull String path, @NotNull Collection<String> defaultValues) Creates a new String set property where all values are lowercase.
static @NotNull LowercaseStringSetProperty	newLowercaseStringSetProperty(@NotNull String path, String... defaultValues) Creates a new String set property where all values are lowercase.
static <E extends Enum<E>> @NotNull EnumProperty<E>	newProperty(@NotNull Class<E> clazz, @NotNull String path, E defaultValue) Creates a new enum property.
static @NotNull BooleanProperty	newProperty(@NotNull String path, boolean defaultValue) Creates a new boolean property.
static @NotNull DoubleProperty	newProperty(@NotNull String path, double defaultValue) Creates a new double property.
static @NotNull FloatProperty	newProperty(@NotNull String path, float defaultValue) Creates a new float property.
static @NotNull IntegerProperty	newProperty(@NotNull String path, int defaultValue) Creates a new integer property.
static @NotNull LongProperty	newProperty(@NotNull String path, long defaultValue) Creates a new long property.
static @NotNull ShortProperty	newProperty(@NotNull String path, short defaultValue) Creates a new short property.
static @NotNull StringProperty	newProperty(@NotNull String path, @NotNull String defaultValue) Creates a new String property.
static @NotNull RegexProperty	newRegexProperty(@NotNull String path, @NotNull Pattern defaultRegexValue) Creates a new regex pattern property.
static @NotNull RegexProperty	newRegexProperty(@NotNull String path, @NotNull String defaultRegexValue) Creates a new regex pattern property.
static @NotNull StringSetProperty	newSetProperty(@NotNull String path, @NotNull Set<String> defaultValues) Creates a new String set property.
static @NotNull StringSetProperty	newSetProperty(@NotNull String path, String... defaultValues) Creates a new String set property.
static @NotNull OptionalProperty<Boolean>	optionalBooleanProperty(@NotNull String path)
static @NotNull OptionalProperty<Double>	optionalDoubleProperty(@NotNull String path)
static <E extends Enum<E>> @NotNull OptionalProperty<E>	optionalEnumProperty(@NotNull Class<E> clazz, @NotNull String path)
static @NotNull OptionalProperty<Float>	optionalFloatProperty(@NotNull String path)
static @NotNull OptionalProperty<Integer>	optionalIntegerProperty(@NotNull String path)
static @NotNull OptionalProperty<List<String>>	optionalListProperty(@NotNull String path)
static @NotNull OptionalProperty<Long>	optionalLongProperty(@NotNull String path)
static @NotNull OptionalProperty<Pattern>	optionalRegexProperty(@NotNull String path)
static @NotNull OptionalProperty<Set<String>>	optionalSetProperty(@NotNull String path)
static @NotNull OptionalProperty<Short>	optionalShortProperty(@NotNull String path)
static @NotNull OptionalProperty<String>	optionalStringProperty(@NotNull String path)
static <T> PropertyBuilder.SetPropertyBuilder<T>	setProperty(@NotNull PropertyType<T> type)
static <T> PropertyBuilder.TypeBasedPropertyBuilder<T>	typeBasedProperty(@NotNull PropertyType<T> type)

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

@NotNull
public static @NotNull BooleanProperty newProperty(@NotNull
                                                            @NotNull String path,
                                                            boolean defaultValue)

Creates a new boolean property.

Parameters:

path - the property's path

defaultValue - the default value

Returns:

the created property

newProperty

@NotNull
public static @NotNull ShortProperty newProperty(@NotNull
                                                          @NotNull String path,
                                                          short defaultValue)

Creates a new short property.

Parameters:

path - the property's path

defaultValue - the default value

Returns:

the created property

newProperty

@NotNull
public static @NotNull IntegerProperty newProperty(@NotNull
                                                            @NotNull String path,
                                                            int defaultValue)

Creates a new integer property.

Parameters:

path - the property's path

defaultValue - the default value

Returns:

the created property

newProperty

@NotNull
public static @NotNull LongProperty newProperty(@NotNull
                                                         @NotNull String path,
                                                         long defaultValue)

Creates a new long property.

Parameters:

path - the property's path

defaultValue - the default value

Returns:

the created property

newProperty

@NotNull
public static @NotNull FloatProperty newProperty(@NotNull
                                                          @NotNull String path,
                                                          float defaultValue)

Creates a new float property.

Parameters:

path - the property's path

defaultValue - the default value

Returns:

the created property

newProperty

@NotNull
public static @NotNull DoubleProperty newProperty(@NotNull
                                                           @NotNull String path,
                                                           double defaultValue)

Creates a new double property.

Parameters:

path - the property's path

defaultValue - the default value

Returns:

the created property

newProperty

@NotNull
public static @NotNull StringProperty newProperty(@NotNull
                                                           @NotNull String path,
                                                           @NotNull
                                                           @NotNull String defaultValue)

Creates a new String property.

Parameters:

path - the property's path

defaultValue - the default value

Returns:

the created property

newProperty

@NotNull
public static <E extends Enum<E>> @NotNull EnumProperty<E> newProperty(@NotNull
                                                                                @NotNull Class<E> clazz,
                                                                                @NotNull
                                                                                @NotNull String path,
                                                                                @NotNull
                                                                                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

newRegexProperty

@NotNull
public static @NotNull RegexProperty newRegexProperty(@NotNull
                                                               @NotNull String path,
                                                               @NotNull
                                                               @NotNull String defaultRegexValue)

Creates a new regex pattern property.

Parameters:

path - the property's path

defaultRegexValue - the default pattern of the property

Returns:

the created regex property

newRegexProperty

@NotNull
public static @NotNull RegexProperty newRegexProperty(@NotNull
                                                               @NotNull String path,
                                                               @NotNull
                                                               @NotNull Pattern defaultRegexValue)

Creates a new regex pattern property.

Parameters:

path - the property's path

defaultRegexValue - the default pattern of the property

Returns:

the created regex property

newListProperty

@NotNull
public static @NotNull StringListProperty newListProperty(@NotNull
                                                                   @NotNull String path,
                                                                   @NotNull
                                                                   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

newListProperty

@NotNull
public static @NotNull StringListProperty newListProperty(@NotNull
                                                                   @NotNull String path,
                                                                   @NotNull
                                                                   @NotNull List<String> defaultValues)

Creates a new String list property.

Parameters:

path - the property's path

defaultValues - the default value of the property

Returns:

the created list property

newSetProperty

@NotNull
public static @NotNull StringSetProperty newSetProperty(@NotNull
                                                                 @NotNull String path,
                                                                 @NotNull
                                                                 String... defaultValues)

Creates a new String set property.

Parameters:

path - the property's path

defaultValues - the items in the default set

Returns:

the created set property

newSetProperty

@NotNull
public static @NotNull StringSetProperty newSetProperty(@NotNull
                                                                 @NotNull String path,
                                                                 @NotNull
                                                                 @NotNull Set<String> defaultValues)

Creates a new String set property.

Parameters:

path - the property's path

defaultValues - the default value of the property

Returns:

the created set property

newLowercaseStringSetProperty

@NotNull
public static @NotNull LowercaseStringSetProperty newLowercaseStringSetProperty(@NotNull
                                                                                         @NotNull String path,
                                                                                         @NotNull
                                                                                         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

newLowercaseStringSetProperty

@NotNull
public static @NotNull LowercaseStringSetProperty newLowercaseStringSetProperty(@NotNull
                                                                                         @NotNull String path,
                                                                                         @NotNull
                                                                                         @NotNull Collection<String> defaultValues)

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

Parameters:

path - the property's path

defaultValues - the default value of the property

Returns:

the created set property

newBeanProperty

@NotNull
public static <B> @NotNull BeanProperty<B> newBeanProperty(@NotNull
                                                                    @NotNull Class<B> beanClass,
                                                                    @NotNull
                                                                    @NotNull String path,
                                                                    @NotNull
                                                                    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

typeBasedProperty

@NotNull
public static <T> PropertyBuilder.TypeBasedPropertyBuilder<T> typeBasedProperty(@NotNull
                                                                                         @NotNull PropertyType<T> type)

listProperty

@NotNull
public static <T> PropertyBuilder.ListPropertyBuilder<T> listProperty(@NotNull
                                                                               @NotNull PropertyType<T> type)

setProperty

@NotNull
public static <T> PropertyBuilder.SetPropertyBuilder<T> setProperty(@NotNull
                                                                             @NotNull PropertyType<T> type)

mapProperty

@NotNull
public static <T> PropertyBuilder.MapPropertyBuilder<T> mapProperty(@NotNull
                                                                             @NotNull PropertyType<T> type)

arrayProperty

@NotNull
public static <T> PropertyBuilder.ArrayPropertyBuilder<T> arrayProperty(@NotNull
                                                                                 @NotNull PropertyType<T> type,
                                                                                 @NotNull
                                                                                 @NotNull IntFunction<T[]> arrayProducer)

inlineArrayProperty

@NotNull
public static <T> PropertyBuilder.InlineArrayPropertyBuilder<T> inlineArrayProperty(@NotNull
                                                                                             @NotNull InlineArrayConverter<T> inlineConverter)

optionalBooleanProperty

@NotNull
public static @NotNull OptionalProperty<Boolean> optionalBooleanProperty(@NotNull
                                                                                  @NotNull String path)

optionalShortProperty

@NotNull
public static @NotNull OptionalProperty<Short> optionalShortProperty(@NotNull
                                                                              @NotNull String path)

optionalIntegerProperty

@NotNull
public static @NotNull OptionalProperty<Integer> optionalIntegerProperty(@NotNull
                                                                                  @NotNull String path)

optionalLongProperty

@NotNull
public static @NotNull OptionalProperty<Long> optionalLongProperty(@NotNull
                                                                            @NotNull String path)

optionalFloatProperty

@NotNull
public static @NotNull OptionalProperty<Float> optionalFloatProperty(@NotNull
                                                                              @NotNull String path)

optionalDoubleProperty

@NotNull
public static @NotNull OptionalProperty<Double> optionalDoubleProperty(@NotNull
                                                                                @NotNull String path)

optionalStringProperty

@NotNull
public static @NotNull OptionalProperty<String> optionalStringProperty(@NotNull
                                                                                @NotNull String path)

optionalEnumProperty

@NotNull
public static <E extends Enum<E>> @NotNull OptionalProperty<E> optionalEnumProperty(@NotNull
                                                                                             @NotNull Class<E> clazz,
                                                                                             @NotNull
                                                                                             @NotNull String path)

optionalRegexProperty

@NotNull
public static @NotNull OptionalProperty<Pattern> optionalRegexProperty(@NotNull
                                                                                @NotNull String path)

optionalListProperty

@NotNull
public static @NotNull OptionalProperty<List<String>> optionalListProperty(@NotNull
                                                                                    @NotNull String path)

optionalSetProperty

@NotNull
public static @NotNull OptionalProperty<Set<String>> optionalSetProperty(@NotNull
                                                                                  @NotNull String path)