http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/event/IvyEventFilter.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/event/IvyEventFilter.java b/src/java/org/apache/ivy/core/event/IvyEventFilter.java index 6b0d87e..ac9251f 100644 --- a/src/java/org/apache/ivy/core/event/IvyEventFilter.java +++ b/src/java/org/apache/ivy/core/event/IvyEventFilter.java @@ -34,6 +34,7 @@ import org.apache.ivy.util.filter.OrFilter; * attribute values is done using the {@link PatternMatcher} used to construct this object. Here are * some examples: * <table> + * <caption>Filtering examples</caption> * <tr> * <td>expression</td> * <td>effect</td> @@ -60,10 +61,10 @@ import org.apache.ivy.util.filter.OrFilter; * </tr> * </table> * Combination of these can be used, but no parentheses are supported right now, so only the default - * priority can be used. The priority order is this one: AND OR NOT = This means that artifact=foo - * AND ext=zip OR type=src will match event with artifact matching foo AND (ext matching zip OR type - * matching src) - * + * priority can be used. The priority order is this one: <code>AND OR NOT =</code> This means that + * <code>artifact=foo AND ext=zip OR type=src</code> will match event with artifact matching foo AND + * (ext matching zip OR type matching src) + * * @since 1.4 */ public class IvyEventFilter implements Filter {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/module/descriptor/DefaultDependencyDescriptor.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/module/descriptor/DefaultDependencyDescriptor.java b/src/java/org/apache/ivy/core/module/descriptor/DefaultDependencyDescriptor.java index 00fdea8..10ec684 100644 --- a/src/java/org/apache/ivy/core/module/descriptor/DefaultDependencyDescriptor.java +++ b/src/java/org/apache/ivy/core/module/descriptor/DefaultDependencyDescriptor.java @@ -57,7 +57,7 @@ public class DefaultDependencyDescriptor implements DependencyDescriptor { * descriptor in the system namespace. <i>Note that exclude rules are not converted in system * namespace, because they aren't transformable (the name space hasn't the ability to convert * regular expressions). However, method doesExclude will work with system artifacts.</i> - * + * * @param dd DependencyDescriptor * @param ns Namespace * @return DependencyDescriptor @@ -76,9 +76,10 @@ public class DefaultDependencyDescriptor implements DependencyDescriptor { * Transforms a dependency descriptor using the given transformer. Note that no namespace info * will be attached to the transformed dependency descriptor, so calling doesExclude is not * recommended (doesExclude only works when namespace is properly set) - * + * * @param dd DependencyDescriptor * @param t NamespaceTransformer + * @param fromSystem boolean * @return DefaultDependencyDescriptor */ public static DefaultDependencyDescriptor transformInstance(DependencyDescriptor dd, @@ -252,6 +253,7 @@ public class DefaultDependencyDescriptor implements DependencyDescriptor { * extending one). Both moduleConfiguration and requestedConfiguration are configurations of the * caller, the array returned is composed of the required configurations of the dependency * described by this descriptor. + * </p> */ public String[] getDependencyConfigurations(String moduleConfiguration, String requestedConfiguration) { @@ -288,16 +290,22 @@ public class DefaultDependencyDescriptor implements DependencyDescriptor { * we do not handle special confs like *!sg or [cond]* in right hand * confs yet: it would require supporting parenthesis grouping in * configurations intersection interpretation - * - * for (Iterator it2 = depConfs.iterator(); it2.hasNext();) { String - * depConf = (String) it2.next(); if (depConf.startsWith("*")) { if - * (intersectedDepConf .indexOf("(" + depConf + ")") != -1) { - * intersectedDepConfs.add(intersectedDepConf); } else { - * intersectedDepConfs.add( "(" + intersectedDepConf + ")+(" + - * depConf + ")"); } } else if (intersectedDepConf.startsWith("*")) - * { if (depConf .indexOf("(" + intersectedDepConf + ")") != -1) { - * intersectedDepConfs.add(depConf); } else { - * intersectedDepConfs.add( depConf + "+" + intersectedDepConf); } } + * + * for (Iterator it2 = depConfs.iterator(); it2.hasNext();) { + * String depConf = (String) it2.next(); + * if (depConf.startsWith("*")) { + * if (intersectedDepConf .indexOf("(" + depConf + ")") != -1) { + * intersectedDepConfs.add(intersectedDepConf); + * } else { + * intersectedDepConfs.add( "(" + intersectedDepConf + ")+(" + depConf + ")"); + * } + * } else if (intersectedDepConf.startsWith("*")) { + * if (depConf .indexOf("(" + intersectedDepConf + ")") != -1) { + * intersectedDepConfs.add(depConf); + * } else { + * intersectedDepConfs.add( depConf + "+" + intersectedDepConf); + * } + * } * } */ } @@ -406,7 +414,7 @@ public class DefaultDependencyDescriptor implements DependencyDescriptor { /** * Replaces fallback patterns with correct values if fallback pattern exists. - * + * * @param pattern * pattern to look for * @param conf @@ -607,7 +615,7 @@ public class DefaultDependencyDescriptor implements DependencyDescriptor { } /** - * + * * @return true if this descriptor contains any exclusion rule */ public boolean canExclude() { http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/module/descriptor/DefaultModuleDescriptor.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/module/descriptor/DefaultModuleDescriptor.java b/src/java/org/apache/ivy/core/module/descriptor/DefaultModuleDescriptor.java index 1c039b6..b286bc2 100644 --- a/src/java/org/apache/ivy/core/module/descriptor/DefaultModuleDescriptor.java +++ b/src/java/org/apache/ivy/core/module/descriptor/DefaultModuleDescriptor.java @@ -133,7 +133,7 @@ public class DefaultModuleDescriptor implements ModuleDescriptor { * descriptor in the system namespace. <i>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)</i> - * + * * @param md ModuleDescriptor * @param ns Namespace * @return ModuleDescriptor @@ -280,6 +280,9 @@ public class DefaultModuleDescriptor implements ModuleDescriptor { /** * IMPORTANT : at least call setModuleRevisionId and setResolvedPublicationDate with instances * created by this constructor ! + * + * @param parser ModuleDescriptorParser + * @param res Resource */ public DefaultModuleDescriptor(ModuleDescriptorParser parser, Resource res) { this.parser = parser; @@ -361,7 +364,7 @@ public class DefaultModuleDescriptor implements ModuleDescriptor { /** * Artifact configurations are not used since added artifact may not be entirely completed, so * its configurations data may not be accurate - * + * * @param conf ditto * @param artifact ditto */ @@ -427,6 +430,8 @@ public class DefaultModuleDescriptor implements ModuleDescriptor { /** * Returns the configuration object with the given name in the current module descriptor, null * if not found. + * + * @param confName String */ public Configuration getConfiguration(String confName) { Configuration configuration = configurations.get(confName); @@ -599,7 +604,7 @@ public class DefaultModuleDescriptor implements ModuleDescriptor { /** * regular expressions as explained in Pattern class may be used in ModuleId organisation and * name - * + * * @param moduleId ditto * @param matcher PatternMatcher * @param manager ConflictManager @@ -681,7 +686,7 @@ public class DefaultModuleDescriptor implements ModuleDescriptor { } /** - * Throws an exception if the module descriptor is inconsistent For the moment, only extended + * Throws an exception if the module descriptor is inconsistent. For the moment, only extended * configurations existence and cycles are checked */ public void check() { @@ -781,8 +786,12 @@ public class DefaultModuleDescriptor implements ModuleDescriptor { } /** - * only works when namespace is properly set. The behaviour is not specified if namespace is not - * set + * Only works when namespace is properly set. The behaviour is not specified if namespace is + * not set. + * + * @param moduleConfigurations String[] + * @param artifactId ditto + * @return boolean */ public boolean doesExclude(String[] moduleConfigurations, ArtifactId artifactId) { if (namespace != null) { http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/module/descriptor/DependencyArtifactDescriptor.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/module/descriptor/DependencyArtifactDescriptor.java b/src/java/org/apache/ivy/core/module/descriptor/DependencyArtifactDescriptor.java index 1ea78da..f20080f 100644 --- a/src/java/org/apache/ivy/core/module/descriptor/DependencyArtifactDescriptor.java +++ b/src/java/org/apache/ivy/core/module/descriptor/DependencyArtifactDescriptor.java @@ -27,44 +27,32 @@ import org.apache.ivy.util.extendable.ExtendableItem; */ public interface DependencyArtifactDescriptor extends ExtendableItem { /** - * Returns the dependency descriptor in which this dependency artifact descriptor is declared. - * * @return the dependency descriptor in which this dependency artifact descriptor is declared. */ public DependencyDescriptor getDependencyDescriptor(); /** - * Returns the name of the artifact asked - * - * @return + * @return the name of the artifact asked */ public String getName(); /** - * Returns the type of the artifact asked - * - * @return + * @return the type of the artifact asked */ public String getType(); /** - * Returns the ext of the artifact asked - * - * @return + * @return the ext of the artifact asked */ public String getExt(); /** - * Returns the url to look this artifact at - * - * @return + * @return the url to look this artifact up at */ public URL getUrl(); /** - * Returns the configurations of the module in which the artifact is asked - * - * @return an array of configuration names in which the artifact is asked + * @return an array of configuration names of the module in which the artifact is asked */ public String[] getConfigurations(); } http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/module/descriptor/DependencyDescriptor.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/module/descriptor/DependencyDescriptor.java b/src/java/org/apache/ivy/core/module/descriptor/DependencyDescriptor.java index 13973d8..880c0e3 100644 --- a/src/java/org/apache/ivy/core/module/descriptor/DependencyDescriptor.java +++ b/src/java/org/apache/ivy/core/module/descriptor/DependencyDescriptor.java @@ -34,11 +34,11 @@ import org.apache.ivy.util.extendable.ExtendableItem; * </p> * <p> * Then there is the dynamic constraint, which can either be the same as the default constraint, or - * the original dependency constraint when an Ivy file is delivered an published to a repository. - * This dynamic constraint is returned by {@link #getDynamicConstraintDependencyRevisionId()}, and - * corresponds to the <code>revconstraint</code> attribute in the Ivy file. In some resolve mode, - * this constraint can be used instead of the default dependency constraint when performing - * dependency resolution. + * the original dependency constraint when an Ivy file is delivered an published to a + * repository. This dynamic constraint is returned by + * {@link #getDynamicConstraintDependencyRevisionId()}, and corresponds to the + * <code>revconstraint</code> attribute in the Ivy file. In some resolve mode, this constraint can + * be used instead of the default dependency constraint when performing dependency resolution. * </p> */ public interface DependencyDescriptor extends ExtendableItem, InheritableItem { @@ -47,7 +47,7 @@ public interface DependencyDescriptor extends ExtendableItem, InheritableItem { /** * Used to indicate that this revision must be used in case of conflicts, independently of * conflicts manager. This only works for direct dependencies, and not transitive ones. - * + * * @return true if this dependency should be used, false if conflicts manager can do its work. */ boolean isForce(); @@ -57,7 +57,7 @@ public interface DependencyDescriptor extends ExtendableItem, InheritableItem { * that the revision may have its artifacts modified without revision change. When new artifacts * are published a new ivy file should also be published with a new publication date to indicate * to ivy that artifacts have changed and that they should be downloaded again. - * + * * @return true if this dependency is a changing one */ boolean isChanging(); @@ -68,14 +68,14 @@ public interface DependencyDescriptor extends ExtendableItem, InheritableItem { /** * Returns the constraint on dependency this descriptor represents. - * + * * @return the constraint on dependency. */ ModuleRevisionId getDependencyRevisionId(); /** * Returns the dynamic constraint on dependency this descriptor represents. - * + * * @return the dynamic constraint on dependency, or exact constraint if no dynamic constraint is * specified. */ @@ -111,7 +111,7 @@ public interface DependencyDescriptor extends ExtendableItem, InheritableItem { /** * Returns true if - * + * * @param moduleConfigurations ditto * @param artifactId ditto * @return boolean @@ -119,8 +119,6 @@ public interface DependencyDescriptor extends ExtendableItem, InheritableItem { boolean doesExclude(String[] moduleConfigurations, ArtifactId artifactId); /** - * Returns true if this descriptor contains any exclusion rule - * * @return true if this descriptor contains any exclusion rule */ public boolean canExclude(); @@ -129,7 +127,7 @@ public interface DependencyDescriptor extends ExtendableItem, InheritableItem { /** * Clones current dependency descriptor with another revision. - * + * * @param revision * the revision of the cloned dependency descriptor * @return the cloned dependency descriptor http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/module/descriptor/ExtendsDescriptor.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/module/descriptor/ExtendsDescriptor.java b/src/java/org/apache/ivy/core/module/descriptor/ExtendsDescriptor.java index 8b7456d..b953104 100644 --- a/src/java/org/apache/ivy/core/module/descriptor/ExtendsDescriptor.java +++ b/src/java/org/apache/ivy/core/module/descriptor/ExtendsDescriptor.java @@ -24,12 +24,18 @@ import org.apache.ivy.core.module.id.ModuleRevisionId; */ public interface ExtendsDescriptor { - /** get the module revision id of the declared parent descriptor */ + /** + * get the module revision id of the declared parent descriptor + * + * @return ModuleRevisionId + */ public ModuleRevisionId getParentRevisionId(); /** * get the resolved revision id for {@link #getParentRevisionId}, see * {@link org.apache.ivy.core.module.descriptor.ModuleDescriptor#getResolvedModuleRevisionId()} + * + * @return ModuleRevisionId */ public ModuleRevisionId getResolvedParentRevisionId(); @@ -38,6 +44,8 @@ public interface ExtendsDescriptor { /** * If there is an explicit path to check for the parent descriptor, return it. Otherwise returns * null. + * + * @return String */ public String getLocation(); @@ -46,22 +54,34 @@ public interface ExtendsDescriptor { * <code>info</code>, <code>description</code>, <code>configurations</code>, * <code>dependencies</code>, and/or <code>all</code>. Ivy extensions may add support for * additional extends types. + * + * @return String[] */ public String[] getExtendsTypes(); - /** @return true if the <code>all</code> extend type is specified, implying all other types */ + /** + * @return true if the <code>all</code> extend type is specified, implying all other types + */ public boolean isAllInherited(); - /** @return true if parent info attributes are inherited (organisation, branch, revision, etc) */ + /** + * @return true if parent info attributes are inherited (organisation, branch, revision, etc) + */ public boolean isInfoInherited(); - /** @return true if parent description is inherited */ + /** + * @return true if parent description is inherited + */ public boolean isDescriptionInherited(); - /** @return true if parent configurations are inherited */ + /** + * @return true if parent configurations are inherited + */ public boolean areConfigurationsInherited(); - /** @return true if parent dependencies are inherited */ + /** + * @return true if parent dependencies are inherited + */ public boolean areDependenciesInherited(); public boolean isLocal(); http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/module/descriptor/ModuleDescriptor.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/module/descriptor/ModuleDescriptor.java b/src/java/org/apache/ivy/core/module/descriptor/ModuleDescriptor.java index 1116d88..6b4a2a0 100644 --- a/src/java/org/apache/ivy/core/module/descriptor/ModuleDescriptor.java +++ b/src/java/org/apache/ivy/core/module/descriptor/ModuleDescriptor.java @@ -46,35 +46,31 @@ public interface ModuleDescriptor extends ExtendableItem, ArtifactInfo, public static final String CALLER_ALL_CONFIGURATION = "all"; /** - * Returns true if this descriptor is a default one, i.e. one generated for a module not - * actually having one. - * - * @return boolean + * @return true if this descriptor is a default one, i.e. one generated for a module not + * actually having one. */ boolean isDefault(); ModuleRevisionId getModuleRevisionId(); /** - * The module revision id returned here is the resolved one, i.e. it is never a latest one. If - * the revision has not been resolved, a null revision should be returned by getRevision() of - * the returned ModuleRevisionId. This revision must be the same as the module descriptor - * resolved revision id unless no module descriptor is defined - * - * @return ModuleRevisionId + * @return the resolved module revision id; it is never the latest one. If the revision has not + * been resolved, a null revision should be returned by getRevision() of the returned + * ModuleRevisionId. This revision must be the same as the module descriptor resolved + * revision id unless no module descriptor is defined */ ModuleRevisionId getResolvedModuleRevisionId(); /** - * This method update the resolved module revision id + * This method updates the resolved module revision id * * @param revId ModuleRevisionId */ void setResolvedModuleRevisionId(ModuleRevisionId revId); /** - * Get the list of parent descriptors imported via an <extends> element. Only directly - * imported descriptors are included; the parent's parents are not included. + * @return the list of parent descriptors imported via an <extends> element. Only directly + * imported descriptors are included; the parent's parents are not included. */ ExtendsDescriptor[] getInheritedDescriptors(); @@ -88,9 +84,7 @@ public interface ModuleDescriptor extends ExtendableItem, ArtifactInfo, String getStatus(); /** - * May be <code>null</code> if unknown in the descriptor itself. - * - * @return The publication date or <code>null</code> when not known. + * @return the publication date or null when not known in the descriptor itself. */ Date getPublicationDate(); @@ -98,14 +92,14 @@ public interface ModuleDescriptor extends ExtendableItem, ArtifactInfo, * 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. + * + * @return Date */ Date getResolvedPublicationDate(); /** - * Returns all the configurations declared by this module as an array. This array is never empty - * (a 'default' conf is assumed when none is declared in the ivy file) - * - * @return all the configurations declared by this module as an array. + * @return all the configurations declared by this module as an array. This array is never empty + * (a 'default' conf is assumed when none is declared in the ivy file). */ Configuration[] getConfigurations(); @@ -116,27 +110,23 @@ public interface ModuleDescriptor extends ExtendableItem, ArtifactInfo, Artifact[] getArtifacts(String conf); /** - * Returns all artifacts of this module, excluding the artifact corresponding to the module - * descriptor. - * - * @return all published artifacts of this module + * @return all published artifacts of this module, excluding the artifact corresponding to the + * module descriptor. * @see #getMetadataArtifact() */ Artifact[] getAllArtifacts(); /** - * @return The dependencies of the module. If there is no dependencies return an empty array (non - * null) + * @return The dependencies of the module. If there are no dependencies return an empty array + * (non null) */ DependencyDescriptor[] getDependencies(); /** - * Returns true if the module described by this descriptor depends directly upon the given - * module descriptor - * * @param matcher VersionMatcher * @param md ModuleDescriptor - * @return boolean + * @return true if the module described by this descriptor depends directly upon the given + * module descriptor */ boolean dependsOn(VersionMatcher matcher, ModuleDescriptor md); @@ -147,18 +137,14 @@ public interface ModuleDescriptor extends ExtendableItem, ArtifactInfo, Configuration getConfiguration(String confName); /** - * Returns the conflict manager to use for the given ModuleId, or <code>null</code> if no - * specific conflict manager is associated with the given module id in this module descriptor. - * * @param id ModuleId - * @return ConflictManager + * @return the conflict manager to use for the given ModuleId, or null if no specific conflict + * manager is associated with the given module id in this module descriptor. */ ConflictManager getConflictManager(ModuleId id); /** - * Returns the licenses of the module described by this descriptor - * - * @return License[] + * @return the licenses of the module described by this descriptor */ License[] getLicenses(); @@ -175,92 +161,69 @@ public interface ModuleDescriptor extends ExtendableItem, ArtifactInfo, * * @param ivyFile * the destination ivy file + * @throws ParseException if something goes wrong + * @throws IOException if something goes wrong */ void toIvyFile(File ivyFile) throws ParseException, IOException; /** - * The ModuleDescriptorParser used to parse this module descriptor, null is no parser was used. - * - * @return ModuleDescriptorParser + * @return the ModuleDescriptorParser used to parse this module descriptor, null is no parser was used. */ ModuleDescriptorParser getParser(); /** - * The resource being the source of this module descriptor, null if no resource corresponds to - * this module descriptor - * - * @return Resource + * @return the resource being the source of this module descriptor, null if no resource + * corresponds to this module descriptor. */ Resource getResource(); /** - * Returns the Artifact representing this module descriptor itself. - * <p> * 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. This method allows to access to the Artifact object representing this module * descriptor for this purpose. - * </p> * * @return the Artifact representing this module descriptor itself. */ Artifact getMetadataArtifact(); /** - * Returns true if this descriptor contains any exclusion rule - * - * @return true if this descriptor contains any exclusion rule + * @return true if this descriptor contains any exclusion rule. */ boolean canExclude(); /** - * 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 - * * @param moduleConfs String[] * @param artifactId ditto - * @return boolean + * @return true if an exclude rule of this module attached to any of the given configurations + * matches the given artifact id, and thus exclude it */ boolean doesExclude(String[] moduleConfs, ArtifactId artifactId); /** - * Returns an array of all the exclude rules this module descriptor currently holds. Module - * Descriptor exclude rules are used to exclude (usually transitive) dependencies for the whole - * module. + * Module Descriptor exclude rules are used to exclude (usually transitive) dependencies for the + * whole module. * - * @return an array of {@link ExcludeRule} this module descriptor holds + * @return an array of all {@link ExcludeRule} this module descriptor currently holds. */ public ExcludeRule[] getAllExcludeRules(); /** - * Returns all the dependency descriptor mediators used by this {@link ModuleDescriptor}, as an - * instance of {@link ModuleRules}. - * <p> - * All rules in the {@link ModuleRules} object returned are {@link DependencyDescriptorMediator} - * . - * </p> - * - * @return all the dependency descriptor mediators used by this {@link ModuleDescriptor}. + * @return all the {@link DependencyDescriptorMediator}s used by this + * {@link ModuleDescriptor}, as an instance of {@link ModuleRules}. */ public ModuleRules/* <DependencyDescriptorMediator> */getAllDependencyDescriptorMediators(); /** - * Returns the list of xml namespaces used by extra attributes, as Map from prefix to namespace - * URIs. - * <p> - * The returned list is never <code>null</code>, it is empty when no extra attribute is used or - * if extra attributes are used without xml namespaces - * </p> - * * @return the list of xml namespaces used by extra attributes, as Map from prefix to namespace - * URIs. + * URIs. The returned list is never null, it is empty when no extra attribute is used or + * if extra attributes are used without xml namespaces */ Map<String, String> getExtraAttributesNamespaces(); /** - * Returns the custom info provided in the info tag. All the tags except the description are - * given. The key is the name of the tag, the value is its content. <br /> - * + * @return the custom info provided in the info tag. All the tags except the description are + * given. The key is the name of the tag, the value is its content. * @deprecated this method is not returning the full content of the extra info: to get the full * structure of the extra infos, use getExtraInfos() */ @@ -268,27 +231,23 @@ public interface ModuleDescriptor extends ExtendableItem, ArtifactInfo, Map<String, String> getExtraInfo(); /** - * Returns a list of extras infos (tag name, attributes and content). All the tags except the - * description are given. - * * @since 2.4.0 - * @return List<ExtraInfoHolder> + * @return a list of extras infos (tag name, attributes and content). All the tags except the + * description are given. */ List<ExtraInfoHolder> getExtraInfos(); /** - * Returns content from first extrainfo matching with given tag name - * * @since 2.4.0 - * @return ditto + * @param tagName String + * @return content from first extrainfo matching with given tag name. */ String getExtraInfoContentByTagName(String tagName); /** - * Returns first extrainfo matching with given tag name - * * @since 2.4.0 - * @return ExtraInfoHolder + * @param tagName String + * @return first extrainfo matching with given tag name. */ ExtraInfoHolder getExtraInfoByTagName(String tagName); } http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/module/id/ArtifactId.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/module/id/ArtifactId.java b/src/java/org/apache/ivy/core/module/id/ArtifactId.java index 0991c1f..a174738 100644 --- a/src/java/org/apache/ivy/core/module/id/ArtifactId.java +++ b/src/java/org/apache/ivy/core/module/id/ArtifactId.java @@ -19,7 +19,7 @@ package org.apache.ivy.core.module.id; /** * Identifies an artifact in a module, without revision information - * + * * @see <a href="package-summary.html">org.apache.ivy.core.module.id</a> */ public class ArtifactId { @@ -38,6 +38,8 @@ public class ArtifactId { * The name of the artifact. * @param type * The type of the artifact. + * @param ext + * The name extension of the artifact. */ public ArtifactId(ModuleId mid, String name, String type, String ext) { this.mid = mid; http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/module/id/MatcherLookup.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/module/id/MatcherLookup.java b/src/java/org/apache/ivy/core/module/id/MatcherLookup.java index c1fa6ad..714643a 100644 --- a/src/java/org/apache/ivy/core/module/id/MatcherLookup.java +++ b/src/java/org/apache/ivy/core/module/id/MatcherLookup.java @@ -33,24 +33,22 @@ import org.apache.ivy.plugins.matcher.PatternMatcher; * matcher's attributes. When matcher is looked up against specific module, the key is recreated * from module's attributes. * <p> - * </p> * The lookup doesn't target to speed up lookup for non exact pattern matcher. All non exact * matchers are placed in non-keyed collection. - * <p> * </p> + * <p> * At lookup for matchers against specific module, all non exact pattern matchers are iterated to * match with module attributes, and exact pattern matchers binding to the same key will also * iterated to match with module attributes. - * <p> * </p> + * <p> * If there are much more exact pattern matchers than non exact pattern matchers, the matcher lookup * speed can benefit from this class significantly. A quick example could be user declares lots of * dependencyOverrides which are typically exact pattern matchers. - * <p> * </p> + * <p> * If there are balanced exact and non exact pattern matchers, the matcher lookup speed doesn't hurt * by this class. - * <p> * </p> */ public class MatcherLookup { @@ -65,12 +63,12 @@ public class MatcherLookup { /** * Add matcher. - * + * * If matcher is exact pattern matcher, it will be associated with a key and placed in keyed * collection. - * + * * If matcher is not exact pattern matcher, it will be placed into non-keyed collection - * + * * @param matcher MapMatcher */ public void add(MapMatcher matcher) { @@ -88,12 +86,10 @@ public class MatcherLookup { } /** - * Get a list of matchers which can apply to module with specified attributes - * * @param attrs * A map of attributes that matcher should match. - * - * @return list A list of candidate matchers that matches specified attributes + * + * @return a list of matchers that can apply to module withs specified attributes */ public List<MapMatcher> get(Map<String, String> attrs) { List<MapMatcher> matchers = new ArrayList<MapMatcher>(); @@ -131,7 +127,7 @@ public class MatcherLookup { /** * Create a key from specified attributes - * + * * @param attrs * A map of attributes * @return key object http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/publish/PublishEngine.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/publish/PublishEngine.java b/src/java/org/apache/ivy/core/publish/PublishEngine.java index d6a7904..a43240c 100644 --- a/src/java/org/apache/ivy/core/publish/PublishEngine.java +++ b/src/java/org/apache/ivy/core/publish/PublishEngine.java @@ -73,6 +73,13 @@ public class PublishEngine { * reports. The extra artifacts array can be null (= no extra artifacts), and if non null only * the name, type, ext url and extra attributes of the artifacts are really used. Other methods * can return null safely. + * + * @param mrid ModuleRevisionId + * @param srcArtifactPattern a Collection of String + * @param resolverName String + * @param options PublishOptions + * @return Collection<Artifact> + * @throws IOException if something goes wrong */ public Collection<Artifact> publish(ModuleRevisionId mrid, Collection<String> srcArtifactPattern, String resolverName, PublishOptions options) http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/report/ConfigurationResolveReport.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/report/ConfigurationResolveReport.java b/src/java/org/apache/ivy/core/report/ConfigurationResolveReport.java index 38296df..47fa680 100644 --- a/src/java/org/apache/ivy/core/report/ConfigurationResolveReport.java +++ b/src/java/org/apache/ivy/core/report/ConfigurationResolveReport.java @@ -78,11 +78,15 @@ public class ConfigurationResolveReport { } /** - * Check if the set of dependencies has changed since the previous execution of a resolution.<br/> + * Check if the set of dependencies has changed since the previous execution of a resolution. + * <p> * This function use the report file found in the cache. So the function must be called before - * the new report is serialized there.</br> This function also use the internal dependencies - * that must already be filled. This function might be 'heavy' because it may have to parse the - * previous report. + * the new report is serialized there. + * </p> + * <p> + * This function also use the internal dependencies that must already be filled. This function + * might be 'heavy' because it may have to parse the previous report. + * </p> */ public void checkIfChanged() { ResolutionCacheManager cache = resolveEngine.getSettings().getResolutionCacheManager(); @@ -109,6 +113,7 @@ public class ConfigurationResolveReport { /** * @pre checkIfChanged has been called. + * @return boolean */ public boolean hasChanged() { return hasChanged; @@ -117,7 +122,7 @@ public class ConfigurationResolveReport { /** * Returns all non evicted and non error dependency mrids The returned set is ordered so that a * dependency will always be found before their own dependencies - * + * * @return all non evicted and non error dependency mrids */ public Set<ModuleRevisionId> getModuleRevisionIds() { @@ -235,7 +240,7 @@ public class ConfigurationResolveReport { /** * gives all the modules ids concerned by this report, from the most dependent to the least one - * + * * @return a list of ModuleId */ public List<ModuleId> getModuleIds() { @@ -278,7 +283,7 @@ public class ConfigurationResolveReport { /** * Get every report on the download requests. - * + * * @return the list of reports, never <code>null</code> */ public ArtifactDownloadReport[] getAllArtifactsReports() { @@ -288,7 +293,7 @@ public class ConfigurationResolveReport { /** * Get the report on the download requests. The list of download report can be restricted to a * specific download status, and also remove the download report for the evicted modules. - * + * * @param downloadStatus * the status of download to retrieve. Set it to <code>null</code> for no restriction * on the download status @@ -321,7 +326,7 @@ public class ConfigurationResolveReport { /** * Get the report on the successful download requests with the evicted modules - * + * * @return the list of reports, never <code>null</code> */ public ArtifactDownloadReport[] getDownloadedArtifactsReports() { @@ -330,7 +335,7 @@ public class ConfigurationResolveReport { /** * Get the report on the failed download requests with the evicted modules - * + * * @return the list of reports, never <code>null</code> */ public ArtifactDownloadReport[] getFailedArtifactsReports() { http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/report/DownloadStatus.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/report/DownloadStatus.java b/src/java/org/apache/ivy/core/report/DownloadStatus.java index f0364c2..db5fab5 100644 --- a/src/java/org/apache/ivy/core/report/DownloadStatus.java +++ b/src/java/org/apache/ivy/core/report/DownloadStatus.java @@ -38,7 +38,8 @@ public final class DownloadStatus { /** * Returns the {@link DownloadStatus} corresponding to the given String representation. - * + * + * @param status String * @return the {@link DownloadStatus} corresponding to the given String representation. * @throws IllegalArgumentException * if the given String does not correspond to any {@link DownloadStatus}. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/report/ResolveReport.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/report/ResolveReport.java b/src/java/org/apache/ivy/core/report/ResolveReport.java index 0fb05f0..01be748 100644 --- a/src/java/org/apache/ivy/core/report/ResolveReport.java +++ b/src/java/org/apache/ivy/core/report/ResolveReport.java @@ -128,7 +128,7 @@ public class ResolveReport { /** * Get every report on the download requests. - * + * * @return the list of reports, never <code>null</code> */ public ArtifactDownloadReport[] getFailedArtifactsReports() { @@ -138,7 +138,7 @@ public class ResolveReport { /** * Get every report on the download requests. - * + * * @return the list of reports, never <code>null</code> */ public ArtifactDownloadReport[] getAllArtifactsReports() { @@ -148,7 +148,7 @@ public class ResolveReport { /** * Get the report on the download requests. The list of download report can be restricted to a * specific download status, and also remove the download report for the evicted modules. - * + * * @param downloadStatus * the status of download to retrieve. Set it to <code>null</code> for no restriction * on the download status @@ -184,7 +184,11 @@ public class ResolveReport { } } - /** Can only be called if checkIfChanged has been called */ + /** + * Can only be called if checkIfChanged has been called + * + * @return boolean + */ public boolean hasChanged() { for (ConfigurationResolveReport report : confReports.values()) { if (report.hasChanged()) { @@ -245,7 +249,7 @@ public class ResolveReport { /** * Returns the list of all dependencies concerned by this report as a List of IvyNode ordered * from the more dependent to the least one - * + * * @return The list of all dependencies. */ public List<IvyNode> getDependencies() { @@ -255,7 +259,7 @@ public class ResolveReport { /** * Returns the list of all artifacts which should be downloaded per this resolve To know if the * artifact have actually been downloaded use information found in ConfigurationResolveReport. - * + * * @return The list of all artifacts. */ public List<Artifact> getArtifacts() { @@ -264,7 +268,7 @@ public class ResolveReport { /** * gives all the modules ids concerned by this report, from the most dependent to the least one - * + * * @return a list of ModuleId */ public List<ModuleId> getModuleIds() { @@ -305,7 +309,7 @@ public class ResolveReport { * This only includes artifacts actually downloaded to cache (DownloadStatus.SUCCESSFUL), and * not artifacts already in cache or used at their original location. * </p> - * + * * @return The total size of downloaded artifacts, in bytes. */ public long getDownloadSize() { @@ -319,7 +323,7 @@ public class ResolveReport { /** * Get every configuration which extends the specified one. The returned list also includes the * specified one. - * + * * @param extended String * @return String[] */ http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/resolve/IvyNode.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/resolve/IvyNode.java b/src/java/org/apache/ivy/core/resolve/IvyNode.java index 4cac6c7..a26146f 100644 --- a/src/java/org/apache/ivy/core/resolve/IvyNode.java +++ b/src/java/org/apache/ivy/core/resolve/IvyNode.java @@ -132,7 +132,16 @@ public class IvyNode implements Comparable<IvyNode> { /** * After the call node may be discarded. To avoid using discarded node, make sure to get the - * real node after the call IvyNode node = ... node.loadData(); node = node.getRealNode(); ... + * real node after the call + * <code>IvyNode node = ... node.loadData(); node = node.getRealNode(); ...</code> + * + * @param rootModuleConf String + * @param parent IvyNode + * @param parentConf String + * @param conf String + * @param shouldBePublic boolean + * @param usage IvyNodeUsage + * @return boolean */ public boolean loadData(String rootModuleConf, IvyNode parent, String parentConf, String conf, boolean shouldBePublic, IvyNodeUsage usage) { @@ -312,7 +321,7 @@ public class IvyNode implements Comparable<IvyNode> { * Load the dependencies of the current node * <p> * The resulting collection of nodes may have some configuration to load - * + * * @param rootModuleConf * the requested configuration of the root module * @param conf @@ -515,7 +524,7 @@ public class IvyNode implements Comparable<IvyNode> { /** * returns the required configurations from the given node - * + * * @param in IvyNode * @param inConf ditto * @return array of configuration names @@ -537,7 +546,7 @@ public class IvyNode implements Comparable<IvyNode> { /** * returns all the current required configurations of the node - * + * * @return array of configuration names */ public String[] getRequiredConfigurations() { @@ -564,7 +573,7 @@ public class IvyNode implements Comparable<IvyNode> { /** * Returns the configurations of the dependency required in a given root module configuration. - * + * * @param rootModuleConf String * @return array of configuration names */ @@ -620,7 +629,7 @@ public class IvyNode implements Comparable<IvyNode> { /** * Returns the root module configurations in which this dependency is required - * + * * @return array of configuration names */ public String[] getRootModuleConfigurations() { @@ -630,7 +639,7 @@ public class IvyNode implements Comparable<IvyNode> { /** * Returns the root module configurations in which this dependency is required - * + * * @return {@link Set} of configuration names */ public Set<String> getRootModuleConfigurationsSet() { @@ -675,7 +684,7 @@ public class IvyNode implements Comparable<IvyNode> { /** * Finds and returns a path in callers from the given module id to the current node - * + * * @param from * the module id to start the path from * @return a collection representing the path, starting with the from node, followed by the list @@ -707,7 +716,7 @@ public class IvyNode implements Comparable<IvyNode> { /** * Update data in this node from data of the given node, for the given root module * configuration. - * + * * @param node * the source node from which data should be copied * @param rootModuleConf @@ -748,7 +757,7 @@ public class IvyNode implements Comparable<IvyNode> { /** * Returns all the artifacts of this dependency required in all the root module configurations - * + * * @return array of {@link Artifact}s */ public Artifact[] getAllArtifacts() { @@ -762,7 +771,7 @@ public class IvyNode implements Comparable<IvyNode> { /** * Returns all the artifacts of this dependency required in the root module configurations in * which the node is not evicted nor blacklisted - * + * * @param artifactFilter Filter * @return array of {@link Artifact}s */ @@ -780,7 +789,7 @@ public class IvyNode implements Comparable<IvyNode> { /** * Returns the artifacts of this dependency required in the configurations themselves required * in the given root module configuration - * + * * @param rootModuleConf String * @return array of {@link Artifact}s */ @@ -995,7 +1004,7 @@ public class IvyNode implements Comparable<IvyNode> { /** * Returns the last modified timestamp of the module represented by this Node, or 0 if the last * modified timestamp is currently unknown (module not loaded) - * + * * @return the last modified timestamp of the module represented by this Node */ public long getLastModified() { @@ -1085,7 +1094,13 @@ public class IvyNode implements Comparable<IvyNode> { // EVICTION MANAGEMENT // ///////////////////////////////////////////////////////////////////////////// - /** A copy of the set of resolved nodes (real nodes) */ + /** + * A copy of the set of resolved nodes (real nodes) + * + * @param moduleId ditto + * @param rootModuleConf String + * @return Set<IvyNode> + */ public Set<IvyNode> getResolvedNodes(ModuleId moduleId, String rootModuleConf) { return eviction.getResolvedNodes(moduleId, rootModuleConf); } @@ -1190,7 +1205,7 @@ public class IvyNode implements Comparable<IvyNode> { /** * Returns a collection of Nodes in conflict for which conflict has been detected but conflict * resolution hasn't been done yet - * + * * @param rootModuleConf ditto * @param mid * the module id for which pending conflicts should be found @@ -1217,7 +1232,7 @@ public class IvyNode implements Comparable<IvyNode> { * implementation which use a best effort strategy to find compatible dependency set, like * {@link LatestCompatibleConflictManager} * </p> - * + * * @param bdata * the root module configuration in which the node should be blacklisted */ @@ -1255,10 +1270,10 @@ public class IvyNode implements Comparable<IvyNode> { * <p> * A blacklisted node should be considered as if it doesn't even exist on the repository. * </p> - * + * * @param rootModuleConf * the root module conf for which we'd like to know if the node is blacklisted - * + * * @return true if this node is blacklisted int he given root module conf, false otherwise * @see #blacklist(IvyNodeBlacklist) */ @@ -1268,7 +1283,7 @@ public class IvyNode implements Comparable<IvyNode> { /** * Indicates if this node has been blacklisted in all root module configurations. - * + * * @return true if this node is blacklisted in all root module configurations, false otherwise * @see #blacklist(IvyNodeBlacklist) */ @@ -1287,7 +1302,7 @@ public class IvyNode implements Comparable<IvyNode> { /** * Returns the blacklist data of this node in the given root module conf, or <code>null</code> * if this node is not blacklisted in this root module conf. - * + * * @param rootModuleConf * the root module configuration to consider * @return the blacklist data if any @@ -1308,7 +1323,7 @@ public class IvyNode implements Comparable<IvyNode> { * given root module conf which has a dependency descriptor with transitive == true, then it * returns true. Otherwise it returns false. * </p> - * + * * @param rootModuleConf * the root module configuration to consider * @return true if there is any merged usage with transitive dd, false otherwise. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/resolve/IvyNodeCallers.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/resolve/IvyNodeCallers.java b/src/java/org/apache/ivy/core/resolve/IvyNodeCallers.java index e5f5966..f9c6d57 100644 --- a/src/java/org/apache/ivy/core/resolve/IvyNodeCallers.java +++ b/src/java/org/apache/ivy/core/resolve/IvyNodeCallers.java @@ -154,6 +154,7 @@ public class IvyNodeCallers { * @param rootModuleConf ditto * @param callerNode IvyNode * @param callerConf ditto + * @param requestedConf ditto * @param dependencyConfs * '*' must have been resolved * @param dd @@ -251,7 +252,7 @@ public class IvyNodeCallers { /** * Returns true if ALL callers exclude the given artifact in the given root module conf - * + * * @param rootModuleConf ditto * @param artifact Artifact * @return boolean http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/resolve/IvyNodeEviction.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/resolve/IvyNodeEviction.java b/src/java/org/apache/ivy/core/resolve/IvyNodeEviction.java index 940dfa1..3524f21 100644 --- a/src/java/org/apache/ivy/core/resolve/IvyNodeEviction.java +++ b/src/java/org/apache/ivy/core/resolve/IvyNodeEviction.java @@ -54,7 +54,7 @@ public class IvyNodeEviction { /** * Creates a new object containing the eviction data of an {@link IvyNode}. - * + * * @param rootModuleConf * the root module configuration * @param parent @@ -73,7 +73,7 @@ public class IvyNodeEviction { /** * Creates a new object containing the eviction data of an {@link IvyNode}. - * + * * @param rootModuleConf * the root module configuration * @param parent @@ -197,6 +197,8 @@ public class IvyNodeEviction { } /** + * @param mid ModuleId + * @param rootModuleConf String * @return A copy of the set of resolved nodes (real nodes) */ public Set<IvyNode> getResolvedNodes(ModuleId mid, String rootModuleConf) { @@ -337,7 +339,7 @@ public class IvyNodeEviction { /** * Returns null if this node has only be evicted transitively, or the the collection of selected * nodes if it has been evicted by other selected nodes - * + * * @return Collection<IvyNode> */ public Collection<IvyNode> getAllEvictingNodes() { @@ -385,7 +387,7 @@ public class IvyNodeEviction { * Returns the eviction data for this node if it has been previously evicted in the root, null * otherwise (if it hasn't been evicted in root) for the given rootModuleConf. Note that this * method only works if conflict resolution has already be done in all the ancestors. - * + * * @param rootModuleConf ditto * @param ancestor IvyNode * @return EvictionData http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/resolve/ResolveEngine.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/resolve/ResolveEngine.java b/src/java/org/apache/ivy/core/resolve/ResolveEngine.java index 7c0a11a..8356f16 100644 --- a/src/java/org/apache/ivy/core/resolve/ResolveEngine.java +++ b/src/java/org/apache/ivy/core/resolve/ResolveEngine.java @@ -76,7 +76,7 @@ import org.apache.ivy.util.filter.Filter; * {@link #resolve(URL)} which allow to simply resolve dependencies of a single module descriptor, * or more complete one, like the {@link #resolve(ModuleDescriptor, ResolveOptions)} which allows to * provide options to the resolution engine. - * + * * @see ResolveOptions */ public class ResolveEngine { @@ -92,7 +92,7 @@ public class ResolveEngine { /** * Constructs a ResolveEngine. - * + * * @param settings * the settings to use to configure the engine. Must not be null. * @param eventManager @@ -112,7 +112,7 @@ public class ResolveEngine { /** * Returns the currently configured dictator resolver, which when non null is used in place of * any specified resolver in the {@link IvySettings} - * + * * @return the currently configured dictator resolver, may be null. */ public DependencyResolver getDictatorResolver() { @@ -122,7 +122,7 @@ public class ResolveEngine { /** * Sets a dictator resolver, which is used in place of regular dependency resolver for * subsequent dependency resolution by this engine. - * + * * @param dictatorResolver * the dictator resolver to use in this engine, null if regular settings should used */ @@ -142,6 +142,13 @@ public class ResolveEngine { /** * Resolves the module identified by the given mrid with its dependencies if transitive is set * to true. + * + * @param mrid ModuleRevisionId + * @param options ResolveOptions + * @param changing boolean + * @return ResolveReport + * @throws ParseException if something goes wrong + * @throws IOException if something goes wrong */ public ResolveReport resolve(final ModuleRevisionId mrid, ResolveOptions options, boolean changing) throws ParseException, IOException { @@ -176,6 +183,12 @@ public class ResolveEngine { /** * Resolve dependencies of a module described by an ivy file. + * + * @param ivySource URL + * @param options ResolveOptions + * @return ResolveReport + * @throws ParseException if something goes wrong + * @throws IOException if something goes wrong */ public ResolveReport resolve(URL ivySource, ResolveOptions options) throws ParseException, IOException { @@ -197,6 +210,11 @@ public class ResolveEngine { /** * Resolve dependencies of a module described by a module descriptor. + * @param md ModuleDescriptor + * @param options ResolveOptions + * @return ResolveReport + * @throws ParseException if something goes wrong + * @throws IOException if something goes wrong */ public ResolveReport resolve(ModuleDescriptor md, ResolveOptions options) throws ParseException, IOException { @@ -434,9 +452,10 @@ public class ResolveEngine { * It is possible to track the progression of the download using classical ivy progress * monitoring feature (see addTransferListener). * </p> - * + * * @param artifact * the artifact to download + * @param options DownloadOptions * @return a report concerning the download * @see #download(ArtifactOrigin, DownloadOptions) */ @@ -449,7 +468,7 @@ public class ResolveEngine { /** * Locates an artifact in dependency resolvers, and return its location if it can be located and * actually exists, or an unknown {@link ArtifactOrigin} in other cases. - * + * * @param artifact * the artifact to locate. * @return the artifact location, should be tested with @@ -475,9 +494,10 @@ public class ResolveEngine { * It is possible to track the progression of the download using classical ivy progress * monitoring feature (see addTransferListener). * </p> - * + * * @param origin * the artifact origin to materialize + * @param options DownloadOptions * @return a report concerning the download * @see #download(Artifact, DownloadOptions) * @see #locate(Artifact) @@ -492,7 +512,7 @@ public class ResolveEngine { * Resolve the dependencies of a module without downloading corresponding artifacts. The module * to resolve is given by its ivy file URL. This method requires appropriate configuration of * the ivy instance, especially resolvers. - * + * * @param ivySource * url of the ivy file to use for dependency resolving * @param options @@ -517,7 +537,7 @@ public class ResolveEngine { * <p> * The <code>IvyNode</code>s are ordered from the most dependent to the less dependent, so that * an IvyNode is always found in the list after all IvyNode depending directly on it. - * + * * @param md * the descriptor of the module for which we want to get dependencies - must not be * null @@ -817,7 +837,7 @@ public class ResolveEngine { /** * Returns true if we've already fetched the dependencies for this node and configuration - * + * * @param node * node to check * @param conf @@ -847,11 +867,12 @@ public class ResolveEngine { /** * Resolves conflict for the given node in the given ancestor. This method do conflict * resolution in ancestor parents recursively, unless not necessary. - * + * * @param node * the node for which conflict resolution should be done * @param ancestor * the ancestor in which the conflict resolution should be done + * @param conf String * @param toevict * a collection of IvyNode to evict (as computed by conflict resolution in * descendants of ancestor) @@ -1033,7 +1054,7 @@ public class ResolveEngine { /** * Compute possible conflicts for a node, in the context of an ancestor (a node which has a * dependency - direct or indirect - on the node for which conflicts should be computed. - * + * * @param node * the node for which conflicts should be computed * @param ancestor @@ -1159,7 +1180,7 @@ public class ResolveEngine { * The mediated dependency descriptor must return the actually requested module revision id when * the method {@link DependencyDescriptor#getDependencyRevisionId()} is called. * </p> - * + * * @param dd * the dependency descriptor for which the requested module revision id should be * returned http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/resolve/ResolveOptions.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/resolve/ResolveOptions.java b/src/java/org/apache/ivy/core/resolve/ResolveOptions.java index f71b015..c492a4e 100644 --- a/src/java/org/apache/ivy/core/resolve/ResolveOptions.java +++ b/src/java/org/apache/ivy/core/resolve/ResolveOptions.java @@ -29,7 +29,7 @@ import org.apache.ivy.util.filter.FilterHelper; /** * A set of options used during resolve related tasks - * + * * @see ResolveEngine */ public class ResolveOptions extends LogOptions { @@ -153,7 +153,7 @@ public class ResolveOptions extends LogOptions { /** * Returns the resolve mode to use, or <code>null</code> to use settings configured resolve * mode. - * + * * @return the resolve mode to use. */ public String getResolveMode() { @@ -169,7 +169,8 @@ public class ResolveOptions extends LogOptions { * Indicates if the configurations use a special configuration * , *(private) or *(public). When * special configurations are used, you must have the module descriptor in order to get the list * of configurations. - * + * + * @return boolean * @see #getConfs() * @see #getConfs(ModuleDescriptor) */ @@ -185,6 +186,7 @@ public class ResolveOptions extends LogOptions { /** * @pre can only be called if useSpecialConfs()==false. When it is true, you have to provide a * module descriptor so that configurations can be resolved. + * @return String[] * @see #getConfs(ModuleDescriptor) */ public String[] getConfs() { @@ -197,10 +199,11 @@ public class ResolveOptions extends LogOptions { /** * Get the asked confs. Special confs (like *) use the moduleDescriptor to find the values * - * + * * @param md * Used to get the exact values for special confs. - * */ + * @return String[] + */ public String[] getConfs(ModuleDescriptor md) { // TODO add isInline, in that case, replace * by *(public). return ConfigurationUtils.replaceWildcards(confs, md); http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/resolve/VisitNode.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/resolve/VisitNode.java b/src/java/org/apache/ivy/core/resolve/VisitNode.java index c38bce1..b5171b9 100644 --- a/src/java/org/apache/ivy/core/resolve/VisitNode.java +++ b/src/java/org/apache/ivy/core/resolve/VisitNode.java @@ -40,11 +40,11 @@ import org.apache.ivy.util.Checks; * dependency graph following the dependencies, thus the same node can be visited several times, if * it is requested from several module. In this case you will have one VisitNode per parent and per * root module configuration. Thus VisitNode stores data specific to the visit: - * <ul> - * <li>parent</li> the node from which the visit is occurring - * <li>parentConf</li> the configuration of the parent in which this node is visited - * <li>rootModuleConf</li> the configuration of the root module which is currently resolved - * </ul> + * <dl> + * <dd>parent</dd><dt>the node from which the visit is occurring</dt> + * <dd>parentConf</dd><dt>the configuration of the parent in which this node is visited</dt> + * <dd>rootModuleConf</dd><dt>the configuration of the root module which is currently resolved</dt> + * </dl> */ public class VisitNode { /** @@ -152,7 +152,7 @@ public class VisitNode { /** * Get an ordered collection with the nodes from the root to this node - * + * * @return Collection<VisitNode> */ public Collection<VisitNode> getPath() { @@ -211,7 +211,7 @@ public class VisitNode { /** * Returns true if the current dependency descriptor is transitive and the parent configuration * is transitive. Otherwise returns false. - * + * * @return true if current node is transitive and the parent configuration is transitive. */ public boolean isTransitive() { @@ -255,7 +255,7 @@ public class VisitNode { * resolved to an existing node in the graph, we will return the existing node, and not the one * originally used which is about to be discarded, since it's not possible to have in the graph * two nodes for the same ModuleRevisionId - * + * * @return the 'real' node currently visited. */ public IvyNode getRealNode() { @@ -313,7 +313,7 @@ public class VisitNode { /** * Returns a VisitNode for the given node. The given node must be a representation of the same * module (usually in another revision) as the one visited by this node. - * + * * @param node * the node to visit * @return a VisitNode for the given node @@ -413,7 +413,7 @@ public class VisitNode { /** * Returns true if this node can already be found in the path - * + * * @return boolean */ public boolean isCircular() { @@ -461,7 +461,7 @@ public class VisitNode { /** * Marks the current node as evicted by the the given selected IvyNodes, in the given parent and * root module configuration, with the given {@link ConflictManager} - * + * * @param parent * the VisitNode in which eviction has been made * @param conflictMgr http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/retrieve/RetrieveEngine.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/retrieve/RetrieveEngine.java b/src/java/org/apache/ivy/core/retrieve/RetrieveEngine.java index 0e0d68c..4822e89 100644 --- a/src/java/org/apache/ivy/core/retrieve/RetrieveEngine.java +++ b/src/java/org/apache/ivy/core/retrieve/RetrieveEngine.java @@ -71,7 +71,12 @@ public class RetrieveEngine { * localCacheDirectory to determine an ivy report file, used as input for the copy If such a * file does not exist for any conf (resolve has not been called before ?) then an * IllegalStateException is thrown and nothing is copied. - * + * + * @param mrid ModuleRevisionId + * @param destFilePattern String + * @param options RetrieveOptions + * @return int + * @throws IOException if something goes wrong * @deprecated Use * {@link #retrieve(org.apache.ivy.core.module.id.ModuleRevisionId, RetrieveOptions)} * instead @@ -485,7 +490,7 @@ public class RetrieveEngine { /** * The returned comparator should consider greater the artifact which gains the conflict battle. * This is used only during retrieve... prefer resolve conflict manager to resolve conflicts. - * + * * @return Comparator<ArtifactDownloadReport> */ private Comparator<ArtifactDownloadReport> getConflictResolvingPolicy() { http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/retrieve/RetrieveReport.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/retrieve/RetrieveReport.java b/src/java/org/apache/ivy/core/retrieve/RetrieveReport.java index bff2007..6dcb9fd 100644 --- a/src/java/org/apache/ivy/core/retrieve/RetrieveReport.java +++ b/src/java/org/apache/ivy/core/retrieve/RetrieveReport.java @@ -38,6 +38,8 @@ public class RetrieveReport { /** * Returns the root directory to where the artifacts are retrieved. + * + * @return File */ public File getRetrieveRoot() { return retrieveRoot; @@ -68,6 +70,8 @@ public class RetrieveReport { /** * Returns a collection of <tt>File</tt> objects who were actually copied during the retrieve * process. + * + * @return Collection<File> */ public Collection<File> getCopiedFiles() { return new ArrayList<File>(copiedFiles); @@ -76,6 +80,8 @@ public class RetrieveReport { /** * Returns a collection of <tt>File</tt> objects who were actually copied during the retrieve * process. + * + * @return Collection<File> */ public Collection<File> getUpToDateFiles() { return new ArrayList<File>(upToDateFiles); @@ -84,6 +90,8 @@ public class RetrieveReport { /** * Returns a collection of <tt>File</tt> objects who were retrieved during the retrieve process. * This is the union of the files being copied and the files that were up-to-date. + * + * @return Collection<File> */ public Collection<File> getRetrievedFiles() { Collection<File> result = new ArrayList<File>(upToDateFiles.size() + copiedFiles.size()); @@ -94,6 +102,8 @@ public class RetrieveReport { /** * Get the mapping between the copied files and their corresponding download report + * + * @return Map<File,ArtifactDownloadReport> */ public Map<File, ArtifactDownloadReport> getDownloadReport() { return downloadReport; http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/search/SearchEngine.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/search/SearchEngine.java b/src/java/org/apache/ivy/core/search/SearchEngine.java index 537566f..3fde263 100644 --- a/src/java/org/apache/ivy/core/search/SearchEngine.java +++ b/src/java/org/apache/ivy/core/search/SearchEngine.java @@ -50,10 +50,10 @@ public class SearchEngine { /** * Returns an empty array when no token values are found. - * + * * @param token * ditto - * @param otherTokenValues + * @param otherTokenValues Map * @return String[] */ public String[] listTokenValues(String token, Map<String, Object> otherTokenValues) { @@ -177,10 +177,9 @@ public class SearchEngine { * <p> * ModuleId are returned in the system namespace. * </p> - * - * @param moduleCrit - * ModuleId - * @param matcher + * + * @param moduleCrit ModuleId + * @param matcher PatternMatcher * @return ModuleId[] */ public ModuleId[] listModules(ModuleId moduleCrit, PatternMatcher matcher) { @@ -214,10 +213,9 @@ public class SearchEngine { * <p> * ModuleRevisionId are returned in the system namespace. * </p> - * - * @param moduleCrit - * ModuleRevisionId - * @param matcher + * + * @param moduleCrit ModuleRevisionId + * @param matcher PatternMatcher * @return ModuleRevisionId[] */ public ModuleRevisionId[] listModules(ModuleRevisionId moduleCrit, PatternMatcher matcher) { @@ -269,7 +267,7 @@ public class SearchEngine { * <p> * ModuleRevisionId are returned in the system namespace. * </p> - * + * * @param resolver * the resolver in which modules should looked up * @param moduleCrit http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/settings/IvySettings.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/settings/IvySettings.java b/src/java/org/apache/ivy/core/settings/IvySettings.java index 89c68ef..4b07c0b 100644 --- a/src/java/org/apache/ivy/core/settings/IvySettings.java +++ b/src/java/org/apache/ivy/core/settings/IvySettings.java @@ -420,8 +420,8 @@ public class IvySettings implements SortEngineSettings, PublishEngineSettings, P * Default initialization of settings, useful when you don't want to load your settings from a * settings file or URL, but prefer to set them manually. By calling this method you will still * have the basic initialization done when loading settings. - * - * @throws IOException + * + * @throws IOException if something goes wrong */ public synchronized void defaultInit() throws IOException { if (getVariable("ivy.default.ivy.user.dir") != null) { @@ -491,7 +491,7 @@ public class IvySettings implements SortEngineSettings, PublishEngineSettings, P /** * Sets a deprecated variable with the value of the new variable - * + * * @param deprecatedKey * the deprecated variable name * @param newKey @@ -611,7 +611,7 @@ public class IvySettings implements SortEngineSettings, PublishEngineSettings, P /** * Substitute variables in the given string by their value found in the current set of variables - * + * * @param str * the string in which substitution should be made * @return the string where all current ivy variables have been substituted by their value If @@ -624,7 +624,7 @@ public class IvySettings implements SortEngineSettings, PublishEngineSettings, P /** * Substitute variables in the given map values by their value found in the current set of * variables - * + * * @param strings * the map of strings in which substitution should be made * @return a new map of strings in which all current ivy variables in values have been @@ -641,7 +641,7 @@ public class IvySettings implements SortEngineSettings, PublishEngineSettings, P /** * Returns the variables loaded in configuration file. Those variables may better be seen as ant * properties - * + * * @return IvyVariableContainer */ public synchronized IvyVariableContainer getVariables() { @@ -775,6 +775,13 @@ public class IvySettings implements SortEngineSettings, PublishEngineSettings, P /** * regular expressions as explained in Pattern class may be used in attributes + * + * @param attributes Map + * @param matcher PatternMatcher + * @param resolverName String + * @param branch String + * @param conflictManager String + * @param resolveMode String */ public synchronized void addModuleConfiguration(Map<String, String> attributes, PatternMatcher matcher, String resolverName, String branch, String conflictManager, @@ -789,12 +796,12 @@ public class IvySettings implements SortEngineSettings, PublishEngineSettings, P * <p> * If the specified file name is relative it is resolved with respect to the settings's base * directory. - * + * * @param fileName * The name of the file to resolve. Must not be <code>null</code>. - * + * * @return the resolved File. - * + * */ public synchronized File resolveFile(String fileName) { return FileUtil.resolveFile(baseDir, fileName); @@ -1211,7 +1218,7 @@ public class IvySettings implements SortEngineSettings, PublishEngineSettings, P /** * Filters the names list by removing all names that should be ignored as defined by the listing * ignore list - * + * * @param names ditto */ public synchronized void filterIgnore(Collection<String> names) { @@ -1443,7 +1450,7 @@ public class IvySettings implements SortEngineSettings, PublishEngineSettings, P /** * Use a different variable container. - * + * * @param variables IvyVariableContainer */ public synchronized void setVariableContainer(IvyVariableContainer variables) { @@ -1490,7 +1497,7 @@ public class IvySettings implements SortEngineSettings, PublishEngineSettings, P /** * Validates the settings, throwing an {@link IllegalStateException} if the current state is not * valid. - * + * * @throws IllegalStateException * if the settings is not valid. */ @@ -1508,7 +1515,7 @@ public class IvySettings implements SortEngineSettings, PublishEngineSettings, P /** * Validates all {@link Validatable} objects in the collection. - * + * * @param values * the collection of objects to validate. * @throws IllegalStateException http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/sort/CollectionOfModulesToSort.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/sort/CollectionOfModulesToSort.java b/src/java/org/apache/ivy/core/sort/CollectionOfModulesToSort.java index 1f335b9..93e228b 100644 --- a/src/java/org/apache/ivy/core/sort/CollectionOfModulesToSort.java +++ b/src/java/org/apache/ivy/core/sort/CollectionOfModulesToSort.java @@ -32,8 +32,10 @@ import org.apache.ivy.plugins.version.VersionMatcher; /** * Wrap a collection of descriptors wrapped themselves in ModuleInSort elements. It contains some - * dedicated function to retrieve module descriptors based on dependencies descriptors.<br> + * dedicated function to retrieve module descriptors based on dependencies descriptors. + * <p> * <i>This class is designed to be used internally by the ModuleDescriptorSorter.</i> + * </p> */ class CollectionOfModulesToSort implements Iterable<ModuleInSort> { @@ -86,7 +88,7 @@ class CollectionOfModulesToSort implements Iterable<ModuleInSort> { /** * Find a matching module descriptor in the list of module to sort. - * + * * @param descriptor ditto * @return a ModuleDescriptor from the collection of module descriptors to sort. If none exists * returns null. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/sort/ModuleDescriptorSorter.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/sort/ModuleDescriptorSorter.java b/src/java/org/apache/ivy/core/sort/ModuleDescriptorSorter.java index da0fb3b..330f302 100644 --- a/src/java/org/apache/ivy/core/sort/ModuleDescriptorSorter.java +++ b/src/java/org/apache/ivy/core/sort/ModuleDescriptorSorter.java @@ -29,10 +29,12 @@ import org.apache.ivy.plugins.version.VersionMatcher; import org.apache.ivy.util.Message; /** - * Inner helper class for sorting ModuleDescriptors.<br> + * Inner helper class for sorting ModuleDescriptors. + * <p> * ModuleDescriptorSorter use CollectionOfModulesToSort to find the dependencies of the modules, and * use ModuleInSort to store some temporary values attached to the modules to sort. - * + * </p> + * * @see ModuleInSort * @see CollectionOfModulesToSort */ @@ -54,9 +56,9 @@ public class ModuleDescriptorSorter { /** * Iterates over all modules calling sortModuleDescriptorsHelp. - * + * * @return sorted module - * @throws CircularDependencyException + * @throws CircularDependencyException somehow */ public List<ModuleDescriptor> sortModuleDescriptors() throws CircularDependencyException { Message.debug("Nbr of module to sort : " + moduleDescriptors.size()); @@ -73,10 +75,10 @@ public class ModuleDescriptorSorter { * When a loop is detected by a recursive call, the moduleDescriptors are not added immediately * added to the sorted list. They are added as loop dependencies of the root, and will be added * to the sorted list only when the root itself will be added. - * + * * @param current * Current module to add to sorted list. - * @throws CircularDependencyException + * @throws CircularDependencyException somehow */ private void sortModuleDescriptorsHelp(ModuleInSort current, ModuleInSort caller) throws CircularDependencyException { http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/sort/ModuleInSort.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/sort/ModuleInSort.java b/src/java/org/apache/ivy/core/sort/ModuleInSort.java index 225ee88..686504e 100644 --- a/src/java/org/apache/ivy/core/sort/ModuleInSort.java +++ b/src/java/org/apache/ivy/core/sort/ModuleInSort.java @@ -31,18 +31,21 @@ import org.apache.ivy.util.Message; /** * Decorates a ModuleDescriptor with some attributes used during the sort. Thus every instance of a - * ModuleInSort can be used in only one ModuleDescriptorSorter at a time.<br> - * The added fields are : <br> + * ModuleInSort can be used in only one ModuleDescriptorSorter at a time. + * <p> + * The added fields are: + * </p> * <ul> - * <li><code>isSorted</code> : is true iff this module has already been added to the sorted list. - * </li> + * <li><code>isSorted</code> : is true iff this module has already been added to the sorted + * list.</li> * <li><code>loopElements</code> : When the module is the root of a loop (=the first element of a * loop met during the sort), <code>loopElements</code> contains all ModuleInSort of the loop * (excluding the root itself.</li> * <li><code>isLoopIntermediateElement</code> : When a loop is detected, all modules included in the * loop (except the root) have <code>isLoopIntermediateElement</code> set to true.</li> * <li><code>caller</code> : During the sort, we traverse recursively the graph. When doing that, - * caller point to the parent element. + * caller point to the parent element.</li> + * </ul> */ class ModuleInSort { @@ -103,7 +106,7 @@ class ModuleInSort { * dependency. If it is, all the elements of the loop are flagged as 'loopIntermediateElement', * and the loopElements of this module (which is the root of the loop) is updated. The * depStrategy is invoked on order to report a correct circular loop message. - * + * * @param futurCaller ModuleInSort * @param depStrategy CircularDependencyStrategy * @return true if a loop is detected. @@ -130,7 +133,7 @@ class ModuleInSort { * Add this module to the sorted list except if this module is an intermediary element of a * loop. If this module is the 'root' of a loop, then all elements of that loops are added * before. - * + * * @param sorted * The list of sorted elements on which this module will be added */ http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/osgi/core/BundleInfoAdapter.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/osgi/core/BundleInfoAdapter.java b/src/java/org/apache/ivy/osgi/core/BundleInfoAdapter.java index c97d966..2545de1 100644 --- a/src/java/org/apache/ivy/osgi/core/BundleInfoAdapter.java +++ b/src/java/org/apache/ivy/osgi/core/BundleInfoAdapter.java @@ -77,11 +77,14 @@ public class BundleInfoAdapter { } /** - * + * @param parser ModuleDescriptorParser * @param baseUri * uri to help build the absolute url if the bundle info has a relative uri. + * @param bundle BundleInfo + * @param manifest Manifest + * @param profileProvider ExecutionEnvironmentProfileProvider * @return DefaultModuleDescriptor ditto - * @throws ProfileNotFoundException + * @throws ProfileNotFoundException if descriptor is not found */ public static DefaultModuleDescriptor toModuleDescriptor(ModuleDescriptorParser parser, URI baseUri, BundleInfo bundle, Manifest manifest,
