Package de.xima.fc.plugin.lifecycle

Class DefaultPluginValidationResult

java.lang.Object

de.xima.fc.plugin.lifecycle.DefaultPluginValidationResult

All Implemented Interfaces:

IPluginInitializeValidationResult

public final class DefaultPluginValidationResult
extends Object
implements IPluginInitializeValidationResult

Default POJO implementation of IPluginInitializeValidationResult.

Since:

8.0.0

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
DefaultPluginValidationResult(boolean valid, List<String> errorMessages)	Creates a new instance with the given data.

Method Summary

Modifier and Type	Method	Description
List<String>	getErrorMessages()	Gets the localized error messages.
boolean	isValid()	Gets whether the plugin configuration is valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPluginValidationResult

public DefaultPluginValidationResult(boolean valid,
                                     List<String> errorMessages)

Creates a new instance with the given data.

Parameters:

valid - Whether the plugin configuration is valid.

errorMessages - An optional list of localized error messages.

Method Detail

isValid

public boolean isValid()

Description copied from interface: IPluginInitializeValidationResult

Gets whether the plugin configuration is valid. If it is invalid, error messages may also be available, but a validation result may be invalid even without error messages.

Specified by:

isValid in interface IPluginInitializeValidationResult

Returns:

true if the properties are valid, false if the plugin configuration is invalid.

getErrorMessages

public List<String> getErrorMessages()

Description copied from interface: IPluginInitializeValidationResult

Gets the localized error messages. Note that this validation result may be invalid even when this list is empty.

Specified by:

getErrorMessages in interface IPluginInitializeValidationResult

Returns:

A list of localized error messages.