jsxm:profile | JSXM Maven Plugin

Full name:

org.jsxm.maven.plugin:jsxm-maven-plugin:1.4.11-RC5:profile

Description:

Goal that profiles all the specifications of a project using different implementations of thread pools. The goal can be very CPU and MEMORY intensive depending on the configuration. The current goal is dependent in the executions variable. The goal runs each phase of the JSXM tool with 4 different settings. The phases are validate, compile, generate, transform. The setting are:

newFixedThreadPool with all the available processors, newCachedThreadPool, newSingleThreadExecutor, newFixedThreadPool with one thread.

Executions should be used with caution due to the fact that too many executions in a very intensive specification can cause huge amounts of IO, resulting in huge log files and make your system unresponsive. An acceptable amount of executions is 4 which is the default number.

Attributes:

Requires a Maven project to be executed.
Since version: Version 1.3.
Binds by default to the lifecycle phase: compile.

Required Parameters

Name	Type	Since	Description
ansiSupport	`boolean`	`Version 1.3`	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`.
consoleLoggerLevel	`String`	`Version 1.3`	Sets the console LOGGER level. Default value is: `INFO`.
executions	`int`	`Version 1.3`	Executions should be used with caution due to the fact that too many executions in a very intensive specification can cause huge amounts of IO, resulting in huge log files and make your system unresponsive. Default value is: `4`.
htmlFileLoggerLevel	`String`	`Version 1.3`	Sets the specName.html file logger level. Default value is: `INFO`.
javaDirectory	`File`	`Version 1.3`	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/`.
jsxmSpecRootDir	`String`	`Version 1.3`	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/`.
jsxmSxmBaseImports	`String`	`Version 1.3`	JSXM imports for the SXM_base.java. The default imports are import org.jsxm.jsxmcore.core.;\n import org.jsxm.jsxmcore.exceptions.;\n\n Default value is: `import org.jsxm.jsxmcore.core.; import org.jsxm.jsxmcore.exceptions.;` .
jsxmSxmBaseInheritance	`String`	`Version 1.3`	The type that the SXM_base.java is inheriting. The default value is SXM Default value is: `SXM`.
jsxmSxmImports	`String`	`Version 1.3`	JSXM imports for the SXM.java. The default imports are import org.jsxm.jsxmcore.core.;\n import org.jsxm.jsxmcore.types.;\n Default value is: `import org.jsxm.jsxmcore.core.; import org.jsxm.jsxmcore.types.; import org.jsxm.jsxmcore.exceptions.*;` .
kInput	`String`	`Version 1.3`	Sets the k value that is going to be used in the generation of tests. The default valee is 2. Default value is: `2`.
m2Home	`String`	`Version 1.3`	Sets the maven local repository. By default the value is the default value set by maven . Default value is: `${settings.localRepository}`.
mode	`String`	`Version 1.3`	Sets the mode of the maven project. Verbose and overwrite are the available options. By default the mode is set to overwrite. Default value is: `overwrite`.
nameSpace	`String`	`Version 1.3`	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`.
pdfReportFlag	`boolean`	`Version 1.3`	Boolean for creating a pdf report of the log, system configuration and user settings. Default value is: `true`.
projectName	`String`	`Version 1.3`	The name of the project. Default value is: `${project.name}`.
tempTarget	`String`	`Version 1.3`	Sets the temp directory that temporary files from jsxm are going to be saved. The default value is inside the target directory of a maven project. Default value is: `${project.build.directory}`.
testDirectory	`String`	`Version 1.3`	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/`.
txtFileLoggerLevel	`String`	`Version 1.3`	Sets the specName.txt file logger level. Default value is: `INFO`.

Optional Parameters

Name	Type	Since	Description
kList	`Properties`	`Version 1.3`	List in order to provide different k for each specification. For example if a specification A needs k=2 and specification B k=4 kList must contain, <param></param> The kList is a list of properties that allows the execution of examples with a different k than the default. In case an example contains more than one specification, then there is the possibility to need a different k value for some of the specifications but at the same time not changing the general k value. In order to use this tag the following configuration must be followed. <kList> <property> <name></name> <value></value> </property> </kList> Consider the example Book_Borrower which contains 3 specifications. \The specifications Book, Borrower and Library will use the k value 2 in case none configuration is specified. On the other hand, if you would like to execute the Library specification with a k=4, and Book with k=5 then you should consider the following. <kList> <property> <name&gtLibrary</name> <value&gt4</value>> </property> <property> <name>Book</name> <value&gt5</value> </property> </kList> The above setting will override the default k and will use the specified instead. The Borrower specification will use k=2. The name tag must be identical with the specification name.
threads	`int`	`1.4.10`	Overrides the threads allocated by the application with the number provided. The default number of threads is the logical cores of the CPU.

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.3
Required: Yes
Default: false

consoleLoggerLevel:

Sets the console LOGGER level.

Type: java.lang.String
Since: Version 1.3
Required: Yes
Default: INFO

executions:

Type: int
Since: Version 1.3
Required: Yes
Default: 4

htmlFileLoggerLevel:

Sets the specName.html file logger level.

Type: java.lang.String
Since: Version 1.3
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.io.File
Since: Version 1.3
Required: Yes
Default: ${basedir}/src/main/java/

jsxmSpecRootDir:

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.3
Required: Yes
Default: ${basedir}/src/spec/

jsxmSxmBaseImports:

JSXM imports for the SXM_base.java. The default imports are import org.jsxm.jsxmcore.core.*;\n import org.jsxm.jsxmcore.exceptions.*;\n\n

Type: java.lang.String
Since: Version 1.3
Required: Yes
Default: import org.jsxm.jsxmcore.core.*; import org.jsxm.jsxmcore.exceptions.*;

jsxmSxmBaseInheritance:

The type that the SXM_base.java is inheriting. The default value is SXM

Type: java.lang.String
Since: Version 1.3
Required: Yes
Default: SXM

jsxmSxmImports:

JSXM imports for the SXM.java. The default imports are import org.jsxm.jsxmcore.core.*;\n import org.jsxm.jsxmcore.types.*;\n

Type: java.lang.String
Since: Version 1.3
Required: Yes
Default: import org.jsxm.jsxmcore.core.*; import org.jsxm.jsxmcore.types.*; import org.jsxm.jsxmcore.exceptions.*;

kInput:

Sets the k value that is going to be used in the generation of tests. The default valee is 2.

Type: java.lang.String
Since: Version 1.3
Required: Yes
Default: 2

kList:

List in order to provide different k for each specification. For example if a specification A needs k=2 and specification B k=4 kList must contain, <param></param> The kList is a list of properties that allows the execution of examples with a different k than the default. In case an example contains more than one specification, then there is the possibility to need a different k value for some of the specifications but at the same time not changing the general k value. In order to use this tag the following configuration must be followed. <kList> <property> <name></name> <value></value> </property> </kList> Consider the example Book_Borrower which contains 3 specifications. \The specifications Book, Borrower and Library will use the k value 2 in case none configuration is specified. On the other hand, if you would like to execute the Library specification with a k=4, and Book with k=5 then you should consider the following. <kList> <property> <name&gtLibrary</name> <value&gt4</value>> </property> <property> <name>Book</name> <value&gt5</value> </property> </kList> The above setting will override the default k and will use the specified instead. The Borrower specification will use k=2. The name tag must be identical with the specification name.

Type: java.util.Properties
Since: Version 1.3
Required: No

m2Home:

Sets the maven local repository. By default the value is the default value set by maven .

Type: java.lang.String
Since: Version 1.3
Required: Yes
Default: ${settings.localRepository}

mode:

Sets the mode of the maven project. Verbose and overwrite are the available options. By default the mode is set to overwrite.

Type: java.lang.String
Since: Version 1.3
Required: Yes
Default: overwrite

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.3
Required: Yes
Default: http://www.jsxm.org/schema

pdfReportFlag:

Boolean for creating a pdf report of the log, system configuration and user settings.

Type: boolean
Since: Version 1.3
Required: Yes
Default: true

projectName:

The name of the project.

Type: java.lang.String
Since: Version 1.3
Required: Yes
Default: ${project.name}

tempTarget:

Sets the temp directory that temporary files from jsxm are going to be saved. The default value is inside the target directory of a maven project.

Type: java.lang.String
Since: Version 1.3
Required: Yes
Default: ${project.build.directory}

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.3
Required: Yes
Default: ${basedir}/src/test/java/

threads:

Overrides the threads allocated by the application with the number provided. The default number of threads is the logical cores of the CPU.

Type: int
Since: 1.4.10
Required: No

txtFileLoggerLevel:

Sets the specName.txt file logger level.

Type: java.lang.String
Since: Version 1.3
Required: Yes
Default: INFO