rules-compiler:compile

Full name:

net.sourceforge.rules:rules-compiler-plugin:1.0-SNAPSHOT:compile

Description:

Compiles application rules.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Binds by default to the lifecycle phase: compile.

Required Parameters

Name Type Since Description
sourceDirectory File - Specifies the directory containing rules files.

Optional Parameters

Name Type Since Description
compilerArgument String - Sets the unformatted argument string to be passed to the rules compiler if fork is set to true.

This is because the list of valid arguments passed to a rules compiler varies based on the concrete rules compiler and rules compiler version.
compilerArguments Map - Sets the arguments to be passed to the rules compiler (prepending a dash) if fork is set to true.

This is because the list of valid arguments passed to a rules compiler varies based on the concrete rules compiler and rules compiler version.
debug boolean - Set to true to include debugging information in the compiled rules files. The default value is true.
Default value is: true.
debugRulesCompiler boolean - Set to true to start the rules compiler in debugging mode if fork is set to true too.
Default value is: false.
encoding String - The encoding argument for the rules compiler.
Default value is: ${project.build.sourceEncoding}.
excludes Set - A list of exclusion filters for the rules compiler.
executable String - Sets the executable of the rules compiler to use when fork is true.
failOnError boolean - Indicates whether the build will continue even if there are rules compilation errors; defaults to true.
Default value is: true.
fork boolean - Allows running the rules compiler in a separate process. If "false" it uses the built in rules compiler, while if "true" it will use an executable.
Default value is: false.
includes Set - A list of inclusion filters for the rules compiler.
maxmem String - Sets the maximum size, in megabytes, of the memory allocation pool, ex. "128", "128m" if fork is set to true.
meminitial String - Initial size, in megabytes, of the memory allocation pool, ex. "64", "64m" if fork is set to true.
optimize boolean - Set to true to optimize the compiled rules using the rules compiler's optimization methods.
Default value is: false.
outputFileName String - Sets the name of the output file when compiling a set of rules to a single file.
rulesCompilerId String - The id of the rules compiler to be used.
rulesCompilerVersion String - Version of the rules compiler to use.
showDeprecation boolean - Sets whether to show source locations where deprecated APIs are used.
Default value is: false.
showWarnings boolean - Set to true to show rules compilation warnings.
Default value is: false.
source String - The source argument for the rules compiler.
staleMillis int - Sets the granularity in milliseconds of the last modification date for testing whether a source needs recompilation.
Default value is: 0.
target String - The target argument for the rules compiler.
verbose boolean - Set to true to show messages about what the rules compiler is doing.
Default value is: false.

Parameter Details

compilerArgument:

Sets the unformatted argument string to be passed to the rules compiler if fork is set to true.

This is because the list of valid arguments passed to a rules compiler varies based on the concrete rules compiler and rules compiler version.

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

compilerArguments:

Sets the arguments to be passed to the rules compiler (prepending a dash) if fork is set to true.

This is because the list of valid arguments passed to a rules compiler varies based on the concrete rules compiler and rules compiler version.

  • Type: java.util.Map
  • Required: No

debug:

Set to true to include debugging information in the compiled rules files. The default value is true.
  • Type: boolean
  • Required: No
  • Expression: ${maven.rules-compiler.debug}
  • Default: true

debugRulesCompiler:

Set to true to start the rules compiler in debugging mode if fork is set to true too.
  • Type: boolean
  • Required: No
  • Expression: ${maven.rules-compiler.debugRulesCompiler}
  • Default: false

encoding:

The encoding argument for the rules compiler.
  • Type: java.lang.String
  • Required: No
  • Expression: ${encoding}
  • Default: ${project.build.sourceEncoding}

excludes:

A list of exclusion filters for the rules compiler.
  • Type: java.util.Set
  • Required: No

executable:

Sets the executable of the rules compiler to use when fork is true.
  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.rules-compiler.executable}

failOnError:

Indicates whether the build will continue even if there are rules compilation errors; defaults to true.
  • Type: boolean
  • Required: No
  • Expression: ${maven.rules-compiler.failOnError}
  • Default: true

fork:

Allows running the rules compiler in a separate process. If "false" it uses the built in rules compiler, while if "true" it will use an executable.
  • Type: boolean
  • Required: No
  • Expression: ${maven.rules-compiler.fork}
  • Default: false

includes:

A list of inclusion filters for the rules compiler.
  • Type: java.util.Set
  • Required: No

maxmem:

Sets the maximum size, in megabytes, of the memory allocation pool, ex. "128", "128m" if fork is set to true.
  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.rules-compiler.maxmem}

meminitial:

Initial size, in megabytes, of the memory allocation pool, ex. "64", "64m" if fork is set to true.
  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.rules-compiler.meminitial}

optimize:

Set to true to optimize the compiled rules using the rules compiler's optimization methods.
  • Type: boolean
  • Required: No
  • Expression: ${maven.rules-compiler.optimize}
  • Default: false

outputFileName:

Sets the name of the output file when compiling a set of rules to a single file.
  • Type: java.lang.String
  • Required: No
  • Expression: ${project.build.finalName}

rulesCompilerId:

The id of the rules compiler to be used.
  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.rules-compiler.rulesCompilerId}

rulesCompilerVersion:

Version of the rules compiler to use.
  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.rules-compiler.rulesCompilerVersion}

showDeprecation:

Sets whether to show source locations where deprecated APIs are used.
  • Type: boolean
  • Required: No
  • Expression: ${maven.rules-compiler.showDeprecation}
  • Default: false

showWarnings:

Set to true to show rules compilation warnings.
  • Type: boolean
  • Required: No
  • Expression: ${maven.rules-compiler.showWarnings}
  • Default: false

source:

The source argument for the rules compiler.
  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.rules-compiler.source}

sourceDirectory:

Specifies the directory containing rules files.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${basedir}/src/main/rules

staleMillis:

Sets the granularity in milliseconds of the last modification date for testing whether a source needs recompilation.
  • Type: int
  • Required: No
  • Expression: ${lastModGranularityMs}
  • Default: 0

target:

The target argument for the rules compiler.
  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.rules-compiler.target}

verbose:

Set to true to show messages about what the rules compiler is doing.
  • Type: boolean
  • Required: No
  • Expression: ${maven.rules-compiler.verbose}
  • Default: false