classpath:classpath

Full name:

org.hedgecode.maven.plugins:classpath-maven-plugin:1.0:classpath

Description:

Generates a set of library artifacts based on the input search parameters and overwrites project dependencies for further compilation.

Attributes:

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

Required Parameters

Name Type Since Description
assignProjectClasspath boolean - Overwrites dependencies of your project if true by adding the found libraries.
Default value is: true.
User property is: assignProjectClasspath.
errorIsEmptyPath boolean - If true it will stop further plugin execution in the absence of found libraries for a single input configuration parameter path or each path from paths, otherwise (false, by default) will continue plugin execution.
Default value is: false.
User property is: errorIsEmptyPath.
isMask boolean - Specifies that input parameter path or each path from paths is a specific library (false) or a mask for library search (true).
Default value is: true.
User property is: isMask.
overlapDependencyMatch boolean 0.2 If true it will rewrite dependencies with the found libraries in the case of matching artifacts, otherwise (by default) matched dependency libraries remain unchanged.
Default value is: false.
User property is: overlapDependencyMatch.
pathSeparator String - Path separator for the current Operation System.
This is used to generate classpath string of outputProperty.
Default value is: ${path.separator}.
User property is: pathSeparator.
withSubDir boolean - If true it will search libraries starting from the directory contained in path or each path from paths and including all its subdirectories.
This is used only together with the input paramater isMask = true.
Default value is: false.
User property is: withSubDir.

Optional Parameters

Name Type Since Description
outputFile File - Saves the resulting classpath with the found libraries to the specified file if the parameter is not null.
User property is: outputFile.
outputProperty String - Writes the resulting classpath with the found libraries to the specified project variable if the parameter is not null.
User property is: outputProperty.
path String - Specifies a library name or a mask for library search.
It can be specified as an absolute path, and with a relative.
User property is: path.
paths String[] - Set of input parameters path for definition of several specific libraries or multiple masks for library search.
Example:
<paths>
  <path>foo.jar</path>
  <path>bar.jar</path>
</paths>

User property is: paths.

Parameter Details

assignProjectClasspath:

Overwrites dependencies of your project if true by adding the found libraries.
  • Type: boolean
  • Required: Yes
  • User Property: assignProjectClasspath
  • Default: true

errorIsEmptyPath:

If true it will stop further plugin execution in the absence of found libraries for a single input configuration parameter path or each path from paths, otherwise (false, by default) will continue plugin execution.
  • Type: boolean
  • Required: Yes
  • User Property: errorIsEmptyPath
  • Default: false

isMask:

Specifies that input parameter path or each path from paths is a specific library (false) or a mask for library search (true).
  • Type: boolean
  • Required: Yes
  • User Property: isMask
  • Default: true

outputFile:

Saves the resulting classpath with the found libraries to the specified file if the parameter is not null.
  • Type: java.io.File
  • Required: No
  • User Property: outputFile

outputProperty:

Writes the resulting classpath with the found libraries to the specified project variable if the parameter is not null.
  • Type: java.lang.String
  • Required: No
  • User Property: outputProperty

overlapDependencyMatch:

If true it will rewrite dependencies with the found libraries in the case of matching artifacts, otherwise (by default) matched dependency libraries remain unchanged.
  • Type: boolean
  • Since: 0.2
  • Required: Yes
  • User Property: overlapDependencyMatch
  • Default: false

path:

Specifies a library name or a mask for library search.
It can be specified as an absolute path, and with a relative.
  • Type: java.lang.String
  • Required: No
  • User Property: path

pathSeparator:

Path separator for the current Operation System.
This is used to generate classpath string of outputProperty.
  • Type: java.lang.String
  • Required: Yes
  • User Property: pathSeparator
  • Default: ${path.separator}

paths:

Set of input parameters path for definition of several specific libraries or multiple masks for library search.
Example:
<paths>
  <path>foo.jar</path>
  <path>bar.jar</path>
</paths>
  • Type: java.lang.String[]
  • Required: No
  • User Property: paths

withSubDir:

If true it will search libraries starting from the directory contained in path or each path from paths and including all its subdirectories.
This is used only together with the input paramater isMask = true.
  • Type: boolean
  • Required: Yes
  • User Property: withSubDir
  • Default: false