jomc:show-main-specification

Full name:

org.jomc:maven-jomc-plugin:1.10.1:show-main-specification

Description:

Displays a specification from the project's main model.

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.
  • Since version: 1.1.

Required Parameters

Name Type Since Description
identifier String 1.1 Identifier of the specification to show.
User property is: jomc.identifier.

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.
User property is: jomc.classFileProcessorClassName.
classProcessingEnabled boolean 1.1 Controls processing of class files.
Default value is: true.
User property is: jomc.classProcessing.
classesDirectory String 1.1 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.
User property is: jomc.defaultTemplateEncoding.
defaultTemplateProfile String 1.1 The default template profile to use when accessing templates.
User property is: jomc.defaultTemplateProfile.
document File 1.1 File to write the model to.
User property is: jomc.document.
documentEncoding String 1.1 Encoding of the document to write.
Default value is: ${project.build.sourceEncoding}.
User property is: jomc.documentEncoding.
indentation String 1.1 The indentation string ('\t' for tab).
User property is: jomc.indentation.
javaValidationEnabled boolean 1.4 Flag controlling Java validation.
Default value is: true.
User property is: jomc.javaValidationEnabled.
lineSeparator String 1.1 The line separator ('\r\n' for DOS, '\r' for Mac, '\n' for Unix).
User property is: jomc.lineSeparator.
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 1.1 The identifier of the model to process.
Default value is: http://jomc.org/model.
User property is: jomc.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.
User property is: jomc.modelContextFactoryClassName.
modelObjectClasspathResolutionEnabled boolean 1.1 Controls model object class path resolution.
Default value is: true.
User property is: jomc.modelObjectClasspathResolution.
modelProcessingEnabled boolean 1.1 Controls processing of models.
Default value is: true.
User property is: jomc.modelProcessing.
modelResourceValidationEnabled boolean 1.2 Flag controlling JAXP schema validation of model resources.
Default value is: true.
User property is: jomc.modelResourceValidationEnabled.
modletExcludes List 1.6 Names of modlets to exclude.
User property is: jomc.modletExcludes.
modletIncludes List 1.6 Names of modlets to include.
User property is: jomc.modletIncludes.
modletLocation String 1.1 The location to search for modlets.
User property is: jomc.modletLocation.
modletResourceValidationEnabled boolean 1.2 Flag controlling JAXP schema validation of modlet resources.
Default value is: true.
User property is: jomc.modletResourceValidationEnabled.
modletSchemaSystemId String 1.2 The http://jomc.org/modlet namespace schema system id.
User property is: jomc.modletSchemaSystemId.
moduleLocation String 1.1 The location to search for modules.
User property is: jomc.moduleLocation.
moduleName String 1.1 Name of the module to process.
Default value is: ${project.name}.
User property is: jomc.moduleName.
outputDirectory String 1.1 Output directory of the project.
Default value is: ${project.build.outputDirectory}.
User property is: jomc.outputDirectory.
platformProviderLocation String 1.1 The location to search for platform providers.
User property is: jomc.platformProviderLocation.
providerLocation String 1.1 The location to search for providers.
User property is: jomc.providerLocation.
reportOutputDirectory String 1.1 Directory holding the reports of the project.
Default value is: ${project.reporting.outputDirectory}.
User property is: jomc.reportOutputDirectory.
resourceFileProcessorClassName String 1.2 Class name of the ResourceFileProcessor backing the goal.
Default value is: org.jomc.tools.ResourceFileProcessor.
User property is: jomc.resourceFileProcessorClassName.
resourceProcessingEnabled boolean 1.1 Controls processing of resource files.
Default value is: true.
User property is: jomc.resourceProcessing.
sessionDirectory String 1.1 Directory holding the session related files of the project.
Default value is: ${project.build.directory}/jomc-sessions.
User property is: jomc.sessionDirectory.
showMainSpecificationExecutionStrategy String 1.1 Execution strategy of the goal (always or once-per-session).
Default value is: once-per-session.
User property is: jomc.showMainSpecificationExecutionStrategy.
sourceDirectory String 1.1 Directory holding the source files of the project.
Default value is: ${project.build.sourceDirectory}.
User property is: jomc.sourceDirectory.
sourceEncoding String 1.1 The encoding to use for reading and writing files.
Default value is: ${project.build.sourceEncoding}.
User property is: jomc.sourceEncoding.
sourceFileProcessorClassName String 1.2 Class name of the SourceFileProcessor backing the goal.
Default value is: org.jomc.tools.SourceFileProcessor.
User property is: jomc.sourceFileProcessorClassName.
sourceProcessingEnabled boolean 1.1 Controls processing of source code files.
Default value is: true.
User property is: jomc.sourceProcessing.
templateEncoding String 1.1 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.


User property is: jomc.templateEncoding.
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.


User property is: jomc.templateLocation.
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 and the project's main or test class path. 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 1.1 The template profile to use when accessing templates.
User property is: jomc.templateProfile.
testClassesDirectory String 1.1 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 1.1 Name of the test module to process.
Default value is: ${project.name} Tests.
User property is: jomc.testModuleName.
testOutputDirectory String 1.1 Test output directory of the project.
Default value is: ${project.build.testOutputDirectory}.
User property is: jomc.testOutputDirectory.
testSourceDirectory String 1.1 Directory holding the test source files of the project.
Default value is: ${project.build.testSourceDirectory}.
User property is: jomc.testSourceDirectory.
threads String 1.10 A formula used to calculate the maximum number of threads to create for running tasks in parallel. If the formular contains the character C, the number of threads will be calculated by multiplying the value by the number of available processors. The default number of threads is the number of available processors (1.0C).
Default value is: 1.0C.
User property is: jomc.threads.
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 and the project's main or test class path. 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 1.1 The location to search for transformers.
User property is: jomc.transformerLocation.
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 and the project's main or test class path. 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 1.1 Controls verbosity of the plugin.
Default value is: false.
User property is: jomc.verbose.

