eu.lindenbaum.maven
Interface SourceLayout

All Known Implementing Classes:

ErlangOtpLayout, ErlangRelLayout, ErlangStdLayout

public interface SourceLayout

Represents a bean interface holding the directory layout of a project's source directory (project sources/headers and resources go here).

Since:

2.1.0

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	base() Returns the base project directory.
File	ebin() Returns the directory where the application (upgrade) files reside.
File	include() Returns the directory where header files reside.
File	mibs() Returns the directory where MIB soruces reside.
File	overviewEdoc() Returns the path to the application overview file overview.edoc.
File	priv() Returns the directory where the private resources reside.
File	relFile() Returns the release file of a release project.
File	relupFile() Returns the release upgrade file of a release project.
File	src() Returns the directory where the erlang sources reside.
File	sysConfigFile() Returns the system configuration file of a release project.
File	testInclude() Returns the directory where erlang include files for tests reside.
File	testPriv() Returns the directory where private test resources reside.
Collection<File>	testSrcs() Returns the directory where the erlang test source files reside.

Method Detail

base

File base()

Returns the base project directory.

ebin

File ebin()

Returns the directory where the application (upgrade) 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.

include

File include()

Returns the directory where header files reside.

priv

File priv()

Returns the directory where the private resources reside.

src

File src()

Returns the directory where the erlang sources reside.

mibs

File mibs()

Returns the directory where MIB soruces reside.

Since:

2.2.0

testInclude

File testInclude()

Returns the directory where erlang include files for tests reside.

testPriv

File testPriv()

Returns the directory where private test resources reside.

testSrcs

Collection<File> testSrcs()

Returns the directory where the erlang test source files reside.

overviewEdoc

File overviewEdoc()

Returns the path to the application overview file overview.edoc.

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.