jomc:validate-main-classes

Full name:

org.jomc:maven-jomc-plugin:1.6.2:validate-main-classes

Description:

Validates a projects' main class file model objects.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: process-classes.

Optional Parameters

Name Type Since Description
classFileProcessorClassName String 1.2 Class name of the ClassFileProcessor backing the goal.
Default value is: org.jomc.tools.ClassFileProcessor.
classProcessingEnabled boolean - Controls processing of class files.
Default value is: true.
classesDirectory String - Directory holding the compiled class files of the project.

Deprecated: As of JOMC 1.1, please use the 'outputDirectory' parameter. This parameter will be removed in version 2.0.
defaultTemplateEncoding String 1.3 The encoding to use for reading templates.
defaultTemplateProfile String - The default template profile to use when accessing templates.
indentation String - The indentation string ('\t' for tab).
javaValidationEnabled boolean 1.4 Flag controlling Java validation.
Default value is: true.
lineSeparator String - The line separator ('\r\n' for DOS, '\r' for Mac, '\n' for Unix).
locale LocaleType 1.2 The locale. 
<locale>
  <language>Lowercase two-letter ISO-639 code.</language>
  <country>Uppercase two-letter ISO-3166 code.</country>
  <variant>Vendor and browser specific code.</variant>
</locale>

model String - The identifier of the model to process.
Default value is: http://jomc.org/model.
modelContextAttributes List 1.2 ModelContext attributes. 
<modelContextAttributes>
  <modelContextAttribute>
    <key>The name of the attribute.</key>
    <value>The value of the attribute.</value>
    <type>The name of the class of the attributes's object.</type>
  </modelContextAttribute>
</modelContextAttributes>

modelContextFactoryClassName String 1.2 The name of the ModelContextFactory implementation class backing the task.
modelObjectClasspathResolutionEnabled boolean - Controls model object class path resolution.
Default value is: true.
modelProcessingEnabled boolean - Controls processing of models.
Default value is: true.
modelResourceValidationEnabled boolean 1.2 Flag controlling JAXP schema validation of model resources.
Default value is: true.
modletExcludes List 1.6 Names of modlets to exclude.
modletIncludes List 1.6 Names of modlets to include.
modletLocation String - The location to search for modlets.
modletResourceValidationEnabled boolean 1.2 Flag controlling JAXP schema validation of modlet resources.
Default value is: true.
modletSchemaSystemId String 1.2 The http://jomc.org/modlet namespace schema system id.
moduleLocation String - The location to search for modules.
moduleName String - Name of the module to process.
Default value is: ${project.name}.
outputDirectory String 1.1 Output directory of the project.
Default value is: ${project.build.outputDirectory}.
platformProviderLocation String - The location to search for platform providers.
providerLocation String - The location to search for providers.
reportOutputDirectory String 1.1 Directory holding the reports of the project.
Default value is: ${project.reporting.outputDirectory}.
resourceFileProcessorClassName String 1.2 Class name of the ResourceFileProcessor backing the goal.
Default value is: org.jomc.tools.ResourceFileProcessor.
resourceProcessingEnabled boolean - Controls processing of resource files.
Default value is: true.
sessionDirectory String 1.1 Directory holding the session related files of the project.
Default value is: ${project.build.directory}/jomc-sessions.
sourceDirectory String 1.1 Directory holding the source files of the project.
Default value is: ${project.build.sourceDirectory}.
sourceEncoding String - The encoding to use for reading and writing files.
Default value is: ${project.build.sourceEncoding}.
sourceFileProcessorClassName String 1.2 Class name of the SourceFileProcessor backing the goal.
Default value is: org.jomc.tools.SourceFileProcessor.
sourceProcessingEnabled boolean - Controls processing of source code files.
Default value is: true.
templateEncoding String - The encoding to use for reading templates.

Deprecated: As of JOMC 1.3, please use the 'defaultTemplateEncoding' parameter. This parameter will be removed in version 2.0.
templateLocation String 1.2 Location to search for templates in addition to searching the class path of the plugin.

First an attempt is made to parse the location value to an URL. On successful parsing, that URL is used. Otherwise the location value is interpreted as a directory name relative to the base directory of the project. If that directory exists, that directory is used. If nothing is found at the given location, a warning message is logged.
templateParameterResources List 1.2 Template parameter resources. 
<templateParameterResources>
  <templateParameterResource>
    <location>The location of the properties resource.</location>
    <optional>Flag indicating the properties resource is optional.</optional>
    <format>The format of the properties resource.</format>
    <connectTimeout>Timeout value, in milliseconds.</connectTimeout>
    <readTimeout>Timeout value, in milliseconds.</readTimeout>
  </templateParameterResource>
</templateParameterResources>

The location value is used to first search the class path of the plugin. If a class path resource is found, that resource is used. If no class path resource is found, an attempt is made to parse the location value to an URL. On successful parsing, that URL is used. Otherwise the location value is interpreted as a file name relative to the base directory of the project. If that file exists, that file is used. If nothing is found at the given location, depending on the optional flag, a warning message is logged or a build failure is produced.

The optional flag is used to flag the resource optional. When an optional resource is not found, a warning message is logged instead of producing a build failure.
Default value is: false

The format value is used to specify the format of the properties resource. Supported values are plain and xml.
Default value is: plain

The connectTimeout value is used to specify the timeout, in milliseconds, to be used when opening communications links to the resource. A timeout of zero is interpreted as an infinite timeout.
Default value is: 60000

The readTimeout value is used to specify the timeout, in milliseconds, to be used when reading the resource. A timeout of zero is interpreted as an infinite timeout.
Default value is: 60000
templateParameters List 1.2 Template parameters. 
<templateParameters>
  <templateParameter>
    <key>The name of the parameter.</key>
    <value>The value of the parameter.</value>
    <type>The name of the class of the parameter's object.</type>
  </templateParameter>
</templateParameters>

templateProfile String - The template profile to use when accessing templates.
testClassesDirectory String - Directory holding the compiled test class files of the project.

Deprecated: As of JOMC 1.1, please use the 'testOutputDirectory' parameter. This parameter will be removed in version 2.0.
testModuleName String - Name of the test module to process.
Default value is: ${project.name} Tests.
testOutputDirectory String 1.1 Test output directory of the project.
Default value is: ${project.build.testOutputDirectory}.
testSourceDirectory String 1.1 Directory holding the test source files of the project.
Default value is: ${project.build.testSourceDirectory}.
transformationOutputProperties List 1.2 Global transformation output properties. 
<transformationOutputProperties>
  <transformationOutputProperty>
    <key>The name of the property.</key>
    <value>The value of the property.</value>
    <type>The name of the class of the properties object.</type>
  </transformationOutputProperty>
</transformationOutputProperties>

transformationParameterResources List 1.2 Global transformation parameter resources. 
<transformationParameterResources>
  <transformationParameterResource>
    <location>The location of the properties resource.</location>
    <optional>Flag indicating the properties resource is optional.</optional>
    <format>The format of the properties resource.</format>
    <connectTimeout>Timeout value, in milliseconds.</connectTimeout>
    <readTimeout>Timeout value, in milliseconds.</readTimeout>
  </transformationParameterResource>
</transformationParameterResources>

The location value is used to first search the class path of the plugin. If a class path resource is found, that resource is used. If no class path resource is found, an attempt is made to parse the location value to an URL. On successful parsing, that URL is used. Otherwise the location value is interpreted as a file name relative to the base directory of the project. If that file exists, that file is used. If nothing is found at the given location, depending on the optional flag, a warning message is logged or a build failure is produced.

The optional flag is used to flag the resource optional. When an optional resource is not found, a warning message is logged instead of producing a build failure.
Default value is: false

The format value is used to specify the format of the properties resource. Supported values are plain and xml.
Default value is: plain

The connectTimeout value is used to specify the timeout, in milliseconds, to be used when opening communications links to the resource. A timeout of zero is interpreted as an infinite timeout.
Default value is: 60000

