org.jomc.tools.modlet

Class ToolsModelProvider

java.lang.Object

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 5043 2015-05-27 07:03:39Z schulte $

Author:

Christian Schulte

See Also:

ModelContext.findModel(java.lang.String)

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	HEAD_COMMENT_ATTRIBUTE_NAME Constant for the name of the model context attribute backing property headComment.
static String	MODEL_OBJECT_CLASSPATH_RESOLUTION_ENABLED_ATTRIBUTE_NAME Constant for the name of the model context attribute backing property modelObjectClasspathResolutionEnabled.
static String	TAIL_COMMENT_ATTRIBUTE_NAME Constant for the name of the model context attribute backing property tailComment.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
Model	findModel(ModelContext context, Model model)
static String	getDefaultHeadComment() Gets the head comment the provider is providing by default.
protected String	getDefaultSourceFileLocation(ModelContext context, Modules modules, Implementation implementation) Gets the default source code file location for a given implementation.
protected String	getDefaultSourceFileLocation(ModelContext context, Modules modules, Specification specification) Gets the default source code file location for a given specification.
protected SourceFilesType	getDefaultSourceFilesType(ModelContext context, Modules modules, Implementation implementation) Creates a new default source files model for a given implementation.
protected SourceFilesType	getDefaultSourceFilesType(ModelContext context, Modules modules, Specification specification) Creates a new default source files model for a given specification.
protected String	getDefaultSourceSectionName(ModelContext context, Modules modules, Implementation implementation) Gets the default source section name for a given implementation.
protected String	getDefaultSourceSectionName(ModelContext context, Modules modules, Specification specification) Gets the default source section name for a given specification.
static String	getDefaultTailComment() Gets the tail comment the provider is providing by default.
String	getHeadComment() Gets the head comment the provider is providing.
String	getTailComment() Gets the tail comment the provider is providing.
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	setDefaultHeadComment(String value) Sets the head comment the provider is providing by default.
static void	setDefaultModelObjectClasspathResolutionEnabled(Boolean value) Sets the flag indicating model object class path resolution is enabled by default.
static void	setDefaultTailComment(String value) Sets the tail comment the provider is providing by default.
void	setEnabled(Boolean value) Sets the flag indicating the provider is enabled.
void	setHeadComment(String value) Sets the head comment the provider is providing.
void	setModelObjectClasspathResolutionEnabled(Boolean value) Sets the flag indicating model object class path resolution is is enabled.
void	setTailComment(String value) Sets the tail comment the provider is providing.

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

HEAD_COMMENT_ATTRIBUTE_NAME

public static final String HEAD_COMMENT_ATTRIBUTE_NAME

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

Since:

1.6

See Also:

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

TAIL_COMMENT_ATTRIBUTE_NAME

public static final String TAIL_COMMENT_ATTRIBUTE_NAME

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

Since:

1.6

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()

getDefaultHeadComment

public static String getDefaultHeadComment()

Gets the head comment the provider is providing by default.

The default head comment is controlled by system property org.jomc.tools.modlet.ToolsModelProvider.defaultHeadComment holding the head comment the provider is providing by default. If that property is not set, the // default is returned.

Returns:

The head comment the provider is providing by default or null.

Since:

1.6

See Also:

setDefaultHeadComment(java.lang.String)

setDefaultHeadComment

public static void setDefaultHeadComment(String value)

Sets the head comment the provider is providing by default.

Parameters:

value - The new head comment the provider is providing by default or null.

Since:

1.6

See Also:

getDefaultHeadComment()

getHeadComment

public final String getHeadComment()

Gets the head comment the provider is providing.

Returns:

The head comment the provider is providing or null.

Since:

1.6

See Also:

getDefaultHeadComment(), setDefaultHeadComment(java.lang.String)

setHeadComment

public final void setHeadComment(String value)

Sets the head comment the provider is providing.

Parameters:

value - The new head comment the provider is providing or null.

Since:

1.6

See Also:

getHeadComment()

getDefaultTailComment

public static String getDefaultTailComment()

Gets the tail comment the provider is providing by default.

The default tail comment is controlled by system property org.jomc.tools.modlet.ToolsModelProvider.defaultTailComment holding the tail comment the provider is providing by default. If that property is not set, the null default is returned.

Returns:

The tail comment the provider is providing by default or null.

Since:

1.6

See Also:

setDefaultTailComment(java.lang.String)

setDefaultTailComment

public static void setDefaultTailComment(String value)

Sets the tail comment the provider is providing by default.

Parameters:

value - The new tail comment the provider is providing by default or null.

Since:

1.6

See Also:

getDefaultTailComment()

getTailComment

public final String getTailComment()

Gets the tail comment the provider is providing.

Returns:

The tail comment the provider is providing or null.

Since:

1.6

See Also:

getDefaultTailComment(), setDefaultTailComment(java.lang.String)

setTailComment

public final void setTailComment(String value)

Sets the tail comment the provider is providing.

Parameters:

value - The new tail comment the provider is providing or null.

Since:

1.6

See Also:

getTailComment()

findModel

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

Specified by:

findModel in interface ModelProvider

Throws:

ModelException

See Also:

isEnabled(), isModelObjectClasspathResolutionEnabled(), getHeadComment(), getTailComment(), ENABLED_ATTRIBUTE_NAME, MODEL_OBJECT_CLASSPATH_RESOLUTION_ENABLED_ATTRIBUTE_NAME, HEAD_COMMENT_ATTRIBUTE_NAME, TAIL_COMMENT_ATTRIBUTE_NAME

getDefaultSourceFileLocation

protected String getDefaultSourceFileLocation(ModelContext context,
                                  Modules modules,
                                  Specification specification)

Gets the default source code file location for a given specification.

If the specification provides a Java type name, this method returns a Java source code file location based on that Java type name.

Parameters:

context - The context to get the default location with.

modules - The model to get the default location with.

specification - The specification to get the default location for.

Returns:

The default location for specification or null.

Throws:

NullPointerException - if context, modules or specification is null.

Since:

1.6

See Also:

getDefaultSourceFilesType(org.jomc.modlet.ModelContext, org.jomc.model.Modules, org.jomc.model.Specification), SourceFileType.getLocation(), Specification.getJavaTypeName()

getDefaultSourceFileLocation

protected String getDefaultSourceFileLocation(ModelContext context,
                                  Modules modules,
                                  Implementation implementation)

Gets the default source code file location for a given implementation.

If the implementation provides a Java type name, this method returns a Java source code file location based on that Java type name.

Parameters:

context - The context to get the default location with.

modules - The model to get the default location with.

implementation - The implementation to get the default location for.

Returns:

The default location for implementation or null.

Throws:

NullPointerException - if context, modules or implementation is null.

Since:

1.6

See Also:

getDefaultSourceFilesType(org.jomc.modlet.ModelContext, org.jomc.model.Modules, org.jomc.model.Implementation), SourceFileType.getLocation(), Implementation.getJavaTypeName()

getDefaultSourceSectionName

protected String getDefaultSourceSectionName(ModelContext context,
                                 Modules modules,
                                 Specification specification)

Gets the default source section name for a given specification.

If the specification provides a Java type name, this method returns a section name based on that Java type name.

Parameters:

context - The context to get the default section name with.

modules - The model to get the default section name with.

specification - The specification to get the default section name for.

Returns:

The default source section name for specification or null.

Throws:

NullPointerException - if context, modules or specification is null.

Since:

1.6

See Also:

getDefaultSourceFilesType(org.jomc.modlet.ModelContext, org.jomc.model.Modules, org.jomc.model.Specification), SourceSectionType.getName(), Specification.getJavaTypeName()

getDefaultSourceSectionName

protected String getDefaultSourceSectionName(ModelContext context,
                                 Modules modules,
                                 Implementation implementation)

Gets the default source section name for a given implementation.

If the implementation provides a Java type name, this method returns a section name based that Java type name.

Parameters:

context - The context to get the default section name with.

modules - The model to get the default section name with.

implementation - The implementation to get the default section name for.

Returns:

The default source section name for implementation or null.

Throws:

NullPointerException - if context, modules or implementation is null.

Since:

1.6

See Also:

getDefaultSourceFilesType(org.jomc.modlet.ModelContext, org.jomc.model.Modules, org.jomc.model.Implementation), SourceSectionType.getName(), Implementation.getJavaTypeName()

getDefaultSourceFilesType

protected SourceFilesType getDefaultSourceFilesType(ModelContext context,
                                        Modules modules,
                                        Specification specification)

Creates a new default source files model for a given specification.

Parameters:

context - The context to create a new default source files model with.

modules - The model to create a new default source files model with.

specification - The specification to create a new default source files model for.

Returns:

A new default source files model for specification.

Throws:

NullPointerException - if context, modules or specification is null.

Since:

1.6

See Also:

getDefaultSourceFileLocation(org.jomc.modlet.ModelContext, org.jomc.model.Modules, org.jomc.model.Specification), getDefaultSourceSectionName(org.jomc.modlet.ModelContext, org.jomc.model.Modules, org.jomc.model.Specification)

getDefaultSourceFilesType

protected SourceFilesType getDefaultSourceFilesType(ModelContext context,
                                        Modules modules,
                                        Implementation implementation)

Creates a new default source files model for a given implementation.

Parameters:

context - The context to create a new default source files model with.

modules - The model to create a new default source files model with.

implementation - The implementation to create a new default source files model for.

Returns:

A new default source files model for implementation.

Throws:

NullPointerException - if context, modules or implementation is null.

Since:

1.6

See Also:

getDefaultSourceFileLocation(org.jomc.modlet.ModelContext, org.jomc.model.Modules, org.jomc.model.Implementation), getDefaultSourceSectionName(org.jomc.modlet.ModelContext, org.jomc.model.Modules, org.jomc.model.Implementation)