nl.toolforge.karma.core.manifest
Interface Manifest

All Known Implementing Classes:

AbstractManifest

public interface Manifest

Version:

$Id: Manifest.java,v 1.28 2004/11/10 23:53:09 asmedes Exp $

Author:

D.A. Smedes

Field Summary

static java.lang.String	DEVELOPMENT_MANIFEST
static java.lang.String	HISTORY_KEY
static java.lang.String	RELEASE_MANIFEST

Method Summary

java.util.Map	getAllModules()
java.io.File	getBaseDirectory() The base location of the manifest within the current working context.
java.io.File	getBuildBaseDirectory() The build default child directory of the getBaseDirectory().
java.util.Collection	getIncludes() Returns a collection containing all of a manifests' included manifests.
java.util.Map	getInterdependencies()
Module	getModule(java.lang.String moduleName)
java.io.File	getModuleBaseDirectory() The modules default child directory of the getBaseDirectory().
java.util.Collection	getModuleInterdependencies(Module module)
java.lang.String	getName()
java.io.File	getReportsBaseDirectory() The reports default child directory of the getBaseDirectory().
Module.State	getState(Module module)
java.io.File	getTempDirectory() The base location of a temp directory the manifest within the current working context.
java.lang.String	getType()
java.lang.String	getVersion()
boolean	isLocal(Module module)
void	setState(Module module, Module.State state)

Field Detail

DEVELOPMENT_MANIFEST

public static final java.lang.String DEVELOPMENT_MANIFEST

See Also:

Constant Field Values

RELEASE_MANIFEST

public static final java.lang.String RELEASE_MANIFEST

See Also:

Constant Field Values

HISTORY_KEY

public static final java.lang.String HISTORY_KEY

See Also:

Constant Field Values

Method Detail

getName

public java.lang.String getName()

Returns:

See Also:

for the time being

getVersion

public java.lang.String getVersion()

Returns:

See Also:

for the time being

getAllModules

public java.util.Map getAllModules()

Returns:

See Also:

for the time being

getBaseDirectory

public java.io.File getBaseDirectory()

The base location of the manifest within the current working context. This location is used extensively by Karma as the base directory to checkout projects and build modules.

Returns:

A File reference to the manifest base directory.

getBuildBaseDirectory

public java.io.File getBuildBaseDirectory()

The build default child directory of the getBaseDirectory(). This location stores a manifests' build output.

Returns:

The build default child directory of the getBaseDirectory().

getReportsBaseDirectory

public java.io.File getReportsBaseDirectory()

The reports default child directory of the getBaseDirectory(). This location stores the output of commands that generate reports.

Returns:

The reports default child directory of the getBaseDirectory().

getModuleBaseDirectory

public java.io.File getModuleBaseDirectory()

The modules default child directory of the getBaseDirectory(). This location stores a manifests' modules.

Returns:

The modules default child directory of the getBaseDirectory().

getTempDirectory

public java.io.File getTempDirectory()

The base location of a temp directory the manifest within the current working context. This location is used extensively by Karma as a temporary location and should not be removed for as long as the manifest has a presence on disk.

Returns:

A File reference to the getBaseDirectory() + "/tmp"

setState

public void setState(Module module,
                     Module.State state)

isLocal

public boolean isLocal(Module module)

getState

public Module.State getState(Module module)

getModule

public Module getModule(java.lang.String moduleName)
                 throws ManifestException

Returns:

Throws:

ManifestException

See Also:

for the time being

getModuleInterdependencies

public java.util.Collection getModuleInterdependencies(Module module)
                                                throws ManifestException

Returns:

Throws:

ManifestException

See Also:

for the time being

getInterdependencies

public java.util.Map getInterdependencies()
                                   throws ManifestException

Returns:

Throws:

ManifestException

See Also:

for the time being

getIncludes

public java.util.Collection getIncludes()

Returns a collection containing all of a manifests' included manifests.

Returns:

Collection with Manifest instances.

getType

public java.lang.String getType()