The readTimeout value is used to specify the timeout, in milliseconds, to be used when reading the resource. A timeout of zero is interpreted as an infinite timeout.
Default value is: 60000
transformationParameters List 1.2 Global transformation parameters. 
<transformationParameters>
  <transformationParameter>
    <key>The name of the parameter.</key>
    <value>The value of the parameter.</value>
    <type>The name of the class of the parameter's object.</type>
  </transformationParameter>
</transformationParameters>

transformerLocation String - The location to search for transformers.
validateMainClassesExecutionStrategy String 1.1 Execution strategy of the goal (always or once-per-session).
Default value is: once-per-session.
velocityProperties List 1.2 Velocity runtime properties. 
<velocityProperties>
  <velocityProperty>
    <key>The name of the property.</key>
    <value>The value of the property.</value>
    <type>The name of the class of the properties object.</type>
  </velocityProperty>
</velocityProperties>

velocityPropertyResources List 1.2 Velocity runtime property resources. 
<velocityPropertyResources>
  <velocityPropertyResource>
    <location>The location of the properties resource.</location>
    <optional>Flag indicating the properties resource is optional.</optional>
    <format>The format of the properties resource.</format>
    <connectTimeout>Timeout value, in milliseconds.</connectTimeout>
    <readTimeout>Timeout value, in milliseconds.</readTimeout>
  </velocityPropertyResource>
</velocityPropertyResources>

The location value is used to first search the class path of the plugin. If a class path resource is found, that resource is used. If no class path resource is found, an attempt is made to parse the location value to an URL. On successful parsing, that URL is used. Otherwise the location value is interpreted as a file name relative to the base directory of the project. If that file exists, that file is used. If nothing is found at the given location, depending on the optional flag, a warning message is logged or a build failure is produced.

The optional flag is used to flag the resource optional. When an optional resource is not found, a warning message is logged instead of producing a build failure.
Default value is: false

The format value is used to specify the format of the properties resource. Supported values are plain and xml.
Default value is: plain

The connectTimeout value is used to specify the timeout, in milliseconds, to be used when opening communications links to the resource. A timeout of zero is interpreted as an infinite timeout.
Default value is: 60000

The readTimeout value is used to specify the timeout, in milliseconds, to be used when reading the resource. A timeout of zero is interpreted as an infinite timeout.
Default value is: 60000
verbose boolean - Controls verbosity of the plugin.
Default value is: false.

Parameter Details

classFileProcessorClassName:

Class name of the ClassFileProcessor backing the goal.
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • Expression: ${jomc.classFileProcessorClassName}
  • Default: org.jomc.tools.ClassFileProcessor

classProcessingEnabled:

Controls processing of class files.
  • Type: boolean
  • Required: No
  • Expression: ${jomc.classProcessing}
  • Default: true

classesDirectory:

Directory holding the compiled class files of the project.

Deprecated: As of JOMC 1.1, please use the 'outputDirectory' parameter. This parameter will be removed in version 2.0.

  • Type: java.lang.String
  • Required: No

defaultTemplateEncoding:

The encoding to use for reading templates.
  • Type: java.lang.String
  • Since: 1.3
  • Required: No
  • Expression: ${jomc.defaultTemplateEncoding}

defaultTemplateProfile:

The default template profile to use when accessing templates.
  • Type: java.lang.String
  • Required: No
  • Expression: ${jomc.defaultTemplateProfile}

indentation:

The indentation string ('\t' for tab).
  • Type: java.lang.String
  • Required: No
  • Expression: ${jomc.indentation}

javaValidationEnabled:

Flag controlling Java validation.
  • Type: boolean
  • Since: 1.4
  • Required: No
  • Expression: ${jomc.javaValidationEnabled}
  • Default: true

lineSeparator:

The line separator ('\r\n' for DOS, '\r' for Mac, '\n' for Unix).
  • Type: java.lang.String
  • Required: No
  • Expression: ${jomc.lineSeparator}

locale:

The locale. 
<locale>
  <language>Lowercase two-letter ISO-639 code.</language>
  <country>Uppercase two-letter ISO-3166 code.</country>
  <variant>Vendor and browser specific code.</variant>
