org.apache.avalon.tools.model
Class Gump

java.lang.Object
  org.apache.avalon.tools.model.Gump

public class Gump

extends Object

An immutable data object holding supplimentary information required for the creation fo gump project defintions.

Version:

$Revision: 1.2 $ $Date: 2004/03/17 10:30:09 $

Author:

Avalon Development Team

Field Summary

static Gump

NULL_GUMP

Constructor Summary

Gump(String alias, String id, boolean classpath, boolean ignore)
Creation of a new gump supplementation definition.

Method Summary

String	getAlias() Gump alias name.
String	getId() Gump project jar id.
boolean	isClasspathEntry() Return true if this defintion is required as part of the classpath established by gump.
boolean	isIgnorable() Return true if this defintion can be ignored when building a gump project dependency.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NULL_GUMP

public static final Gump NULL_GUMP

Constructor Detail

Gump

public Gump(String alias,
            String id,
            boolean classpath,
            boolean ignore)

Creation of a new gump supplementation definition.

Parameters:

alias - a name used by gump when referring to a magic key

id - a buuild id used by gump when referencing projects that declare multiple jar file deliverables

classpath - if TRUE then the defintion to which this object is associated will referenced as a gump classpath reference

ignore - if TRUE magic can ignore this project when generating a gump project descriptor

Method Detail

getAlias

public String getAlias()

Gump alias name.

Returns:

the alias name

getId

public String getId()

Gump project jar id.

Returns:

the gump jar id

isIgnorable

public boolean isIgnorable()

Return true if this defintion can be ignored when building a gump project dependency.

Returns:

the ignorable status

isClasspathEntry

public boolean isClasspathEntry()

Return true if this defintion is required as part of the classpath established by gump.

Returns:

TRUE if this is a classpath entry