|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ModuleDescriptor
Field Summary | |
---|---|
static java.lang.String |
CALLER_ALL_CONFIGURATION
|
static java.lang.String |
DEFAULT_CONFIGURATION
|
Method Summary | |
---|---|
boolean |
canExclude()
Returns true if this descriptor contains any exclusion rule |
boolean |
dependsOn(VersionMatcher matcher,
ModuleDescriptor md)
Returns true if the module described by this descriptor dependes directly upon the given module descriptor |
boolean |
doesExclude(java.lang.String[] moduleConfs,
ArtifactId artifactId)
Returns true if an exclude rule of this module attached to any of the given configurations matches the given artifact id, and thus exclude it |
Artifact[] |
getAllArtifacts()
|
ExcludeRule[] |
getAllExcludeRules()
Returns an array of all the exclude rules this module descriptor currently holds. |
Artifact[] |
getArtifacts(java.lang.String conf)
|
Configuration |
getConfiguration(java.lang.String confName)
|
Configuration[] |
getConfigurations()
Returns all the configurations declared by this module as an array. |
java.lang.String[] |
getConfigurationsNames()
|
ConflictManager |
getConflictManager(ModuleId id)
Returns the conflict manager to use for the given ModuleId |
DependencyDescriptor[] |
getDependencies()
|
java.lang.String |
getHomePage()
|
long |
getLastModified()
|
License[] |
getLicenses()
Returns the licenses of the module described by this descriptor |
ModuleRevisionId |
getModuleRevisionId()
|
ModuleDescriptorParser |
getParser()
The ModuleDescriptorParser used to parse this module descriptor, null is no parser was used. |
java.util.Date |
getPublicationDate()
may be null if unknown in the descriptor itself |
java.lang.String[] |
getPublicConfigurationsNames()
|
ModuleRevisionId |
getResolvedModuleRevisionId()
The module revision id returned here is the resolved one, i.e. it is never a latest one. |
java.util.Date |
getResolvedPublicationDate()
the publication date of the module revision should be the date at which it has been published, i.e. in general the date of any of its published artifacts, since all published artifact of a module should follow the same publishing cycle. |
Resource |
getResource()
The resource being the source of this module descriptor, null if no resource corresponds to this module descriptor |
java.lang.String |
getStatus()
|
boolean |
isDefault()
Returns true if this descriptor is a default one, i.e. |
void |
setResolvedModuleRevisionId(ModuleRevisionId revId)
This method update 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. |
Methods inherited from interface org.apache.ivy.util.extendable.ExtendableItem |
---|
getAttribute, getAttributes, getExtraAttribute, getExtraAttributes, getStandardAttribute, getStandardAttributes |
Field Detail |
---|
static final java.lang.String DEFAULT_CONFIGURATION
static final java.lang.String CALLER_ALL_CONFIGURATION
Method Detail |
---|
boolean isDefault()
ModuleRevisionId getModuleRevisionId()
ModuleRevisionId getResolvedModuleRevisionId()
void setResolvedModuleRevisionId(ModuleRevisionId revId)
revId
- void setResolvedPublicationDate(java.util.Date publicationDate)
publicationDate
- java.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()
DependencyDescriptor[] getDependencies()
boolean dependsOn(VersionMatcher matcher, ModuleDescriptor md)
md
-
Configuration getConfiguration(java.lang.String confName)
confName
-
ConflictManager getConflictManager(ModuleId id)
id
-
License[] getLicenses()
java.lang.String getHomePage()
long getLastModified()
void toIvyFile(java.io.File ivyFile) throws java.text.ParseException, java.io.IOException
ivyFile
- the destination ivy file
java.text.ParseException
java.io.IOException
ModuleDescriptorParser getParser()
Resource getResource()
boolean canExclude()
boolean doesExclude(java.lang.String[] moduleConfs, ArtifactId artifactId)
moduleConfs
- artifactId
-
ExcludeRule[] getAllExcludeRules()
ExcludeRule
this module descriptor holds
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |