Class Configuration

java.lang.Object

org.apache.ivy.util.extendable.UnmodifiableExtendableItem

org.apache.ivy.util.extendable.DefaultExtendableItem

org.apache.ivy.core.module.descriptor.Configuration

All Implemented Interfaces:

InheritableItem, ExtendableItem

Direct Known Subclasses:

ConfigurationGroup, ConfigurationIntersection

public class Configuration
extends DefaultExtendableItem
implements InheritableItem

Represents a module configuration

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Configuration.Visibility

Constructor Summary

Constructors

Constructor	Description
Configuration(String name)	Creates a new configuration.
Configuration(String name, Configuration.Visibility visibility, String description, String[] ext, boolean transitive, String deprecated)	Creates a new configuration.
Configuration(Configuration source, ModuleRevisionId sourceModule)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static Collection<Configuration>	findConfigurationExtending(String conf, Configuration[] confs)
String	getDeprecated()	Returns the deprecation message, or null if not specified.
String	getDescription()
String[]	getExtends()
String	getName()
ModuleRevisionId	getSourceModule()
Configuration.Visibility	getVisibility()
int	hashCode()
final boolean	isTransitive()
void	replaceWildcards(ModuleDescriptor md)
String	toString()

Methods inherited from class DefaultExtendableItem

setExtraAttribute

Methods inherited from class UnmodifiableExtendableItem

getAttribute, getAttributes, getExtraAttribute, getExtraAttributes, getQualifiedExtraAttributes, setStandardAttribute

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Configuration

public Configuration(String name)

Creates a new configuration.

Parameters:

name - the name of the configuration

Configuration

public Configuration(Configuration source,
 ModuleRevisionId sourceModule)

Configuration

public Configuration(String name,
 Configuration.Visibility visibility,
 String description,
 String[] ext,
 boolean transitive,
 String deprecated)

Creates a new configuration.

Parameters:

name - the name of the configuration

visibility - the visibility of the configuration

description - a description

ext - the configurations to extend from

transitive - indicates if the configuration is transitive

deprecated - the deprecation message

Method Details

findConfigurationExtending

public static Collection<Configuration> findConfigurationExtending(String conf,
 Configuration[] confs)

getDeprecated

public String getDeprecated()

Returns the deprecation message, or null if not specified.

Returns:

Returns the deprecation message.

getDescription

public String getDescription()

Returns:

Returns the description. It may be null.

getExtends

public String[] getExtends()

Returns:

Returns the extends. May be empty, but never null.

getName

public String getName()

Returns:

Returns the name. Never null;

getVisibility

public Configuration.Visibility getVisibility()

Returns:

Returns the visibility. Never null.

isTransitive

public final boolean isTransitive()

Returns:

Returns the transitive.

getSourceModule

public ModuleRevisionId getSourceModule()

Specified by:

getSourceModule in interface InheritableItem

Returns:

the module in which this item was actually defined, if different from the module in which the item appears. May be null.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

replaceWildcards

public void replaceWildcards(ModuleDescriptor md)