jdtaus-container-mojo:java-commit

Full name:

org.jdtaus.mojo:jdtaus-container-mojo:3.13:java-commit

Description:

Mojo to commit container meta-data to compiled java classes.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Binds by default to the lifecycle phase: process-classes.

Optional Parameters

Name Type Since Description
classPathElementsExcludeRegexp String - A regular expression used for excluding elements from the runtime classpath elements. By default no elements will be excluded.
constructorsEndingMarker String - The string marking the ending line up to where constructor code should be inserted.
Default value is: //------------------------------------------------------------Constructors--.
constructorsStartingMarker String - The string marking the starting line where to start inserting constructor code.
Default value is: //--Constructors------------------------------------------------------------.
dependenciesEndingMarker String - The string marking the ending line up to where dependency code should be inserted.
Default value is: //------------------------------------------------------------Dependencies--.
dependenciesStartingMarker String - The string marking the starting line where to start inserting dependency code.
Default value is: //--Dependencies------------------------------------------------------------.
encoding String - The encoding to use for reading and writing sources. By default the system's default encoding will be used.
Default value is: ${project.build.sourceEncoding}.
implementationsEndingMarker String - The string marking the ending line up to where implementation code should be inserted.
Default value is: //----------------------------------------------------------Implementation--.
implementationsStartingMarker String - The string marking the starting line where to start inserting implementation code.
Default value is: //--Implementation----------------------------------------------------------.
locale String - Language to be used for javadoc comments. By default the system's default locale will be used.
messagesEndingMarker String - The string marking the ending line up to where implementation message code should be inserted.
Default value is: //----------------------------------------------------------------Messages--.
messagesStartingMarker String - The string marking the starting line where to start inserting implementation message code.
Default value is: //--Messages----------------------------------------------------------------.
moduleName String - The name of the module to process.
Default value is: ${project.name}.
outputDirectory File - Output directory.
propertiesEndingMarker String - The string marking the ending line up to where implementation property code should be inserted.
Default value is: //--------------------------------------------------------------Properties--.
propertiesStartingMarker String - The string marking the starting line where to start inserting implementation property code.
Default value is: //--Properties--------------------------------------------------------------.
sourceRoot File - Source root to create new source files in.
Default value is: ${basedir}/src/main/java.
spacesPerIndentationLevel Integer - Number of spaces to use per indentation level.
Default value is: 4.
specificationsEndingMarker String - The string marking the ending line up to where specification code should be inserted.
Default value is: //-----------------------------------------------------------Specification--.
specificationsStartingMarker String - The string marking the starting line where to start inserting specification code.
Default value is: //--Specification-----------------------------------------------------------.
targetIde String - Specifies the target editor used for editing sourcefiles. Used for e.g. generating folding markers specific to IDE editors. Currently available options are none and netbeans.
Default value is: netbeans.
testClassPathElementsExcludeRegexp String - A regular expression used for excluding elements from the test classpath elements. By default no elements will be excluded.
testMode Boolean - Flag indicating test mode. In test mode generated sources will be printed to the console and no files will be written.
Default value is: false.
testModuleName String - The name of the test module to process.
Default value is: ${project.name} Tests.

Parameter Details

classPathElementsExcludeRegexp:

A regular expression used for excluding elements from the runtime classpath elements. By default no elements will be excluded.
  • Type: java.lang.String
  • Required: No
  • Expression: ${classPathElementsExcludeRegexp}

constructorsEndingMarker:

The string marking the ending line up to where constructor code should be inserted.
  • Type: java.lang.String
  • Required: No
  • Expression: ${constructorsEndingMarker}
  • Default: //------------------------------------------------------------Constructors--

constructorsStartingMarker:

The string marking the starting line where to start inserting constructor code.
  • Type: java.lang.String
  • Required: No
  • Expression: ${constructorsStartingMarker}
  • Default: //--Constructors------------------------------------------------------------

dependenciesEndingMarker:

The string marking the ending line up to where dependency code should be inserted.
  • Type: java.lang.String
  • Required: No
  • Expression: ${dependenciesEndingMarker}
  • Default: //------------------------------------------------------------Dependencies--

dependenciesStartingMarker:

The string marking the starting line where to start inserting dependency code.
  • Type: java.lang.String
  • Required: No
  • Expression: ${dependenciesStartingMarker}
  • Default: //--Dependencies------------------------------------------------------------

encoding:

The encoding to use for reading and writing sources. By default the system's default encoding will be used.
  • Type: java.lang.String
  • Required: No
  • Expression: ${encoding}
  • Default: ${project.build.sourceEncoding}

implementationsEndingMarker:

The string marking the ending line up to where implementation code should be inserted.
  • Type: java.lang.String
  • Required: No
  • Expression: ${implementationsEndingMarker}
  • Default: //----------------------------------------------------------Implementation--

implementationsStartingMarker:

The string marking the starting line where to start inserting implementation code.
  • Type: java.lang.String
  • Required: No
  • Expression: ${implementationsStartingMarker}
  • Default: //--Implementation----------------------------------------------------------

locale:

Language to be used for javadoc comments. By default the system's default locale will be used.
  • Type: java.lang.String
  • Required: No
  • Expression: ${locale}

messagesEndingMarker:

The string marking the ending line up to where implementation message code should be inserted.
  • Type: java.lang.String
  • Required: No
  • Expression: ${messagesEndingMarker}
  • Default: //----------------------------------------------------------------Messages--

messagesStartingMarker:

The string marking the starting line where to start inserting implementation message code.
  • Type: java.lang.String
  • Required: No
  • Expression: ${messagesStartingMarker}
  • Default: //--Messages----------------------------------------------------------------

moduleName:

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

outputDirectory:

Output directory.
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/container

propertiesEndingMarker:

The string marking the ending line up to where implementation property code should be inserted.
  • Type: java.lang.String
  • Required: No
  • Expression: ${propertiesEndingMarker}
  • Default: //--------------------------------------------------------------Properties--

propertiesStartingMarker:

The string marking the starting line where to start inserting implementation property code.
  • Type: java.lang.String
  • Required: No
  • Expression: ${propertiesStartingMarker}
  • Default: //--Properties--------------------------------------------------------------

sourceRoot:

Source root to create new source files in.
  • Type: java.io.File
  • Required: No
  • Expression: ${sourceRoot}
  • Default: ${basedir}/src/main/java

spacesPerIndentationLevel:

Number of spaces to use per indentation level.
  • Type: java.lang.Integer
  • Required: No
  • Expression: ${spacesPerIndentationLevel}
  • Default: 4

specificationsEndingMarker:

The string marking the ending line up to where specification code should be inserted.
  • Type: java.lang.String
  • Required: No
  • Expression: ${specificationsEndingMarker}
  • Default: //-----------------------------------------------------------Specification--

specificationsStartingMarker:

The string marking the starting line where to start inserting specification code.
  • Type: java.lang.String
  • Required: No
  • Expression: ${specificationsStartingMarker}
  • Default: //--Specification-----------------------------------------------------------

targetIde:

Specifies the target editor used for editing sourcefiles. Used for e.g. generating folding markers specific to IDE editors. Currently available options are none and netbeans.
  • Type: java.lang.String
  • Required: No
  • Expression: ${targetIde}
  • Default: netbeans

testClassPathElementsExcludeRegexp:

A regular expression used for excluding elements from the test classpath elements. By default no elements will be excluded.
  • Type: java.lang.String
  • Required: No
  • Expression: ${testClassPathElementsExcludeRegexp}

testMode:

Flag indicating test mode. In test mode generated sources will be printed to the console and no files will be written.
  • Type: java.lang.Boolean
  • Required: No
  • Expression: ${testMode}
  • Default: false

testModuleName:

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