org.apache.ivy.core.module.descriptor

Class DefaultModuleDescriptor

public class DefaultModuleDescriptor extends Object implements ModuleDescriptor

Constructor Summary
DefaultModuleDescriptor(ModuleRevisionId id, String status, Date pubDate)
DefaultModuleDescriptor(ModuleRevisionId id, String status, Date pubDate, boolean isDefault)
DefaultModuleDescriptor(ModuleDescriptorParser parser, Resource res)
IMPORTANT : at least call setModuleRevisionId and setResolvedPublicationDate with instances created by this constructor !
Method Summary
voidaddArtifact(String conf, Artifact artifact)
Artifact configurations are not used since added artifact may not be entirely completed, so its configurations data may not be accurate
voidaddConfiguration(Configuration conf)
voidaddConflictManager(ModuleId moduleId, PatternMatcher matcher, ConflictManager manager)
regular expressions as explained in Pattern class may be used in ModuleId organisation and name
voidaddDependency(DependencyDescriptor dependency)
voidaddDependencyDescriptorMediator(ModuleId moduleId, PatternMatcher matcher, DependencyDescriptorMediator ddm)
voidaddExcludeRule(ExcludeRule rule)
voidaddExtraAttributeNamespace(String prefix, String namespace)
voidaddExtraInfo(String infoKey, String value)
voidaddLicense(License license)
booleancanExclude()
voidcheck()
Throws an exception if the module descriptor is inconsistent For the moment, only extended configurations existence and cycles are checked
booleandependsOn(VersionMatcher matcher, ModuleDescriptor md)
booleandoesExclude(String[] moduleConfigurations, ArtifactId artifactId)
only works when namespace is properly set.
Artifact[]getAllArtifacts()
ModuleRulesgetAllDependencyDescriptorMediators()
ExcludeRule[]getAllExcludeRules()
Artifact[]getArtifacts(String conf)
StringgetAttribute(String attName)
MapgetAttributes()
ConfigurationgetConfiguration(String confName)
Returns the configuration object with the given name in the current module descriptor, null if not found.
Configuration[]getConfigurations()
String[]getConfigurationsNames()
ConflictManagergetConflictManager(ModuleId moduleId)
DependencyDescriptor[]getDependencies()
StringgetDescription()
ExcludeRule[]getExcludeRules(String[] moduleConfigurations)
StringgetExtraAttribute(String attName)
MapgetExtraAttributes()
MapgetExtraAttributesNamespaces()
MapgetExtraInfo()
StringgetHomePage()
longgetLastModified()
License[]getLicenses()
ArtifactgetMetadataArtifact()
ModuleRevisionIdgetModuleRevisionId()
NamespacegetNamespace()
ModuleDescriptorParsergetParser()
DategetPublicationDate()
String[]getPublicConfigurationsNames()
MapgetQualifiedExtraAttributes()
ModuleRevisionIdgetResolvedModuleRevisionId()
DategetResolvedPublicationDate()
ResourcegetResource()
StringgetRevision()
StringgetStatus()
booleanisDefault()
booleanisMappingOverride()
booleanisNamespaceUseful()
DependencyDescriptormediate(DependencyDescriptor dd)
static DefaultModuleDescriptornewBasicInstance(ModuleRevisionId mrid, Date publicationDate)
static DefaultModuleDescriptornewCallerInstance(ModuleRevisionId mrid, String[] confs, boolean transitive, boolean changing)
static DefaultModuleDescriptornewCallerInstance(ModuleRevisionId[] mrid, boolean transitive, boolean changing)
static DefaultModuleDescriptornewDefaultInstance(ModuleRevisionId mrid)
static DefaultModuleDescriptornewDefaultInstance(ModuleRevisionId mrid, DependencyArtifactDescriptor[] artifacts)
voidsetDefault(boolean b)
voidsetDescription(String description)
voidsetHomePage(String homePage)
voidsetLastModified(long lastModified)
voidsetMappingOverride(boolean override)
voidsetModuleArtifact(Artifact moduleArtifact)
voidsetModuleRevisionId(ModuleRevisionId revId)
voidsetNamespace(Namespace ns)
voidsetPublicationDate(Date publicationDate)
voidsetResolvedModuleRevisionId(ModuleRevisionId revId)
voidsetResolvedPublicationDate(Date publicationDate)
voidsetStatus(String status)
voidtoIvyFile(File destFile)
StringtoString()
static ModuleDescriptortransformInstance(ModuleDescriptor md, Namespace ns)
Transforms the given module descriptor of the given namespace and return a new module descriptor in the system namespace.

Constructor Detail

DefaultModuleDescriptor

public DefaultModuleDescriptor(ModuleRevisionId id, String status, Date pubDate)

DefaultModuleDescriptor

public DefaultModuleDescriptor(ModuleRevisionId id, String status, Date pubDate, boolean isDefault)

DefaultModuleDescriptor

public DefaultModuleDescriptor(ModuleDescriptorParser parser, Resource res)
IMPORTANT : at least call setModuleRevisionId and setResolvedPublicationDate with instances created by this constructor !

Method Detail

addArtifact

public void addArtifact(String conf, Artifact artifact)
Artifact configurations are not used since added artifact may not be entirely completed, so its configurations data may not be accurate

Parameters: conf artifact

addConfiguration

public void addConfiguration(Configuration conf)