Parameter Details

classFileProcessorClassName:

Class name of the ClassFileProcessor backing the goal.
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • User Property: jomc.classFileProcessorClassName
  • Default: org.jomc.tools.ClassFileProcessor

classProcessingEnabled:

Controls processing of class files.
  • Type: boolean
  • Since: 1.1
  • Required: No
  • User Property: 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
  • Since: 1.1
  • Required: No

defaultTemplateEncoding:

The encoding to use for reading templates.
  • Type: java.lang.String
  • Since: 1.3
  • Required: No
  • User Property: jomc.defaultTemplateEncoding

defaultTemplateProfile:

The default template profile to use when accessing templates.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: jomc.defaultTemplateProfile

document:

File to write the model to.
  • Type: java.io.File
  • Since: 1.1
  • Required: No
  • User Property: jomc.document

documentEncoding:

Encoding of the document to write.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: jomc.documentEncoding
  • Default: ${project.build.sourceEncoding}

identifier:

Identifier of the specification to show.
  • Type: java.lang.String
  • Since: 1.1
  • Required: Yes
  • User Property: jomc.identifier

indentation:

The indentation string ('\t' for tab).
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: jomc.indentation

javaValidationEnabled:

Flag controlling Java validation.
  • Type: boolean
  • Since: 1.4
  • Required: No
  • User Property: jomc.javaValidationEnabled
  • Default: true

lineSeparator:

The line separator ('\r\n' for DOS, '\r' for Mac, '\n' for Unix).
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: 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
  • Since: 1.1
  • Required: No
  • User Property: 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
  • User Property: jomc.modelContextFactoryClassName

modelObjectClasspathResolutionEnabled:

Controls model object class path resolution.
  • Type: boolean
  • Since: 1.1
  • Required: No
  • User Property: jomc.modelObjectClasspathResolution
  • Default: true

modelProcessingEnabled:

Controls processing of models.
  • Type: boolean
  • Since: 1.1
  • Required: No
  • User Property: jomc.modelProcessing
  • Default: true

modelResourceValidationEnabled:

Flag controlling JAXP schema validation of model resources.
  • Type: boolean
  • Since: 1.2
  • Required: No
  • User Property: jomc.modelResourceValidationEnabled
  • Default: true

modletExcludes:

Names of modlets to exclude.
  • Type: java.util.List
  • Since: 1.6
  • Required: No
  • User Property: jomc.modletExcludes

modletIncludes:

Names of modlets to include.
  • Type: java.util.List
  • Since: 1.6
  • Required: No
  • User Property: jomc.modletIncludes

modletLocation:

The location to search for modlets.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: jomc.modletLocation

modletResourceValidationEnabled:

Flag controlling JAXP schema validation of modlet resources.
  • Type: boolean
  • Since: 1.2
  • Required: No
  • User Property: jomc.modletResourceValidationEnabled
  • Default: true

modletSchemaSystemId:

The http://jomc.org/modlet namespace schema system id.
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • User Property: jomc.modletSchemaSystemId

moduleLocation:

The location to search for modules.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: jomc.moduleLocation

moduleName:

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

outputDirectory:

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

platformProviderLocation:

The location to search for platform providers.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: jomc.platformProviderLocation

providerLocation:

The location to search for providers.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: jomc.providerLocation

reportOutputDirectory:

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

resourceFileProcessorClassName:

Class name of the ResourceFileProcessor backing the goal.
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • User Property: jomc.resourceFileProcessorClassName
  • Default: org.jomc.tools.ResourceFileProcessor

resourceProcessingEnabled:

Controls processing of resource files.
  • Type: boolean
  • Since: 1.1
  • Required: No
  • User Property: jomc.resourceProcessing
  • Default: true

sessionDirectory:

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

showMainSpecificationExecutionStrategy:

Execution strategy of the goal (always or once-per-session).
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: jomc.showMainSpecificationExecutionStrategy
  • Default: once-per-session

sourceDirectory:

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

sourceEncoding:

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

sourceFileProcessorClassName:

Class name of the SourceFileProcessor backing the goal.
  • Type: java.lang.String
  • Since: 1.2
  • Required: No
  • User Property: jomc.sourceFileProcessorClassName
  • Default: org.jomc.tools.SourceFileProcessor

sourceProcessingEnabled:

Controls processing of source code files.
  • Type: boolean
  • Since: 1.1
  • Required: No
  • User Property: 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
  • Since: 1.1
  • Required: No
  • User Property: 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
  • User Property: 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 and the project's main or test class path. 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
  • Since: 1.1
  • Required: No
  • User Property: 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
  • Since: 1.1
  • Required: No

testModuleName:

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

testOutputDirectory:

Test output directory of the project.
  • Type: java.lang.String
  • Since: 1.1
  • Required: No
  • User Property: 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
  • User Property: jomc.testSourceDirectory
  • Default: ${project.build.testSourceDirectory}

threads:

A formula used to calculate the maximum number of threads to create for running tasks in parallel. If the formular contains the character C, the number of threads will be calculated by multiplying the value by the number of available processors. The default number of threads is the number of available processors (1.0C).
  • Type: java.lang.String
  • Since: 1.10
  • Required: No
  • User Property: jomc.threads
  • Default: 1.0C

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 and the project's main or test class path. 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
  • Since: 1.1
  • Required: No
  • User Property: jomc.transformerLocation

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 and the project's main or test class path. 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
  • Since: 1.1
  • Required: No
  • User Property: jomc.verbose
  • Default: false