dk.heick.properties.collections.validationhandlers

Class LoggingPropertyValidationHandler

java.lang.Object

dk.heick.properties.collections.validationhandlers.LoggingPropertyValidationHandler

All Implemented Interfaces:

PropertyValidationHandler, Serializable

Direct Known Subclasses:

SendMessagePropertyValidationHandler

public class LoggingPropertyValidationHandler
extends Object
implements PropertyValidationHandler

Simply logs a message.
If logger is available, using "log.info()" or "log.error()",
otherwise using "System.out.println()" or "System.err.println()".

Author:

Frederik Heick

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LoggingPropertyValidationHandler() Default constructor, no system exit will be performed if PropertyIO or any Property is invalid.
LoggingPropertyValidationHandler(boolean doSystemExitIfAnythingIsInvalid) Constructor

Method Summary

Modifier and Type	Method and Description
void	afterValidation(org.apache.commons.logging.Log logger, boolean isAllValid) Method called after validation of the PropertyIO and all the Property's.
void	invalidProperty(org.apache.commons.logging.Log logger, Property<?> property, Exception exception) A handle of a property which is INVALID.
void	invalidPropertyIO(org.apache.commons.logging.Log logger, PropertyIO io, Exception exception) If the propertyIO was INVALID (aka it could NOT find the property file etc.)
boolean	isDoSystemExitIfAnythingIsInvalid()
protected void	logError(org.apache.commons.logging.Log logger, String message)
protected void	logInfo(org.apache.commons.logging.Log logger, String message)
void	validProperty(org.apache.commons.logging.Log logger, Property<?> property) A handle of a property that is valid
void	validPropertyIO(org.apache.commons.logging.Log logger, PropertyIO io) A handle of a property IO that is valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingPropertyValidationHandler

public LoggingPropertyValidationHandler()

Default constructor, no system exit will be performed if PropertyIO or any Property is invalid.

LoggingPropertyValidationHandler

public LoggingPropertyValidationHandler(boolean doSystemExitIfAnythingIsInvalid)

Constructor

Parameters:

doSystemExitIfAnythingIsInvalid - if true an System.exit(42); will be performed if either the PropertyIO or any Property is invalid.

Method Detail

isDoSystemExitIfAnythingIsInvalid

public boolean isDoSystemExitIfAnythingIsInvalid()

invalidProperty

public void invalidProperty(org.apache.commons.logging.Log logger,
                            Property<?> property,
                            Exception exception)

Description copied from interface: PropertyValidationHandler

A handle of a property which is INVALID.

Specified by:

invalidProperty in interface PropertyValidationHandler

Parameters:

logger - the logger, if null than System.err is used.

property - the property which is INVALID, can be null.

exception - the exception

validProperty

public void validProperty(org.apache.commons.logging.Log logger,
                          Property<?> property)

Description copied from interface: PropertyValidationHandler

A handle of a property that is valid

Specified by:

validProperty in interface PropertyValidationHandler

Parameters:

logger - the logger, if null than System.out is used.

property - the property which is VALID.

invalidPropertyIO

public void invalidPropertyIO(org.apache.commons.logging.Log logger,
                              PropertyIO io,
                              Exception exception)

Description copied from interface: PropertyValidationHandler

If the propertyIO was INVALID (aka it could NOT find the property file etc.)

Specified by:

invalidPropertyIO in interface PropertyValidationHandler

Parameters:

logger - the logger, if null than System.err is used.

io - the IO used

exception - the exception

validPropertyIO

public void validPropertyIO(org.apache.commons.logging.Log logger,
                            PropertyIO io)

Description copied from interface: PropertyValidationHandler

A handle of a property IO that is valid.

Specified by:

validPropertyIO in interface PropertyValidationHandler

Parameters:

logger - the logger, if null than System.out is used.

io - the IO used.

afterValidation

public void afterValidation(org.apache.commons.logging.Log logger,
                            boolean isAllValid)

Description copied from interface: PropertyValidationHandler

Method called after validation of the PropertyIO and all the Property's.

Specified by:

afterValidation in interface PropertyValidationHandler

Parameters:

logger - the logger, if null than System.err or System.out is used

isAllValid - true if PropertyIO and all Property's is valid, otherwise false.

logInfo

protected void logInfo(org.apache.commons.logging.Log logger,
                       String message)

logError

protected void logError(org.apache.commons.logging.Log logger,
                        String message)