com.izforge.izpack.api.data

Class PanelValidator

java.lang.Object

com.izforge.izpack.api.handler.DefaultConfigurationHandler

com.izforge.izpack.api.data.PanelValidator

All Implemented Interfaces:

Configurable, DataValidator, Serializable

public abstract class PanelValidator
extends DefaultConfigurationHandler
implements DataValidator

Enhancement of DataValidator, allows to implement a custom panel validator which can be configured by a <configuration> section.
Implement your panel validators by inheriting from this class.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.izforge.izpack.api.installer.DataValidator

DataValidator.Status

Field Summary

Fields inherited from interface com.izforge.izpack.api.installer.DataValidator

DATA_VALIDATOR_CLASSNAME_ATTR, DATA_VALIDATOR_CONDITION_ATTR, DATA_VALIDATOR_TAG

Constructor Summary

Constructors

Constructor and Description
PanelValidator()

Method Summary

Modifier and Type	Method and Description
abstract boolean	getDefaultAnswer() If the installer is run in automated mode, and validateData returns Status.WARNING, this method is asked how to go on instead of an user answer.
abstract String	getErrorMessageId() Returns the string with either a message if from translations or the message itself in case validateData returns Status.ERROR.
abstract String	getWarningMessageId() Returns the string with either a message if from translations or the message itself in case validateData returns Status.WARNING.
abstract DataValidator.Status	validateData(InstallData installData) Method to validate complex variable settings read from InstallData after a panel change.

Methods inherited from class com.izforge.izpack.api.handler.DefaultConfigurationHandler

addConfigurationOption, getConfigurationOption, getConfigurationOptionValue, getConfigurationOptionValue, getConfigurationOptionValue, getNames, readParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

PanelValidator

public PanelValidator()

Method Detail

validateData

public abstract DataValidator.Status validateData(InstallData installData)

Description copied from interface: DataValidator

Method to validate complex variable settings read from InstallData after a panel change.

Specified by:

validateData in interface DataValidator

getErrorMessageId

public abstract String getErrorMessageId()

Description copied from interface: DataValidator

Returns the string with either a message if from translations or the message itself in case validateData returns Status.ERROR.

Specified by:

getErrorMessageId in interface DataValidator

Returns:

String Should be the message id or the untranslated error message.

getWarningMessageId

public abstract String getWarningMessageId()

Description copied from interface: DataValidator

Returns the string with either a message if from translations or the message itself in case validateData returns Status.WARNING.

Specified by:

getWarningMessageId in interface DataValidator

Returns:

String Should be the message id or the untranslated warning message.

getDefaultAnswer

public abstract boolean getDefaultAnswer()

Description copied from interface: DataValidator

If the installer is run in automated mode, and validateData returns Status.WARNING, this method is asked how to go on instead of an user answer.

Specified by:

getDefaultAnswer in interface DataValidator

Returns:

boolean true - ignore warning and continue to the next panel, false - don't change to the next panel, fail