Built by Maven

wurbelizer:wurbel

Full name:

org.wurbelizer:wurbelizer-maven-plugin:21.6.2.0:wurbel

Description:

Wurbel sources.
Scans the sources for @wurblet anchors and executes the wurblets. The generated code from the wurblets is merged into the sources.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile+runtime.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Binds by default to the lifecycle phase: process-sources.

Required Parameters

Name Type Since Description
<analyzeDir> File - Directory for additional files generated by preceeding phases provided for wurblets.
Default: ${project.build.directory}/analyze
User Property: wurbel.analyzeDir
<sourceDir> File - Directory holding the sources to be wurbelized.
Defaults to all java sources of the current project. If this is not desired, filesets must be used.
Default: ${project.build.sourceDirectory}
User Property: wurbel.sourceDir
<wurbelDir> File - Target directory for all files referenced by wurblets.
Default: ${project.build.directory}/wurbel
User Property: wurbel.wurbelDir
<wurbletPaths> List<String> - Classpaths for loading wurblets.
Used for all non-fully-qualified wurblet anchors.

Optional Parameters

Name Type Since Description
<charset> String - The charset used to read and write files.
Default: ${project.build.sourceEncoding}
<dryRun> boolean - Dry run.
Don't run any wurblets, just parse the files.
<excludeAnchors> List<String> - Optional list of regular expressions describing the guarded names used in the wurblet anchors to exclude.
Same as includeAnchors, but those wurblet anchors will not be processed.
<excludeWurblets> List<String> - Optional list of regular expressions describing the wurblet names used in the wurblet anchors to exclude.
Same as includeWurblets, but those wurblets will not be processed.
<filesets> List<FileSet> - The list of file sets to wurbile.
If set the source directory is ignored.
<includeAnchors> List<String> - Optional list of regular expressions describing the guarded names used in the wurblet anchors.
If given, only those wurblet anchors will be processed.
<includeWurblets> List<String> - Optional list of regular expressions describing the wurblet names used in the wurblet anchors.
If given, only those wurblets will be processed.
<skip> Boolean - Skips processing.
Defaults to true if packaging is "pom".
<verbosity> String - The verbosity.
One of "default", "info" or "debug". Debus is also turned on (if not set explicitly) by Maven's global debug flag (see command line switch -X).
Default: ${wurbel.verbosity}
<wurbletDependencies> List<WurbletDependency> - Classpaths for loading wurblets.
Used for all non-fully-qualified wurblet anchors.
<wurbletProperties> Properties - Properties used by wurblets.
Properties referring to directories or files should prepend ${wurbelDir} in their path. This is a predefined property pointing to fileDir.

Parameter Details

<analyzeDir>

Directory for additional files generated by preceeding phases provided for wurblets.
  • Type: java.io.File
  • Required: Yes
  • User Property: wurbel.analyzeDir
  • Default: ${project.build.directory}/analyze

<charset>

The charset used to read and write files.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.sourceEncoding}

<dryRun>

Dry run.
Don't run any wurblets, just parse the files.
  • Type: boolean
  • Required: No

<excludeAnchors>

Optional list of regular expressions describing the guarded names used in the wurblet anchors to exclude.
Same as includeAnchors, but those wurblet anchors will not be processed.
  • Type: java.util.List<java.lang.String>
  • Required: No

<excludeWurblets>

Optional list of regular expressions describing the wurblet names used in the wurblet anchors to exclude.
Same as includeWurblets, but those wurblets will not be processed.
  • Type: java.util.List<java.lang.String>
  • Required: No

<filesets>

The list of file sets to wurbile.
If set the source directory is ignored.
  • Type: java.util.List<org.apache.maven.shared.model.fileset.FileSet>
  • Required: No

<includeAnchors>

Optional list of regular expressions describing the guarded names used in the wurblet anchors.
If given, only those wurblet anchors will be processed.
  • Type: java.util.List<java.lang.String>
  • Required: No

<includeWurblets>

Optional list of regular expressions describing the wurblet names used in the wurblet anchors.
If given, only those wurblets will be processed.
  • Type: java.util.List<java.lang.String>
  • Required: No

<skip>

Skips processing.
Defaults to true if packaging is "pom".
  • Type: java.lang.Boolean
  • Required: No

<sourceDir>

Directory holding the sources to be wurbelized.
Defaults to all java sources of the current project. If this is not desired, filesets must be used.
  • Type: java.io.File
  • Required: Yes
  • User Property: wurbel.sourceDir
  • Default: ${project.build.sourceDirectory}

<verbosity>

The verbosity.
One of "default", "info" or "debug". Debus is also turned on (if not set explicitly) by Maven's global debug flag (see command line switch -X).
  • Type: java.lang.String
  • Required: No
  • Default: ${wurbel.verbosity}

<wurbelDir>

Target directory for all files referenced by wurblets.
  • Type: java.io.File
  • Required: Yes
  • User Property: wurbel.wurbelDir
  • Default: ${project.build.directory}/wurbel

<wurbletDependencies>

Classpaths for loading wurblets.
Used for all non-fully-qualified wurblet anchors.
  • Type: java.util.List<org.wurbelizer.maven.WurbletDependency>
  • Required: No

<wurbletPaths>

Classpaths for loading wurblets.
Used for all non-fully-qualified wurblet anchors.
  • Type: java.util.List<java.lang.String>
  • Required: Yes

<wurbletProperties>

Properties used by wurblets.
Properties referring to directories or files should prepend ${wurbelDir} in their path. This is a predefined property pointing to fileDir.
  • Type: java.util.Properties
  • Required: No