org.jomc.modlet

Class DefaultModletProvider

java.lang.Object

org.jomc.modlet.DefaultModletProvider

All Implemented Interfaces:

ModletProvider

public class DefaultModletProvider
extends Object
implements ModletProvider

Default ModletProvider implementation.

Version:

$JOMC: DefaultModletProvider.java 4841 2014-01-06 01:24:25Z schulte $

Author:

Christian Schulte

See Also:

ModelContext.findModlets(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.
static String	MODLET_LOCATION_ATTRIBUTE_NAME Constant for the name of the model context attribute backing property modletLocation.
static String	VALIDATING_ATTRIBUTE_NAME Constant for the name of the model context attribute backing property validating.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
Modlets	findModlets(ModelContext context) Deprecated. As of JOMC 1.6, this method has been replaced by findModlets(org.jomc.modlet.ModelContext, org.jomc.modlet.Modlets). This method will be removed in JOMC 2.0.
Modlets	findModlets(ModelContext context, Modlets modlets) Searches a given context for Modlets.
Modlets	findModlets(ModelContext context, String location) Searches a given context for Modlets.
static String	getDefaultModletLocation() Gets the default location searched for Modlet resources.
static int	getDefaultOrdinal() Gets the default ordinal number of the provider.
String	getModletLocation() Gets the location searched for Modlet resources.
int	getOrdinal() Gets the ordinal number of the provider.
static boolean	isDefaultEnabled() Gets a flag indicating the provider is enabled by default.
static boolean	isDefaultValidating() Gets a flag indicating the provider is validating resources by default.
boolean	isEnabled() Gets a flag indicating the provider is enabled.
boolean	isValidating() Gets a flag indicating the provider is validating resources.
static void	setDefaultEnabled(Boolean value) Sets the flag indicating the provider is enabled by default.
static void	setDefaultModletLocation(String value) Sets the default location searched for Modlet resources.
static void	setDefaultOrdinal(Integer value) Sets the default ordinal number of the provider.
static void	setDefaultValidating(Boolean value) Sets the flag indicating the provider is validating resources by default.
void	setEnabled(Boolean value) Sets the flag indicating the provider is enabled.
void	setModletLocation(String value) Sets the location searched for Modlet resources.
void	setOrdinal(Integer value) Sets the ordinal number of the provider.
void	setValidating(Boolean value) Sets the flag indicating the provider is validating resources.

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.

Since:

1.2

See Also:

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

MODLET_LOCATION_ATTRIBUTE_NAME

public static final String MODLET_LOCATION_ATTRIBUTE_NAME

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

Since:

1.2

See Also:

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

VALIDATING_ATTRIBUTE_NAME

public static final String VALIDATING_ATTRIBUTE_NAME

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

Since:

1.2

See Also:

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

Constructor Detail

DefaultModletProvider

public DefaultModletProvider()

Creates a new DefaultModletProvider instance.

Method Detail

isDefaultEnabled

public static boolean isDefaultEnabled()

Gets a flag indicating the provider is enabled by default.

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

Returns:

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

See Also:

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

setDefaultEnabled

public static void setDefaultEnabled(Boolean value)

Sets the flag indicating the provider is enabled by default.

Parameters:

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

See Also:

isDefaultEnabled()

isEnabled

public final boolean isEnabled()

Gets a flag indicating the provider is enabled.

Returns:

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

See Also:

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

setEnabled

public final void setEnabled(Boolean value)

Sets the flag indicating the provider is enabled.

Parameters:

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

See Also:

isEnabled()

getDefaultModletLocation

public static String getDefaultModletLocation()

Gets the default location searched for Modlet resources.

The default Modlet location is controlled by system property org.jomc.modlet.DefaultModletProvider.defaultModletLocation holding the location to search for Modlet resources by default. If that property is not set, the META-INF/jomc-modlet.xml default is returned.

Returns:

The location searched for Modlet resources by default.

See Also:

setDefaultModletLocation(java.lang.String)

setDefaultModletLocation

public static void setDefaultModletLocation(String value)

Sets the default location searched for Modlet resources.

Parameters:

value - The new default location to search for Modlet resources or null.

See Also:

getDefaultModletLocation()

getModletLocation

public final String getModletLocation()

Gets the location searched for Modlet resources.

Returns:

The location searched for Modlet resources.

See Also:

getDefaultModletLocation(), setModletLocation(java.lang.String)

setModletLocation

public final void setModletLocation(String value)

Sets the location searched for Modlet resources.

Parameters:

value - The new location to search for Modlet resources or null.

See Also:

getModletLocation()

isDefaultValidating

public static boolean isDefaultValidating()

Gets a flag indicating the provider is validating resources by default.

The default validating flag is controlled by system property org.jomc.modlet.DefaultModletProvider.defaultValidating holding a value indicating the provider is validating resources by default. If that property is not set, the true default is returned.

Returns:

true, if the provider is validating resources by default; false, if the provider is not validating resources by default.

Since:

1.2

See Also:

isValidating(), setDefaultValidating(java.lang.Boolean)

setDefaultValidating

public static void setDefaultValidating(Boolean value)

Sets the flag indicating the provider is validating resources by default.

Parameters:

value - The new value of the flag indicating the provider is validating resources by default or null.

Since:

1.2

See Also:

isDefaultValidating()

isValidating

public final boolean isValidating()

Gets a flag indicating the provider is validating resources.

Returns:

true, if the provider is validating resources; false, if the provider is not validating resources.

Since:

1.2

See Also:

isDefaultValidating(), setValidating(java.lang.Boolean)

setValidating

public final void setValidating(Boolean value)

Sets the flag indicating the provider is validating resources.

Parameters:

value - The new value of the flag indicating the provider is validating resources or null.

Since:

1.2

See Also:

isValidating()

getDefaultOrdinal

public static int getDefaultOrdinal()

Gets the default ordinal number of the provider.

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

Returns:

The default ordinal number of the provider.

Since:

1.6

See Also:

setDefaultOrdinal(java.lang.Integer)

setDefaultOrdinal

public static void setDefaultOrdinal(Integer value)

Sets the default ordinal number of the provider.

Parameters:

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

Since:

1.6

See Also:

getDefaultOrdinal()

getOrdinal

public final int getOrdinal()

Gets the ordinal number of the provider.

Specified by:

getOrdinal in interface ModletProvider

Returns:

The ordinal number of the provider.

Since:

1.6

See Also:

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

setOrdinal

public final void setOrdinal(Integer value)

Sets the ordinal number of the provider.

Parameters:

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

Since:

1.6

See Also:

getOrdinal()

findModlets

public Modlets findModlets(ModelContext context,
                  String location)
                    throws ModelException

Searches a given context for Modlets.

Parameters:

context - The context to search for Modlets.

location - The location to search at.

Returns:

The Modlets found at location in context or null, if no Modlets are found.

Throws:

NullPointerException - if context or location is null.

ModelException - if searching the context fails.

See Also:

isValidating(), VALIDATING_ATTRIBUTE_NAME

findModlets

@Deprecated
public Modlets findModlets(ModelContext context)
                    throws ModelException

Deprecated. As of JOMC 1.6, this method has been replaced by findModlets(org.jomc.modlet.ModelContext, org.jomc.modlet.Modlets). This method will be removed in JOMC 2.0.

Searches a given context for Modlets.

Specified by:

findModlets in interface ModletProvider

Parameters:

context - The context to search for Modlets.

Returns:

The Modlets found in the context or null, if no Modlets are found or the provider is disabled.

Throws:

ModelException - if searching the context fails.

See Also:

isEnabled(), getModletLocation(), findModlets(org.jomc.modlet.ModelContext, java.lang.String), ENABLED_ATTRIBUTE_NAME, MODLET_LOCATION_ATTRIBUTE_NAME

findModlets

public Modlets findModlets(ModelContext context,
                  Modlets modlets)
                    throws ModelException

Searches a given context for Modlets.

Specified by:

findModlets in interface ModletProvider

Parameters:

context - The context to search for Modlets.

modlets - The Modlets currently being searched.

Returns:

The Modlets found in the context or null, if no Modlets are found or the provider is disabled.

Throws:

ModelException - if searching the context fails.

Since:

1.6

See Also:

isEnabled(), getModletLocation(), findModlets(org.jomc.modlet.ModelContext, java.lang.String), ENABLED_ATTRIBUTE_NAME, MODLET_LOCATION_ATTRIBUTE_NAME