addConflictManager

public void addConflictManager(ModuleId moduleId, PatternMatcher matcher, ConflictManager manager)
regular expressions as explained in Pattern class may be used in ModuleId organisation and name

Parameters: moduleId matcher resolverName

addDependency

public void addDependency(DependencyDescriptor dependency)

addDependencyDescriptorMediator

public void addDependencyDescriptorMediator(ModuleId moduleId, PatternMatcher matcher, DependencyDescriptorMediator ddm)

addExcludeRule

public void addExcludeRule(ExcludeRule rule)

addExtraAttributeNamespace

public void addExtraAttributeNamespace(String prefix, String namespace)

addExtraInfo

public void addExtraInfo(String infoKey, String value)

addLicense

public void addLicense(License license)

canExclude

public boolean canExclude()

check

public void check()
Throws an exception if the module descriptor is inconsistent For the moment, only extended configurations existence and cycles are checked

dependsOn

public boolean dependsOn(VersionMatcher matcher, ModuleDescriptor md)

doesExclude

public boolean doesExclude(String[] moduleConfigurations, ArtifactId artifactId)
only works when namespace is properly set. The behaviour is not specified if namespace is not set

getAllArtifacts

public Artifact[] getAllArtifacts()

getAllDependencyDescriptorMediators

public ModuleRules getAllDependencyDescriptorMediators()

getAllExcludeRules

public ExcludeRule[] getAllExcludeRules()

getArtifacts

public Artifact[] getArtifacts(String conf)

getAttribute

public String getAttribute(String attName)

getAttributes

public Map getAttributes()

getConfiguration

public Configuration getConfiguration(String confName)
Returns the configuration object with the given name in the current module descriptor, null if not found.

getConfigurations

public Configuration[] getConfigurations()

getConfigurationsNames

public String[] getConfigurationsNames()

getConflictManager

public ConflictManager getConflictManager(ModuleId moduleId)

getDependencies

public DependencyDescriptor[] getDependencies()

getDescription

public String getDescription()

getExcludeRules

public ExcludeRule[] getExcludeRules(String[] moduleConfigurations)

getExtraAttribute

public String getExtraAttribute(String attName)

getExtraAttributes

public Map getExtraAttributes()

getExtraAttributesNamespaces

public Map getExtraAttributesNamespaces()

getExtraInfo

public Map getExtraInfo()

getHomePage

public String getHomePage()

getLastModified

public long getLastModified()

getLicenses

public License[] getLicenses()

getMetadataArtifact

public Artifact getMetadataArtifact()

getModuleRevisionId

public ModuleRevisionId getModuleRevisionId()

getNamespace

public Namespace getNamespace()

getParser

public ModuleDescriptorParser getParser()

getPublicationDate

public Date getPublicationDate()

getPublicConfigurationsNames

public String[] getPublicConfigurationsNames()

getQualifiedExtraAttributes

public Map getQualifiedExtraAttributes()

getResolvedModuleRevisionId

public ModuleRevisionId getResolvedModuleRevisionId()

getResolvedPublicationDate

public Date getResolvedPublicationDate()

getResource

public Resource getResource()

getRevision

public String getRevision()

getStatus

public String getStatus()

isDefault

public boolean isDefault()

isMappingOverride

public boolean isMappingOverride()

isNamespaceUseful

public boolean isNamespaceUseful()

mediate

public DependencyDescriptor mediate(DependencyDescriptor dd)

newBasicInstance

public static DefaultModuleDescriptor newBasicInstance(ModuleRevisionId mrid, Date publicationDate)

newCallerInstance

public static DefaultModuleDescriptor newCallerInstance(ModuleRevisionId mrid, String[] confs, boolean transitive, boolean changing)

newCallerInstance

public static DefaultModuleDescriptor newCallerInstance(ModuleRevisionId[] mrid, boolean transitive, boolean changing)

newDefaultInstance

public static DefaultModuleDescriptor newDefaultInstance(ModuleRevisionId mrid)

newDefaultInstance

public static DefaultModuleDescriptor newDefaultInstance(ModuleRevisionId mrid, DependencyArtifactDescriptor[] artifacts)

setDefault

public void setDefault(boolean b)

setDescription

public void setDescription(String description)

setHomePage

public void setHomePage(String homePage)

setLastModified

public void setLastModified(long lastModified)

setMappingOverride

public void setMappingOverride(boolean override)

setModuleArtifact

public void setModuleArtifact(Artifact moduleArtifact)

setModuleRevisionId

public void setModuleRevisionId(ModuleRevisionId revId)

setNamespace

public void setNamespace(Namespace ns)

setPublicationDate

public void setPublicationDate(Date publicationDate)

setResolvedModuleRevisionId

public void setResolvedModuleRevisionId(ModuleRevisionId revId)

setResolvedPublicationDate

public void setResolvedPublicationDate(Date publicationDate)

setStatus

public void setStatus(String status)

toIvyFile

public void toIvyFile(File destFile)

toString

public String toString()

transformInstance

public static ModuleDescriptor transformInstance(ModuleDescriptor md, Namespace ns)
Transforms the given module descriptor of the given namespace and return a new module descriptor in the system namespace. Note that dependency exclude rules are not converted in system namespace, because they aren't transformable (the name space hasn't the ability to convert regular expressions)

Parameters: md ns

Returns: