ch.jalu.configme.properties

Class Property<T>

java.lang.Object

ch.jalu.configme.properties.Property<T>

Direct Known Subclasses:

BeanProperty, BooleanProperty, EnumProperty, IntegerProperty, OptionalProperty, StringListProperty, StringProperty

public abstract class Property<T>
extends Object

A property, i.e. a configuration value that is read from a property resource.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Property(String path, T defaultValue)

Method Summary

Modifier and Type	Method and Description
T	getDefaultValue() Returns the default value of the property.
protected abstract T	getFromResource(PropertyResource resource)
String	getPath() Returns the property path.
T	getValue(PropertyResource resource) Gets the property value from the given resource and falls back to the default value if not present.
boolean	isPresent(PropertyResource resource) Returns whether or not the given resource contains the property.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Property

protected Property(String path,
                   T defaultValue)

Method Detail

getValue

public T getValue(PropertyResource resource)

Gets the property value from the given resource and falls back to the default value if not present. Guaranteed to never return null.

Parameters:

resource - the property resource

Returns:

the value, or default if not present

getFromResource

@Nullable
protected abstract T getFromResource(PropertyResource resource)

isPresent

public boolean isPresent(PropertyResource resource)

Returns whether or not the given resource contains the property.

Parameters:

resource - the property resource to check

Returns:

true if the property is present, false otherwise

getDefaultValue

public T getDefaultValue()

Returns the default value of the property.

Returns:

the default value

getPath

public String getPath()

Returns the property path.

Returns:

the path

toString

public String toString()

Overrides:

toString in class Object