public interface ModuleDescriptor extends ExtendableItem, ArtifactInfo, DependencyDescriptorMediator
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CALLER_ALL_CONFIGURATION |
static java.lang.String |
DEFAULT_CONFIGURATION |
Modifier and Type | Method and Description |
---|---|
boolean |
canExclude() |
boolean |
dependsOn(VersionMatcher matcher,
ModuleDescriptor md) |
boolean |
doesExclude(java.lang.String[] moduleConfs,
ArtifactId artifactId) |
Artifact[] |
getAllArtifacts() |
ModuleRules<DependencyDescriptorMediator> |
getAllDependencyDescriptorMediators() |
ExcludeRule[] |
getAllExcludeRules()
Module Descriptor exclude rules are used to exclude (usually transitive) dependencies for the
whole module.
|
Artifact[] |
getArtifacts(java.lang.String conf) |
Configuration |
getConfiguration(java.lang.String confName) |
Configuration[] |
getConfigurations() |
java.lang.String[] |
getConfigurationsNames() |
ConflictManager |
getConflictManager(ModuleId id) |
DependencyDescriptor[] |
getDependencies() |
java.lang.String |
getDescription() |
java.util.Map<java.lang.String,java.lang.String> |
getExtraAttributesNamespaces() |
java.util.Map<java.lang.String,java.lang.String> |
getExtraInfo()
Deprecated.
this method is not returning the full content of the extra info: to get the full
structure of the extra infos, use getExtraInfos()
|
ExtraInfoHolder |
getExtraInfoByTagName(java.lang.String tagName) |
java.lang.String |
getExtraInfoContentByTagName(java.lang.String tagName) |
java.util.List<ExtraInfoHolder> |
getExtraInfos() |
java.lang.String |
getHomePage() |
ExtendsDescriptor[] |
getInheritedDescriptors() |
long |
getLastModified() |
License[] |
getLicenses() |
Artifact |
getMetadataArtifact()
Even though the module descriptor is never described as a published artifact of a module in
the module descriptor itself, it is often useful to consider it as any other artifact of the
module.
|
ModuleRevisionId |
getModuleRevisionId() |
ModuleDescriptorParser |
getParser() |
java.util.Date |
getPublicationDate() |
java.lang.String[] |
getPublicConfigurationsNames() |
ModuleRevisionId |
getResolvedModuleRevisionId() |
java.util.Date |
getResolvedPublicationDate()
The publication date of the module revision should be the date at which it has been
published, i.e.
|
Resource |
getResource() |
java.lang.String |
getStatus() |
boolean |
isDefault() |
void |
setResolvedModuleRevisionId(ModuleRevisionId revId)
This method updates the resolved module revision id
|
void |
setResolvedPublicationDate(java.util.Date publicationDate)
This method update the resolved publication date
|
void |
toIvyFile(java.io.File ivyFile)
Writes this module descriptor as an ivy file.
|
getAttribute, getAttributes, getExtraAttribute, getExtraAttributes, getQualifiedExtraAttributes
getRevision
mediate
static final java.lang.String DEFAULT_CONFIGURATION
static final java.lang.String CALLER_ALL_CONFIGURATION
boolean isDefault()
ModuleRevisionId getModuleRevisionId()
ModuleRevisionId getResolvedModuleRevisionId()
void setResolvedModuleRevisionId(ModuleRevisionId revId)
revId
- ModuleRevisionIdExtendsDescriptor[] getInheritedDescriptors()
void setResolvedPublicationDate(java.util.Date publicationDate)
publicationDate
- Datejava.lang.String getStatus()
java.util.Date getPublicationDate()
java.util.Date getResolvedPublicationDate()
Configuration[] getConfigurations()
java.lang.String[] getConfigurationsNames()
java.lang.String[] getPublicConfigurationsNames()
Artifact[] getArtifacts(java.lang.String conf)
Artifact[] getAllArtifacts()
getMetadataArtifact()
DependencyDescriptor[] getDependencies()
boolean dependsOn(VersionMatcher matcher, ModuleDescriptor md)
matcher
- VersionMatchermd
- ModuleDescriptorConfiguration getConfiguration(java.lang.String confName)
confName
- dittoConflictManager getConflictManager(ModuleId id)
id
- ModuleIdLicense[] getLicenses()
java.lang.String getHomePage()
java.lang.String getDescription()
long getLastModified()
getLastModified
in interface ArtifactInfo
void toIvyFile(java.io.File ivyFile) throws java.text.ParseException, java.io.IOException
ivyFile
- the destination ivy filejava.text.ParseException
- if something goes wrongjava.io.IOException
- if something goes wrongModuleDescriptorParser getParser()
Resource getResource()
Artifact getMetadataArtifact()
boolean canExclude()
boolean doesExclude(java.lang.String[] moduleConfs, ArtifactId artifactId)
moduleConfs
- String[]artifactId
- dittoExcludeRule[] getAllExcludeRules()
ExcludeRule
this module descriptor currently holds.ModuleRules<DependencyDescriptorMediator> getAllDependencyDescriptorMediators()
DependencyDescriptorMediator
s used by this
ModuleDescriptor
, as an instance of ModuleRules
.java.util.Map<java.lang.String,java.lang.String> getExtraAttributesNamespaces()
@Deprecated java.util.Map<java.lang.String,java.lang.String> getExtraInfo()
java.util.List<ExtraInfoHolder> getExtraInfos()
java.lang.String getExtraInfoContentByTagName(java.lang.String tagName)
tagName
- StringExtraInfoHolder getExtraInfoByTagName(java.lang.String tagName)
tagName
- StringCopyright ©2007-2022 The Apache Software Foundation, Licensed under Apache License, Version 2.0.