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

File	appFile() Returns the application resource file of an application project.
File	appupFile() Returns the application upgrade file of an application project.
File	apt() Returns the directory where the maven .apt resources reside.
File	base() Returns the base project directory.
File	changes() Returns the directory where the changes resources reside.
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.
File	ebin() Returns the directory where the application (upgrade) files reside.
String	erlCommand() Returns the erlang command used to start new backend node's.
File	include() Returns the directory where the header files reside.
String	node() Returns the name of the backend node to use.
PackagingType	packagingType() Returns the packaging type of the project artifact.
File	priv() Returns the directory where the private resources reside.
org.apache.maven.project.MavenProject	project() Returns the MavenProject to process.
File	projectArtifactFile() Returns the file packaged as build artifact for a this project.
String	projectName() Returns the name of the projects build artifact.
File	relFile() Returns the release file of a release project.
File	relupFile() Returns the release upgrade file of a release project.
File	site() Returns the directory where the maven site resources reside.
File	src_base() Returns the base folder for sources of this project.
File	src() Returns the directory where the erlang sources reside.
File	sysConfigFile() Returns the system configuration file of a release project.
File	target() Returns the base directory for the build artifacts.
File	targetAppFile() Returns the application resource file of an application project that will be packaged.
File	targetAppupFile() Returns the application upgrade file of an application project that will be packaged.The returned File is not guaranteed to exist.
File	targetEbin() Returns the directory where the compiled sources will be placed into.
File	targetInclude() Returns the directory where includes to package will be put into.
File	targetLib() Returns the directories where dependencies get unpacked into.
File	targetMibs() Returns the directory where SNMP related resources will be put into.
File	targetPriv() Returns the directory where private resources will be put into.
File	targetProject() Returns the base directory for the project packaging.
File	targetReleases() Returns the directoriy where all releases will be put into.
File	targetRelFile() Returns the release file of a release project that will be packaged.
File	targetRelupFile() Returns the release upgrade file of a release project that will be packaged.
File	targetSite() Returns the directory where site documentation will be generated into.
File	targetSrc() Returns the directory where sources to package will be put into.
File	targetSurefireReports() Returns the directory where the surefire reports will be put into.
File	targetSysConfigFile() Returns the system configuration file of a release project that will be packaged.
File	targetTest() Returns the base directory for the tests.
File	targetTestEbin() Returns the directory where the compiled test sources and recompiled sources will be placed into.
File	targetTestPriv() Returns the directory where the main and test resources will be put into (test resources will override main resources).
File	test_include() Returns the directory where the erlang test include files reside.
File	test_priv() Returns the directory where private test resources reside.
File	test_src() Returns the directory where the erlang test source files reside.
String	testNode() Returns the name of the test backend node to use.

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.

projectName

String projectName()

Returns the name of the projects build artifact. Usually this is "artifactId-version".

projectArtifactFile

File projectArtifactFile()

Returns the file packaged as build artifact for a this project.

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.

cookie

String cookie()

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

testNode

String testNode()

Returns the name of the test backend node to use.

apt

File apt()

Returns the directory where the maven .apt resources reside.

base

File base()

Returns the base project directory.

changes

File changes()

Returns the directory where the changes resources reside.

ebin

File ebin()

Returns the directory where the application (upgrade) files reside.

include

File include()

Returns the directory where the header files reside.

priv

File priv()

Returns the directory where the private resources reside.

site

File site()

Returns the directory where the maven site resources reside.

src

File src()

Returns the directory where the erlang sources reside.

src_base

File src_base()

Returns the base folder for sources of this project. This may be used to include sources from other languages into the erlang application.

test_include

File test_include()

Returns the directory where the erlang test include files reside.

test_priv

File test_priv()

Returns the directory where private test resources reside.

test_src

File test_src()

Returns the directory where the erlang test source files reside.

appFile

File appFile()

Returns the application resource file of an application project. The returned File is not guaranteed to exist.

appupFile

File appupFile()

Returns the application upgrade file of an application project. The returned File is not guaranteed to exist.

relFile

File relFile()

Returns the release file of a release project. The returned File is not guaranteed to exist.

relupFile

File relupFile()

Returns the release upgrade file of a release project. The returned File is not guaranteed to exist.

sysConfigFile

File sysConfigFile()

Returns the system configuration file of a release project. The returned File is not guaranteed to exist.

target

File target()

Returns the base directory for the build artifacts.

targetEbin

File targetEbin()

Returns the directory where the compiled sources will be placed into.

targetInclude

File targetInclude()

Returns the directory where includes to package will be put into.

targetLib

File targetLib()

Returns the directories where dependencies get unpacked into.

targetMibs

File targetMibs()

Returns the directory where SNMP related resources will be put into.

targetPriv

File targetPriv()

Returns the directory where private resources will be put into.

targetProject

File targetProject()

Returns the base directory for the project packaging.

targetReleases

File targetReleases()

Returns the directoriy where all releases will be put into.

targetSite

File targetSite()

Returns the directory where site documentation will be generated into.

targetSrc

File targetSrc()

Returns the directory where sources to package will be put into.

targetSurefireReports

File targetSurefireReports()

Returns the directory where the surefire reports will be put into.

targetTest

File targetTest()

Returns the base directory for the tests. This will be accessibly during the test phase by calling code:lib_dir($APPNAME).

targetTestEbin

File targetTestEbin()

Returns the directory where the compiled test sources and recompiled sources will be placed into.

targetTestPriv

File targetTestPriv()

Returns the directory where the main and test resources will be put into (test resources will override main resources). This will be accessibly during the test phase by calling code:lib_dir($APPNAME, priv).

targetAppFile

File targetAppFile()

Returns the application resource file of an application project that will be packaged. The returned File is not guaranteed to exist.

targetAppupFile

File targetAppupFile()

Returns the application upgrade file of an application project that will be packaged.The returned File is not guaranteed to exist.

targetRelFile

File targetRelFile()

Returns the release file of a release project that will be packaged. The returned File is not guaranteed to exist.

targetRelupFile

File targetRelupFile()

Returns the release upgrade file of a release project that will be packaged. The returned File is not guaranteed to exist.

targetSysConfigFile

File targetSysConfigFile()

Returns the system configuration file of a release project that will be packaged. The returned File is not guaranteed to exist.