DefaultTargetLayout (Maven Erlang Plug-In 2.2.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

eu.lindenbaum.maven
Class DefaultTargetLayout

java.lang.Object
  eu.lindenbaum.maven.DefaultTargetLayout

All Implemented Interfaces:: TargetLayout

public class DefaultTargetLayout
extends Object
implements TargetLayout
extends Object
implements TargetLayout

Implementation of the TargetLayout bean defining the project's build directory layout.

Since:: 2.1.0
Author:: Tobias Schlager

Constructor Summary
`DefaultTargetLayout(org.apache.maven.project.MavenProject project)` Defines the layout of the target directory relevant for maven-erlang projects.

Method Summary
`File`	`appFile()` Returns the application resource file of an application project that will be packaged.
`File`	`appupFile()` Returns the application upgrade file of an application project that will be packaged.The returned `File` is not guaranteed to exist.
`File`	`backendLog()` Returns a `File` used to write the output generated from the plugin's backend nodes to.
`File`	`base()` Returns the base directory for the build artifacts.
`File`	`coverageReports()` Returns the directory where coverage reports will be put.
`File`	`dialyzerOk()` Returns a `File` used by the dialyzer to indicate whether the last dialyzer run was ok (no warnings/errors).
`File`	`ebin()` Returns the directory where the compiled sources will be placed into.
`File`	`include()` Returns the directory where includes to package will be put into.
`File`	`lib()` Returns the directory where dependencies get unpacked into.
`File`	`overviewEdoc()` Returns the path to the application overview file `overview.edoc`.
`File`	`priv()` Returns the directory where private resources will be put into.
`File`	`profilingReports()` Returns the directory where profiling reports will be put.
`File`	`project()` Returns the base directory for the project packaging.
`File`	`projectArtifact()` Returns the `File` representing the main build artifact of the project.
`File`	`relFile()` Returns the release file of a release project that will be packaged.
`File`	`relupFile()` Returns the release upgrade file of a release project that will be packaged.
`File`	`src()` Returns the directory where sources to package will be put into.
`File`	`surefireReports()` Returns the directory where surefire test reports will be put.
`File`	`sysConfigFile()` Returns the system configuration file of a release project that will be packaged.
`File`	`test()` Returns the base directory for the tests.
`File`	`testEbin()` Returns the directory where the compiled test sources and recompiled sources will be placed into.
`File`	`testInclude()` Returns the directory where the include for test compilation will be placed into.
`File`	`testPriv()` Returns the directory where the main and test resources will be put into (test resources will override main resources).

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

DefaultTargetLayout

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

Defines the layout of the target directory relevant for maven-erlang projects. Standard layout is:

 target
   +-- [ARTIFACTID]-[Version]
   +-- [ARTIFACTID]-[Version]/ebin (*.beam, [ARTIFACTID].app, [ARTIFACTID].appup)
   +-- [ARTIFACTID]-[Version]/include (*.hrl)
   +-- [ARTIFACTID]-[Version]/priv (*)
   +-- [ARTIFACTID]-[Version]/src (*.erl)
   +-- [ARTIFACTID]-[Version]-test
   +-- [ARTIFACTID]-[Version]-test/ebin (*.beam)
   +-- [ARTIFACTID]-[Version]-test/include (*.hrl)
   +-- [ARTIFACTID]-[Version]-test/priv (*)
   +-- surefire-reports (*.html)
   +-- profiling-reports (*.html)
   +-- relup
   +-- sys.config
   +-- [ARTIFACTID].rel
   +-- .dialyzer.ok
   +-- backend.log

Parameters:: project - The project to build the target layout for.

Method Detail