org.jomc.modlet

Class DefaultModletValidator

java.lang.Object

org.jomc.modlet.DefaultModletValidator

All Implemented Interfaces:

ModletValidator

public class DefaultModletValidator
extends Object
implements ModletValidator

Default ModletValidator implementation.

Since:

1.9

Version:

$JOMC: DefaultModletValidator.java 5269 2016-08-11 23:38:09Z schulte $

Author:

Christian Schulte

See Also:

ModelContext.validateModlets(org.jomc.modlet.Modlets)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENABLED_ATTRIBUTE_NAME Constant for the name of the model context attribute backing property enabled.

Constructor Summary

Constructors

Constructor and Description
DefaultModletValidator() Creates a new DefaultModletValidator instance.

Method Summary

Methods

Modifier and Type	Method and Description
static int	getDefaultOrdinal() Gets the default ordinal number of the validator.
int	getOrdinal() Gets the ordinal number of the validator.
static boolean	isDefaultEnabled() Gets a flag indicating the validator is enabled by default.
boolean	isEnabled() Gets a flag indicating the validator is enabled.
static void	setDefaultEnabled(Boolean value) Sets the flag indicating the validator is enabled by default.
static void	setDefaultOrdinal(Integer value) Sets the default ordinal number of the validator.
void	setEnabled(Boolean value) Sets the flag indicating the validator is enabled.
void	setOrdinal(Integer value) Sets the ordinal number of the validator.
ModelValidationReport	validateModlets(ModelContext context, Modlets modlets) Validates a given list of Modlets with a context.

Methods inherited from class java.lang.Object

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

Field Detail

ENABLED_ATTRIBUTE_NAME

public static final String ENABLED_ATTRIBUTE_NAME

Constant for the name of the model context attribute backing property enabled.

See Also:

validateModlets(org.jomc.modlet.ModelContext, org.jomc.modlet.Modlets), ModelContext.getAttribute(java.lang.String), Constant Field Values

Constructor Detail

DefaultModletValidator

public DefaultModletValidator()

Creates a new DefaultModletValidator instance.

Method Detail

isDefaultEnabled

public static boolean isDefaultEnabled()

Gets a flag indicating the validator is enabled by default.

The default enabled flag is controlled by system property org.jomc.modlet.DefaultModletValidator.defaultEnabled holding a value indicating the validator is enabled by default. If that property is not set, the true default is returned.

Returns:

true, if the validator is enabled by default; false, if the validator is disabled by default.

See Also:

isEnabled(), setDefaultEnabled(java.lang.Boolean)

setDefaultEnabled

public static void setDefaultEnabled(Boolean value)

Sets the flag indicating the validator is enabled by default.

Parameters:

value - The new value of the flag indicating the validator is enabled by default or null.

See Also:

isDefaultEnabled()

isEnabled

public final boolean isEnabled()

Gets a flag indicating the validator is enabled.

Returns:

true, if the validator is enabled; false, if the validator is disabled.

See Also:

isDefaultEnabled(), setEnabled(java.lang.Boolean)

setEnabled

public final void setEnabled(Boolean value)

Sets the flag indicating the validator is enabled.

Parameters:

value - The new value of the flag indicating the validator is enabled or null.

See Also:

isEnabled()

getDefaultOrdinal

public static int getDefaultOrdinal()

Gets the default ordinal number of the validator.

The default ordinal number is controlled by system property org.jomc.modlet.DefaultModletValidator.defaultOrdinal holding the default ordinal number of the validator. If that property is not set, the 0 default is returned.

Returns:

The default ordinal number of the validator.

See Also:

setDefaultOrdinal(java.lang.Integer)

setDefaultOrdinal

public static void setDefaultOrdinal(Integer value)

Sets the default ordinal number of the validator.

Parameters:

value - The new default ordinal number of the validator or null.

See Also:

getDefaultOrdinal()

getOrdinal

public final int getOrdinal()

Gets the ordinal number of the validator.

Specified by:

getOrdinal in interface ModletValidator

Returns:

The ordinal number of the validator.

See Also:

getDefaultOrdinal(), setOrdinal(java.lang.Integer)

setOrdinal

public final void setOrdinal(Integer value)

Sets the ordinal number of the validator.

Parameters:

value - The new ordinal number of the validator or null.

See Also:

getOrdinal()

validateModlets

public ModelValidationReport validateModlets(ModelContext context,
                                    Modlets modlets)
                                      throws NullPointerException,
                                             ModelException

Description copied from interface: ModletValidator

Validates a given list of Modlets with a context.

Specified by:

validateModlets in interface ModletValidator

Parameters:

context - The context to validate Modlets with.

modlets - The Modlets to validate.

Returns:

Validation report.

Throws:

NullPointerException - if context or modlets is null.

ModelException - if validating modlets fails.

See Also:

ModelValidationReport.isModelValid()