eu.lindenbaum.maven
Interface Properties

public interface Properties

Represents a bean interface holding all values the plugin needs to work.

Author:

Tobias Schlager

Method Summary

List<File>	applicationFiles(boolean withDependencies) Returns a list containing the projects application resource file.
List<File>	codePaths(boolean withTestCodePaths) Gathers a complete List of directories used as code paths in a project's build process.
MavenComponents	components() Returns the MavenComponents that are available to the plugin.
String	cookie() Returns the cookie that must be used when connecting to the backend node.
List<File>	dependencyModules(boolean withTestScopeDependencies) Returns a list of containing the compiled modules from the project's maven dependencies.
String	erlCommand() Returns the erlang command used to start new backend node's.
List<File>	includePaths(boolean withTestIncludePaths) Gathers a complete List of directories used as include directories in a standard build process.
List<File>	modules(boolean withTests, boolean withDependencies) Returns a list of the project's compiled modules.
String	node() Returns the name of the backend node to use.
PackagingType	packagingType() Returns the packaging type of the project artifact.
org.apache.maven.project.MavenProject	project() Returns the MavenProject to process.
List<File>	resources(boolean withTests, boolean withDependencies) Returns a list of the project's private resource files.
SourceLayout	sourceLayout() Returns the SourceLayout defining this project's source directory structure.
TargetLayout	targetLayout() Returns the TargetLayout defining this project's build directory structure.
String	testNode() Returns the name of the test backend node to use.
List<File>	testSupportArtifacts() Returns a list of artifacts used by the plugin to provide a proper test phase, e.g.
List<File>	testSupportScripts() Returns a list of script files used by the plugin to provide a proper test phase, e.g.

Method Detail

project

org.apache.maven.project.MavenProject project()

Returns the MavenProject to process.

components

MavenComponents components()

Returns the MavenComponents that are available to the plugin.

packagingType

PackagingType packagingType()

Returns the packaging type of the project artifact.

erlCommand

String erlCommand()

Returns the erlang command used to start new backend node's. This may be an absolute or relative path as well as a simple command (assuming the host environment is set up properly). The path must not contain any arguments.

node

String node()

Returns the name of the backend node to use.

testNode

String testNode()

Returns the name of the test backend node to use.

cookie

String cookie()

Returns the cookie that must be used when connecting to the backend node.

sourceLayout

SourceLayout sourceLayout()

Returns the SourceLayout defining this project's source directory structure.

targetLayout

TargetLayout targetLayout()

Returns the TargetLayout defining this project's build directory structure.

codePaths

List<File> codePaths(boolean withTestCodePaths)

Gathers a complete List of directories used as code paths in a project's build process.

Parameters:

withTestCodePaths - will also return the code paths needed for test execution

includePaths

List<File> includePaths(boolean withTestIncludePaths)

Gathers a complete List of directories used as include directories in a standard build process.

Parameters:

withTestIncludePaths - will also return the include paths needed to compile test sources

testSupportScripts

List<File> testSupportScripts()

Returns a list of script files used by the plugin to provide a proper test phase, e.g. erlang scripts for surefire reports.

testSupportArtifacts

List<File> testSupportArtifacts()

Returns a list of artifacts used by the plugin to provide a proper test phase, e.g. the compiled artifacts of testSupportScripts().

modules

List<File> modules(boolean withTests,
                   boolean withDependencies)

Returns a list of the project's compiled modules.

Parameters:

withTests - includes test modules into the returned list

withDependencies - includes modules from the project's maven dependencies (will also include test scope dependencies if withTestModules is set to true

dependencyModules

List<File> dependencyModules(boolean withTestScopeDependencies)

Returns a list of containing the compiled modules from the project's maven dependencies.

Parameters:

withTestScopeDependencies - includes modules from the project's maven test scope dependencies

applicationFiles

List<File> applicationFiles(boolean withDependencies)

Returns a list containing the projects application resource file. optionally the application resource files from the project's maven dependencies are also included.

Parameters:

withDependencies - includes application resource files from the project's maven dependencies

resources

List<File> resources(boolean withTests,
                     boolean withDependencies)

Returns a list of the project's private resource files.

Parameters:

withTests - includes test resources into the returned list

withDependencies - includes private resources from the project's maven dependencies (will also include test scope dependency resources if withTestModules is set to true