</locale>
  • Type: org.jomc.mojo.LocaleType
  • Since: 1.2
  • Required: No

model:

The identifier of the model to process.
  • Type: java.lang.String
  • Required: No
  • Expression: ${jomc.model}
  • Default: http://jomc.org/model

modelContextAttributes:

ModelContext attributes. 
<modelContextAttributes>
  <modelContextAttribute>
    <key>The name of the attribute.</key>
    <value>The value of the attribute.</value>
    <type>The name of the class of the attributes's object.</type>
  </modelContextAttribute>
</modelContextAttributes>
  • Type: java.util.List
  • Since: 1.2
  • Required: No

modelContextFactoryClassName:

The name of the ModelContextFactory implementation class backing the task.
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • Expression: ${jomc.modelContextFactoryClassName}

modelObjectClasspathResolutionEnabled:

Controls model object class path resolution.
  • Type: boolean
  • Required: No
  • Expression: ${jomc.modelObjectClasspathResolution}
  • Default: true

modelProcessingEnabled:

Controls processing of models.
  • Type: boolean
  • Required: No
  • Expression: ${jomc.modelProcessing}
  • Default: true

modelResourceValidationEnabled:

Flag controlling JAXP schema validation of model resources.
  • Type: boolean
  • Since: 1.2
  • Required: No
  • Expression: ${jomc.modelResourceValidationEnabled}
  • Default: true

modletExcludes:

Names of modlets to exclude.
  • Type: java.util.List
  • Since: 1.6
  • Required: No
  • Expression: ${jomc.modletExcludes}

modletIncludes:

Names of modlets to include.
  • Type: java.util.List
  • Since: 1.6
  • Required: No
  • Expression: ${jomc.modletIncludes}

modletLocation:

The location to search for modlets.
  • Type: java.lang.String
  • Required: No
  • Expression: ${jomc.modletLocation}

modletResourceValidationEnabled:

Flag controlling JAXP schema validation of modlet resources.
  • Type: boolean
  • Since: 1.2
  • Required: No
  • Expression: ${jomc.modletResourceValidationEnabled}
  • Default: true

modletSchemaSystemId:

The http://jomc.org/modlet namespace schema system id.
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • Expression: ${jomc.modletSchemaSystemId}

moduleLocation:

The location to search for modules.
  • Type: java.lang.String
  • Required: No
  • Expression: ${jomc.moduleLocation}

moduleName:

Name of the module to process.
  • Type: java.lang.String
  • Required: No
  • Expression: ${jomc.moduleName}
  • Default: ${project.name}

outputDirectory:

Output directory of the project.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • Expression: ${jomc.outputDirectory}
  • Default: ${project.build.outputDirectory}

platformProviderLocation:

The location to search for platform providers.
  • Type: java.lang.String
  • Required: No
  • Expression: ${jomc.platformProviderLocation}

providerLocation:

The location to search for providers.
  • Type: java.lang.String
  • Required: No
  • Expression: ${jomc.providerLocation}

reportOutputDirectory:

Directory holding the reports of the project.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • Expression: ${jomc.reportOutputDirectory}
  • Default: ${project.reporting.outputDirectory}

resourceFileProcessorClassName:

Class name of the ResourceFileProcessor backing the goal.
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • Expression: ${jomc.resourceFileProcessorClassName}
  • Default: org.jomc.tools.ResourceFileProcessor

resourceProcessingEnabled:

Controls processing of resource files.
  • Type: boolean
  • Required: No
  • Expression: ${jomc.resourceProcessing}
  • Default: true

sessionDirectory:

Directory holding the session related files of the project.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • Expression: ${jomc.sessionDirectory}
  • Default: ${project.build.directory}/jomc-sessions

sourceDirectory:

Directory holding the source files of the project.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • Expression: ${jomc.sourceDirectory}
  • Default: ${project.build.sourceDirectory}

sourceEncoding:

The encoding to use for reading and writing files.
  • Type: java.lang.String
  • Required: No
  • Expression: ${jomc.sourceEncoding}
  • Default: ${project.build.sourceEncoding}

sourceFileProcessorClassName:

Class name of the SourceFileProcessor backing the goal.
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • Expression: ${jomc.sourceFileProcessorClassName}
  • Default: org.jomc.tools.SourceFileProcessor

sourceProcessingEnabled:

Controls processing of source code files.
  • Type: boolean
  • Required: No
  • Expression: ${jomc.sourceProcessing}
  • Default: true

templateEncoding:

The encoding to use for reading templates.

Deprecated: As of JOMC 1.3, please use the 'defaultTemplateEncoding' parameter. This parameter will be removed in version 2.0.

  • Type: java.lang.String
  • Required: No
  • Expression: ${jomc.templateEncoding}

templateLocation:

Location to search for templates in addition to searching the class path of the plugin.

First an attempt is made to parse the location value to an URL. On successful parsing, that URL is used. Otherwise the location value is interpreted as a directory name relative to the base directory of the project. If that directory exists, that directory is used. If nothing is found at the given location, a warning message is logged.

  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • Expression: ${jomc.templateLocation}

templateParameterResources:

Template parameter resources. 
<templateParameterResources>
  <templateParameterResource>
    <location>The location of the properties resource.</location>
    <optional>Flag indicating the properties resource is optional.</optional>
    <format>The format of the properties resource.</format>
    <connectTimeout>Timeout value, in milliseconds.</connectTimeout>
    <readTimeout>Timeout value, in milliseconds.</readTimeout>
  </templateParameterResource>
</templateParameterResources>

The location value is used to first search the class path of the plugin. If a class path resource is found, that resource is used. If no class path resource is found, an attempt is made to parse the location value to an URL. On successful parsing, that URL is used. Otherwise the location value is interpreted as a file name relative to the base directory of the project. If that file exists, that file is used. If nothing is found at the given location, depending on the optional flag, a warning message is logged or a build failure is produced.

The optional flag is used to flag the resource optional. When an optional resource is not found, a warning message is logged instead of producing a build failure.
Default value is: false

The format value is used to specify the format of the properties resource. Supported values are plain and xml.
Default value is: plain

The connectTimeout value is used to specify the timeout, in milliseconds, to be used when opening communications links to the resource. A timeout of zero is interpreted as an infinite timeout.
Default value is: 60000

The readTimeout value is used to specify the timeout, in milliseconds, to be used when reading the resource. A timeout of zero is interpreted as an infinite timeout.
Default value is: 60000

  • Type: java.util.List
  • Since: 1.2
  • Required: No

templateParameters:

Template parameters. 
<templateParameters>
  <templateParameter>
    <key>The name of the parameter.</key>
    <value>The value of the parameter.</value>
    <type>The name of the class of the parameter's object.</type>
  </templateParameter>
</templateParameters>
  • Type: java.util.List
  • Since: 1.2
  • Required: No

templateProfile:

The template profile to use when accessing templates.
  • Type: java.lang.String
  • Required: No
  • Expression: ${jomc.templateProfile}

testClassesDirectory:

Directory holding the compiled test class files of the project.

Deprecated: As of JOMC 1.1, please use the 'testOutputDirectory' parameter. This parameter will be removed in version 2.0.

  • Type: java.lang.String
  • Required: No

testModuleName:

Name of the test module to process.
  • Type: java.lang.String
  • Required: No
  • Expression: ${jomc.testModuleName}
  • Default: ${project.name} Tests

testOutputDirectory:

Test output directory of the project.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • Expression: ${jomc.testOutputDirectory}
  • Default: ${project.build.testOutputDirectory}

testSourceDirectory:

Directory holding the test source files of the project.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • Expression: ${jomc.testSourceDirectory}
  • Default: ${project.build.testSourceDirectory}

transformationOutputProperties:

Global transformation output properties. 
<transformationOutputProperties>
  <transformationOutputProperty>
    <key>The name of the property.</key>
    <value>The value of the property.</value>
    <type>The name of the class of the properties object.</type>
  </transformationOutputProperty>
</transformationOutputProperties>
  • Type: java.util.List
  • Since: 1.2
  • Required: No

transformationParameterResources:

