JSXM Maven plugin Maven Plugin
  • JSXM
  • /
  • jsxm:create-sample

jsxm:create-sample

Full name:

org.jsxm.maven.plugin:jsxm-maven-plugin:1.4.11-RC5:create-sample

Description:

Goal that creates the spec directory, the additional directories needed for each specification and the template file of [specName].xml and [specName]_sets.xml. The template includes implementation and adapters for the implementation.

Attributes:

  • Requires a Maven project to be executed.
  • Since version: Version 1.0.
  • Binds by default to the lifecycle phase: generate-resources.

Required Parameters

Name Type Since Description
ansiSupport boolean Version 1.0 By setting ansiSupport to true the application is using ansi output which produces colorful messages in the console. This does not affect the output files.
Default value is: false.
banimationThreadPool String 1.4.7 Sets the executor for banimation phase Current options are: cachedThreadPool fixedThreadPool singleFixedThreadPool singleThreadExecutor
Default value is: fixedThreadPool.
compilationThreadPool String 1.4.7 Sets the executor for compilation phase Current options are: cachedThreadPool fixedThreadPool singleFixedThreadPool singleThreadExecutor
Default value is: fixedThreadPool.
consoleLoggerLevel String Version 1.0 Sets the console LOGGER level.
Default value is: INFO.
externalPackageCreationThreadPool String 1.4.7 Sets the executor for external package creation phase Current options are: cachedThreadPool fixedThreadPool singleFixedThreadPool singleThreadExecutor
Default value is: fixedThreadPool.
generationThreadPool String 1.4.7 Sets the executor for generation phase Current options are: cachedThreadPool fixedThreadPool singleFixedThreadPool singleThreadExecutor
Default value is: fixedThreadPool.
htmlFileLoggerLevel String Version 1.0 Sets the specName.html file logger level.
Default value is: INFO.
javaDirectory String Version 1.0 Sets the implementation directory of the maven project. The default value is the src/main/java of the maven project.
Default value is: ${basedir}/src/main/java/.
jsxmList List Version 1.0 The above list is used for entering the names that are going to be used in the creation of the folders, subfolders, specification.xml and sets.xml. There is no default value for the above parameter. The parameter is working as a list and every new name should be given through a new parameter. For example, if you want to create 3 specifications with names Test1, Test2, Test3 you should enter inside the jsxmList tag the tags below. <param>Test1</param> <param>Test2</param> <param>Test3</param> The above 3 tags will create 3 folders Test1, Test2, and Test3 under the spec directory with all the necessary subfolders needed by the maven-jsxm-plug in(specification, testAdapters and animation). Finally, the there will be created Test1.xml and Test1_sets.xml, Test2.xml and Test2_sets.xml, Test3.xml and Test3_sets.xml templates containing sample data. There is not limit in number of parameters. The above tag should contain at least one parameter in order to compile successfully. *Note: There is the possibility to create subfolders and folders inside the subfolders. For example in order to create 2 folders Test1 and Test2 inside a Tests folder, the following params should be used <param>Tests/Test1</param> <param>Tests/Test2</param>
jsxmRootDir String Version 1.0 Sets the directory for all the jsxm specifications. The default value is the spec directory under src-->src/spec.
Default value is: ${basedir}/src/spec/.
nameSpace String Version 1.0 Sets the namespace used by the jsxm core and by maven-jsxm-plug in. The default namespace is http://www.jsxm.org/schema. The namespace must be the same as the namespaces used in the xsd schemas (specification, sets, definitions). The above namespace is used for the validation, creation and all the necessary operations needed regarding the xml files.
Default value is: http://www.jsxm.org/schema.
sampleCreationThreadPool String 1.4.7 Sets the executor for sample creation phase Current options are: cachedThreadPool fixedThreadPool singleFixedThreadPool singleThreadExecutor
Default value is: fixedThreadPool.
testDirectory String Version 1.0 Sets the test directory of the maven project. The default value is the src/test/java of the maven project.
Default value is: ${basedir}/src/test/java/.
transformationThreadPool String 1.4.7 Sets the executor for tranformation phase Current options are: cachedThreadPool fixedThreadPool singleFixedThreadPool singleThreadExecutor
Default value is: fixedThreadPool.
txtFileLoggerLevel String Version 1.0 Sets the specName.txt file logger level.
Default value is: INFO.
validationThreadPool String 1.4.7 Sets the executor for validation phase Current options are: cachedThreadPool fixedThreadPool singleFixedThreadPool singleThreadExecutor
Default value is: singleFixedThreadPool.

Parameter Details

ansiSupport:

By setting ansiSupport to true the application is using ansi output which produces colorful messages in the console. This does not affect the output files.
  • Type: boolean
  • Since: Version 1.0
  • Required: Yes
  • Default: false

banimationThreadPool:

Sets the executor for banimation phase Current options are: cachedThreadPool fixedThreadPool singleFixedThreadPool singleThreadExecutor
  • Type: java.lang.String
  • Since: 1.4.7
  • Required: Yes
  • Default: fixedThreadPool

compilationThreadPool:

Sets the executor for compilation phase Current options are: cachedThreadPool fixedThreadPool singleFixedThreadPool singleThreadExecutor
  • Type: java.lang.String
  • Since: 1.4.7
  • Required: Yes
  • Default: fixedThreadPool

consoleLoggerLevel:

Sets the console LOGGER level.
  • Type: java.lang.String
  • Since: Version 1.0
  • Required: Yes
  • Default: INFO

externalPackageCreationThreadPool:

Sets the executor for external package creation phase Current options are: cachedThreadPool fixedThreadPool singleFixedThreadPool singleThreadExecutor
  • Type: java.lang.String
  • Since: 1.4.7
  • Required: Yes
  • Default: fixedThreadPool

generationThreadPool:

Sets the executor for generation phase Current options are: cachedThreadPool fixedThreadPool singleFixedThreadPool singleThreadExecutor
  • Type: java.lang.String
  • Since: 1.4.7
  • Required: Yes
  • Default: fixedThreadPool

htmlFileLoggerLevel:

Sets the specName.html file logger level.
  • Type: java.lang.String
  • Since: Version 1.0
  • Required: Yes
  • Default: INFO

javaDirectory:

Sets the implementation directory of the maven project. The default value is the src/main/java of the maven project.
  • Type: java.lang.String
  • Since: Version 1.0
  • Required: Yes
  • Default: ${basedir}/src/main/java/

jsxmList:

The above list is used for entering the names that are going to be used in the creation of the folders, subfolders, specification.xml and sets.xml. There is no default value for the above parameter. The parameter is working as a list and every new name should be given through a new parameter. For example, if you want to create 3 specifications with names Test1, Test2, Test3 you should enter inside the jsxmList tag the tags below. <param>Test1</param> <param>Test2</param> <param>Test3</param> The above 3 tags will create 3 folders Test1, Test2, and Test3 under the spec directory with all the necessary subfolders needed by the maven-jsxm-plug in(specification, testAdapters and animation). Finally, the there will be created Test1.xml and Test1_sets.xml, Test2.xml and Test2_sets.xml, Test3.xml and Test3_sets.xml templates containing sample data. There is not limit in number of parameters. The above tag should contain at least one parameter in order to compile successfully. *Note: There is the possibility to create subfolders and folders inside the subfolders. For example in order to create 2 folders Test1 and Test2 inside a Tests folder, the following params should be used <param>Tests/Test1</param> <param>Tests/Test2</param>
  • Type: java.util.List
  • Since: Version 1.0
  • Required: Yes

jsxmRootDir:

Sets the directory for all the jsxm specifications. The default value is the spec directory under src-->src/spec.
  • Type: java.lang.String
  • Since: Version 1.0
  • Required: Yes
  • Default: ${basedir}/src/spec/

nameSpace:

Sets the namespace used by the jsxm core and by maven-jsxm-plug in. The default namespace is http://www.jsxm.org/schema. The namespace must be the same as the namespaces used in the xsd schemas (specification, sets, definitions). The above namespace is used for the validation, creation and all the necessary operations needed regarding the xml files.
  • Type: java.lang.String
  • Since: Version 1.0
  • Required: Yes
  • Default: http://www.jsxm.org/schema

sampleCreationThreadPool:

Sets the executor for sample creation phase Current options are: cachedThreadPool fixedThreadPool singleFixedThreadPool singleThreadExecutor
  • Type: java.lang.String
  • Since: 1.4.7
  • Required: Yes
  • Default: fixedThreadPool

testDirectory:

Sets the test directory of the maven project. The default value is the src/test/java of the maven project.
  • Type: java.lang.String
  • Since: Version 1.0
  • Required: Yes
  • Default: ${basedir}/src/test/java/

transformationThreadPool:

Sets the executor for tranformation phase Current options are: cachedThreadPool fixedThreadPool singleFixedThreadPool singleThreadExecutor
  • Type: java.lang.String
  • Since: 1.4.7
  • Required: Yes
  • Default: fixedThreadPool

txtFileLoggerLevel:

Sets the specName.txt file logger level.
  • Type: java.lang.String
  • Since: Version 1.0
  • Required: Yes
  • Default: INFO

validationThreadPool:

Sets the executor for validation phase Current options are: cachedThreadPool fixedThreadPool singleFixedThreadPool singleThreadExecutor
  • Type: java.lang.String
  • Since: 1.4.7
  • Required: Yes
  • Default: singleFixedThreadPool

Back to top

Copyright ©2012-2017 JSXM. All Rights Reserved.

Version: 1.4.11-RC5. Last Published: 2017-11-30.