org.jomc.tools.modlet
Class ToolsModelProvider

Package class diagram package ToolsModelProvider
java.lang.Object
  extended by org.jomc.tools.modlet.ToolsModelProvider
All Implemented Interfaces:
ModelProvider

public class ToolsModelProvider
extends Object
implements ModelProvider

Object management and configuration tools ModelProvider implementation.

Since:
1.2
Version:
$JOMC: ToolsModelProvider.java 4352 2012-03-01 11:19:48Z schulte2005 $
Author:
Christian Schulte
See Also:
ModelContext.findModel(java.lang.String)

Field Summary
static String ENABLED_ATTRIBUTE_NAME
          Constant for the name of the model context attribute backing property enabled.
static String MODEL_OBJECT_CLASSPATH_RESOLUTION_ENABLED_ATTRIBUTE_NAME
          Constant for the name of the model context attribute backing property modelObjectClasspathResolutionEnabled.
 
Constructor Summary
ToolsModelProvider()
          Creates a new ToolsModelProvider instance.
 
Method Summary
 Model findModel(ModelContext context, Model model)
          
static boolean isDefaultEnabled()
          Gets a flag indicating the provider is enabled by default.
static boolean isDefaultModelObjectClasspathResolutionEnabled()
          Gets a flag indicating model object class path resolution is enabled by default.
 boolean isEnabled()
          Gets a flag indicating the provider is enabled.
 boolean isModelObjectClasspathResolutionEnabled()
          Gets a flag indicating model object class path resolution is enabled.
static void setDefaultEnabled(Boolean value)
          Sets the flag indicating the provider is enabled by default.
static void setDefaultModelObjectClasspathResolutionEnabled(Boolean value)
          Sets the flag indicating model object class path resolution is enabled by default.
 void setEnabled(Boolean value)
          Sets the flag indicating the provider is enabled.
 void setModelObjectClasspathResolutionEnabled(Boolean value)
          Sets the flag indicating model object class path resolution is is enabled.
 
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:
findModel(org.jomc.modlet.ModelContext, org.jomc.modlet.Model), ModelContext.getAttribute(java.lang.String), Constant Field Values

MODEL_OBJECT_CLASSPATH_RESOLUTION_ENABLED_ATTRIBUTE_NAME

public static final String MODEL_OBJECT_CLASSPATH_RESOLUTION_ENABLED_ATTRIBUTE_NAME
Constant for the name of the model context attribute backing property modelObjectClasspathResolutionEnabled.

See Also:
findModel(org.jomc.modlet.ModelContext, org.jomc.modlet.Model), ModelContext.getAttribute(java.lang.String), Constant Field Values
Constructor Detail

ToolsModelProvider

public ToolsModelProvider()
Creates a new ToolsModelProvider 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.tools.modlet.ToolsModelProvider.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:
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()

isDefaultModelObjectClasspathResolutionEnabled

public static boolean isDefaultModelObjectClasspathResolutionEnabled()
Gets a flag indicating model object class path resolution is enabled by default.

The model object class path resolution default enabled flag is controlled by system property org.jomc.tools.modlet.ToolsModelProvider.defaultModelObjectClasspathResolutionEnabled holding a value indicating model object class path resolution is enabled by default. If that property is not set, the true default is returned.

Returns:
true, if model object class path resolution is enabled by default; false, if model object class path resolution is disabled by default.
See Also:
setDefaultModelObjectClasspathResolutionEnabled(java.lang.Boolean)

setDefaultModelObjectClasspathResolutionEnabled

public static void setDefaultModelObjectClasspathResolutionEnabled(Boolean value)
Sets the flag indicating model object class path resolution is enabled by default.

Parameters:
value - The new value of the flag indicating model object class path resolution is enabled by default or null.
See Also:
isDefaultModelObjectClasspathResolutionEnabled()

isModelObjectClasspathResolutionEnabled

public final boolean isModelObjectClasspathResolutionEnabled()
Gets a flag indicating model object class path resolution is enabled.

Returns:
true, if model object class path resolution is enabled; false, if model object class path resolution is disabled.
See Also:
isDefaultModelObjectClasspathResolutionEnabled(), setModelObjectClasspathResolutionEnabled(java.lang.Boolean)

setModelObjectClasspathResolutionEnabled

public final void setModelObjectClasspathResolutionEnabled(Boolean value)
Sets the flag indicating model object class path resolution is is enabled.

Parameters:
value - The new value of the flag indicating model object class path resolution is enabled or null.
See Also:
isModelObjectClasspathResolutionEnabled()

findModel

public Model findModel(ModelContext context,
                       Model model)
                throws ModelException

Specified by:
findModel in interface ModelProvider
Throws:
ModelException
See Also:
isEnabled(), isModelObjectClasspathResolutionEnabled(), ENABLED_ATTRIBUTE_NAME, MODEL_OBJECT_CLASSPATH_RESOLUTION_ENABLED_ATTRIBUTE_NAME


Copyright © 2005-2012 The JOMC Project. All Rights Reserved.Get JOMC at SourceForge.net. Fast, secure and Free Open Source software downloads
Please note that this documentation is maintained by non-native english speaking authors. As such, you may encounter phrases or wordings which seem imprecise or may even have a totally different meaning to native english speaking readers than what the individual author was trying to express. If you are a native english speaking reader and find any such phrases or wordings we kindly ask you to send an email to the corresponding author and help us improve this documentation in order to avoid misunderstandings. You will find the authors' email addresses at the top of each class. Please accept our apologies for any inconvenience caused.