ch.jalu.configme.properties.convertresult

Class PropertyValue<T>

java.lang.Object

ch.jalu.configme.properties.convertresult.PropertyValue<T>

Type Parameters:

T - the value type wrapped by this instance

public class PropertyValue<T>
extends Object

Return value of Property.determineValue(ch.jalu.configme.resource.PropertyReader). Wraps the value to associate with the property, along with a field indicating whether the value in the resource is present and fully valid according to the property's type.

The value is the property's default value (for example, if no value is present in the resource), or it is a value as constructed from the property resource. Note that isValidInResource may be false even if the value is based on the resource's data, namely when a resave of the resource is desired, usually because the data in the resource was not fully valid. In any case, the value must always pass the check from Property.isValidValue(T).

Constructor Summary

Constructors

Constructor and Description
PropertyValue(T value, boolean isValidInResource) Constructor.

Method Summary

Modifier and Type	Method and Description
T	getValue()
boolean	isValidInResource() Returns true if the data in the resource is fully valid for creating the value of the property.
String	toString()
static <T> PropertyValue<T>	withValidValue(T value) Creates a new instance for the given value which indicates that it is fully valid in the resource.
static <T> PropertyValue<T>	withValueRequiringRewrite(T value) Creates a new instance for the given value which indicates that its representation in the resource is NOT valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyValue

public PropertyValue(T value,
                     boolean isValidInResource)

Constructor.

Parameters:

value - the value associated with the property

isValidInResource - true if the value in the resource was fully valid

Method Detail

withValidValue

public static <T> PropertyValue<T> withValidValue(T value)

Creates a new instance for the given value which indicates that it is fully valid in the resource.

Type Parameters:

T - the value type

Parameters:

value - the value to wrap

Returns:

property value with the given value and the valid flag set to true

withValueRequiringRewrite

public static <T> PropertyValue<T> withValueRequiringRewrite(T value)

Creates a new instance for the given value which indicates that its representation in the resource is NOT valid.

Type Parameters:

T - the value type

Parameters:

value - the value to wrap

Returns:

property value with the given value and the valid flag set to false

getValue

public T getValue()

Returns:

the value to associate with the property

isValidInResource

public boolean isValidInResource()

Returns true if the data in the resource is fully valid for creating the value of the property. False otherwise (i.e. if there is an issue with the value or part of it, or if the value is missing altogether). Note that this flag does not refer to the value contained in this instance; rather, it specifies whether the data in the property resource was present and fully valid at the property's path for the property's type.

Returns:

true if the data in the resource is fully valid for the property

toString

public String toString()

Overrides:

toString in class Object