Global transformation parameter resources. 
<transformationParameterResources>
  <transformationParameterResource>
    <location>The location of the properties resource.</location>
    <optional>Flag indicating the properties resource is optional.</optional>
    <format>The format of the properties resource.</format>
    <connectTimeout>Timeout value, in milliseconds.</connectTimeout>
    <readTimeout>Timeout value, in milliseconds.</readTimeout>
  </transformationParameterResource>
</transformationParameterResources>

The location value is used to first search the class path of the plugin. If a class path resource is found, that resource is used. If no class path resource is found, an attempt is made to parse the location value to an URL. On successful parsing, that URL is used. Otherwise the location value is interpreted as a file name relative to the base directory of the project. If that file exists, that file is used. If nothing is found at the given location, depending on the optional flag, a warning message is logged or a build failure is produced.

The optional flag is used to flag the resource optional. When an optional resource is not found, a warning message is logged instead of producing a build failure.
Default value is: false

The format value is used to specify the format of the properties resource. Supported values are plain and xml.
Default value is: plain

The connectTimeout value is used to specify the timeout, in milliseconds, to be used when opening communications links to the resource. A timeout of zero is interpreted as an infinite timeout.
Default value is: 60000

The readTimeout value is used to specify the timeout, in milliseconds, to be used when reading the resource. A timeout of zero is interpreted as an infinite timeout.
Default value is: 60000

  • Type: java.util.List
  • Since: 1.2
  • Required: No

transformationParameters:

Global transformation parameters. 
<transformationParameters>
  <transformationParameter>
    <key>The name of the parameter.</key>
    <value>The value of the parameter.</value>
    <type>The name of the class of the parameter's object.</type>
  </transformationParameter>
</transformationParameters>
  • Type: java.util.List
  • Since: 1.2
  • Required: No

transformerLocation:

The location to search for transformers.
  • Type: java.lang.String
  • Required: No
  • Expression: ${jomc.transformerLocation}

validateMainClassesExecutionStrategy:

Execution strategy of the goal (always or once-per-session).
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • Expression: ${jomc.validateMainClassesExecutionStrategy}
  • Default: once-per-session

velocityProperties:

Velocity runtime properties. 
<velocityProperties>
  <velocityProperty>
    <key>The name of the property.</key>
    <value>The value of the property.</value>
    <type>The name of the class of the properties object.</type>
  </velocityProperty>
</velocityProperties>
  • Type: java.util.List
  • Since: 1.2
  • Required: No

velocityPropertyResources:

Velocity runtime property resources. 
<velocityPropertyResources>
  <velocityPropertyResource>
    <location>The location of the properties resource.</location>
    <optional>Flag indicating the properties resource is optional.</optional>
    <format>The format of the properties resource.</format>
    <connectTimeout>Timeout value, in milliseconds.</connectTimeout>
    <readTimeout>Timeout value, in milliseconds.</readTimeout>
  </velocityPropertyResource>
</velocityPropertyResources>

The location value is used to first search the class path of the plugin. If a class path resource is found, that resource is used. If no class path resource is found, an attempt is made to parse the location value to an URL. On successful parsing, that URL is used. Otherwise the location value is interpreted as a file name relative to the base directory of the project. If that file exists, that file is used. If nothing is found at the given location, depending on the optional flag, a warning message is logged or a build failure is produced.

The optional flag is used to flag the resource optional. When an optional resource is not found, a warning message is logged instead of producing a build failure.
Default value is: false

The format value is used to specify the format of the properties resource. Supported values are plain and xml.
Default value is: plain

The connectTimeout value is used to specify the timeout, in milliseconds, to be used when opening communications links to the resource. A timeout of zero is interpreted as an infinite timeout.
Default value is: 60000

The readTimeout value is used to specify the timeout, in milliseconds, to be used when reading the resource. A timeout of zero is interpreted as an infinite timeout.
Default value is: 60000

  • Type: java.util.List
  • Since: 1.2
  • Required: No

verbose:

Controls verbosity of the plugin.
  • Type: boolean
  • Required: No
  • Expression: ${jomc.verbose}
  • Default: false