ch.jalu.configme.properties

Class PropertyBuilder<K,T,B extends PropertyBuilder<K,T,B>>

java.lang.Object

ch.jalu.configme.properties.PropertyBuilder<K,T,B>

Type Parameters:

K - the PropertyType type the builder makes use of

T - the type of Property the builder produces

B - builder extension (concrete class extending this builder)

Direct Known Subclasses:

PropertyBuilder.ArrayPropertyBuilder, PropertyBuilder.InlineArrayPropertyBuilder, PropertyBuilder.ListPropertyBuilder, PropertyBuilder.MapPropertyBuilder, PropertyBuilder.SetPropertyBuilder, PropertyBuilder.TypeBasedPropertyBuilder

public abstract class PropertyBuilder<K,T,B extends PropertyBuilder<K,T,B>>
extends Object

Builder for complex types of properties.

See Also:

PropertyInitializer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PropertyBuilder.ArrayPropertyBuilder<T> Builder for ArrayProperty.
static interface	PropertyBuilder.CreateFunction<K,T> Function taking three arguments, which returns a property of the given type.
static class	PropertyBuilder.InlineArrayPropertyBuilder<T> Builder for InlineArrayProperty.
static class	PropertyBuilder.ListPropertyBuilder<T> Builder for ListProperty.
static class	PropertyBuilder.MapPropertyBuilder<T> Builder for MapProperty.
static class	PropertyBuilder.SetPropertyBuilder<T> Builder for SetProperty.
static class	PropertyBuilder.TypeBasedPropertyBuilder<T> Builder for TypeBasedProperty.

Constructor Summary

Constructors

Constructor and Description
PropertyBuilder(@Nullable PropertyType<K> type) Constructor.

Method Summary

Modifier and Type	Method and Description
abstract @NotNull Property<T>	build() Creates a property with the configured details.
B	defaultValue(T defaultValue) Sets the default of the property.
protected T	getDefaultValue()
protected @Nullable String	getPath()
protected @Nullable PropertyType<K>	getType()
B	path(@NotNull String path) Sets the path of the property.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyBuilder

public PropertyBuilder(@Nullable
                       @Nullable PropertyType<K> type)

Constructor.

Parameters:

type - the property type

Method Detail

path

@NotNull
public B path(@NotNull
                       @NotNull String path)

Sets the path of the property.

Parameters:

path - the path

Returns:

this builder

defaultValue

@NotNull
public B defaultValue(@NotNull
                               T defaultValue)

Sets the default of the property.

Parameters:

defaultValue - the default value to set

Returns:

this builder

build

@NotNull
public abstract @NotNull Property<T> build()

Creates a property with the configured details. All mandatory settings must have been set beforehand.

Returns:

the created property

getPath

@Nullable
protected final @Nullable String getPath()

getDefaultValue

@Nullable
protected final T getDefaultValue()

getType

@Nullable
protected final @Nullable PropertyType<K> getType()