ch.jalu.configme.properties.convertresult

Class ConvertErrorRecorder

java.lang.Object

ch.jalu.configme.properties.convertresult.ConvertErrorRecorder

public class ConvertErrorRecorder
extends Object

Records errors during the conversion of a property to its Java value.

This object is passed around during conversion to determine whether an error has occurred during the conversion that should trigger a rewrite. It is not necessary to register an error with this class if the return value of the conversion implies that the representation in the resource is wrong altogether. Instead, errors are typically registered with this recorder when an object can be created, but there is some error in the representation that should be corrected (e.g. a value is missing but there is a sensible fallback).

See Also:

BaseProperty.determineValue(PropertyReader)

Constructor Summary

Constructors

Constructor and Description
ConvertErrorRecorder()

Method Summary

Modifier and Type	Method and Description
boolean	isFullyValid() Returns whether the value that was returned from the property or property type was fully valid and therefore doesn't need a rewrite.
void	setHasError(String reason) Registers that some error occurred during the conversion of the value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConvertErrorRecorder

public ConvertErrorRecorder()

Method Detail

setHasError

public void setHasError(String reason)

Registers that some error occurred during the conversion of the value. See class javadoc: no need to register an error if the return value of the conversion implies there is an issue (such as returning null).

Parameters:

reason - the reason (not used in this implementation but may be extended for debugging)

isFullyValid

public boolean isFullyValid()

Returns whether the value that was returned from the property or property type was fully valid and therefore doesn't need a rewrite. Even if a value is returned, this method may return false in case a recoverable error was detected. This method may return true if the return value of the conversion is null or otherwise indicates that there is no proper representation of it in the property resource.

Returns:

true if no error was registered, false otherwise (see class Javadoc for semantics)