You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ant.apache.org by jh...@apache.org on 2017/06/03 16:17:04 UTC
[09/18] ant-ivy git commit: Checkstyle-driven cleanup (whitespace,
javadoc, JLS)
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/event/resolve/EndResolveDependencyEvent.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/event/resolve/EndResolveDependencyEvent.java b/src/java/org/apache/ivy/core/event/resolve/EndResolveDependencyEvent.java
index 3f01d10..66a8843 100644
--- a/src/java/org/apache/ivy/core/event/resolve/EndResolveDependencyEvent.java
+++ b/src/java/org/apache/ivy/core/event/resolve/EndResolveDependencyEvent.java
@@ -65,7 +65,7 @@ public class EndResolveDependencyEvent extends ResolveDependencyEvent {
* dependency management. It's basically the time elapsed since the corresponding
* {@link StartResolveDependencyEvent}
* </p>
- *
+ *
* @return the time elapsed to resolve the dependency.
*/
public long getDuration() {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/event/retrieve/EndRetrieveEvent.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/event/retrieve/EndRetrieveEvent.java b/src/java/org/apache/ivy/core/event/retrieve/EndRetrieveEvent.java
index ad0514b..b38781f 100644
--- a/src/java/org/apache/ivy/core/event/retrieve/EndRetrieveEvent.java
+++ b/src/java/org/apache/ivy/core/event/retrieve/EndRetrieveEvent.java
@@ -47,7 +47,7 @@ public class EndRetrieveEvent extends RetrieveEvent {
/**
* Duration of the retrieve operation, in ms.
- *
+ *
* @return Duration of the retrieve operation, in ms.
*/
public long getDuration() {
@@ -56,7 +56,7 @@ public class EndRetrieveEvent extends RetrieveEvent {
/**
* Number of artifacts which were copied (or symlinked) during the retrieve
- *
+ *
* @return Number of artifacts which were copied during the retrieve.
*/
public int getNbCopied() {
@@ -65,7 +65,7 @@ public class EndRetrieveEvent extends RetrieveEvent {
/**
* Number of artifacts which were not copied since they were already present and up to date.
- *
+ *
* @return Number of artifacts which were not copied since they were already present and up to
* date.
*/
@@ -75,7 +75,7 @@ public class EndRetrieveEvent extends RetrieveEvent {
/**
* Total size of all copied (or symlinked) artifacts, in bytes.
- *
+ *
* @return Total size of all copied (or symlinked) artifacts, in bytes.
*/
public long getTotalCopiedSize() {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/module/descriptor/AbstractIncludeExcludeRule.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/module/descriptor/AbstractIncludeExcludeRule.java b/src/java/org/apache/ivy/core/module/descriptor/AbstractIncludeExcludeRule.java
index 607690c..6c29ad2 100644
--- a/src/java/org/apache/ivy/core/module/descriptor/AbstractIncludeExcludeRule.java
+++ b/src/java/org/apache/ivy/core/module/descriptor/AbstractIncludeExcludeRule.java
@@ -69,7 +69,7 @@ public abstract class AbstractIncludeExcludeRule extends UnmodifiableExtendableI
/**
* Add a configuration for this rule
- *
+ *
* @param conf String
*/
public void addConfiguration(String conf) {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/module/descriptor/Artifact.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/module/descriptor/Artifact.java b/src/java/org/apache/ivy/core/module/descriptor/Artifact.java
index 3797839..648e374 100644
--- a/src/java/org/apache/ivy/core/module/descriptor/Artifact.java
+++ b/src/java/org/apache/ivy/core/module/descriptor/Artifact.java
@@ -33,28 +33,28 @@ public interface Artifact extends ExtendableItem {
/**
* Returns the resolved module revision id for this artifact
- *
+ *
* @return the resolved module revision id.
*/
ModuleRevisionId getModuleRevisionId();
/**
* Returns the resolved publication date for this artifact
- *
+ *
* @return the resolved publication date. Never null.
*/
Date getPublicationDate();
/**
* Return the name of the artifact, generally 'part' of the basename of the file.
- *
+ *
* @return the name of the artifact. Never null.
*/
String getName();
/**
* Returns the type of the artifact, typically 'jar', 'source', 'javadoc', 'debian', ...
- *
+ *
* @return the type of the artifact. Never null.
*/
String getType();
@@ -62,7 +62,7 @@ public interface Artifact extends ExtendableItem {
/**
* Retrieve the extension of the artifact. The extension is without dot (ie. 'jar' and not
* '.jar')
- *
+ *
* @return the extension of the artifact. Never null.
*/
String getExt();
@@ -70,21 +70,21 @@ public interface Artifact extends ExtendableItem {
/**
* Returns the url at which this artifact can be found independently of ivy configuration. This
* can be null (and is usually for standard artifacts)
- *
+ *
* @return url at which this artifact can be found independently of ivy configuration
*/
URL getUrl();
/**
* Returns the list of configurations where this artifact is associated to.
- *
+ *
* @return the list of configuration this artifact is associated to. Never null.
*/
String[] getConfigurations();
/**
* Return the specific identifier of this artifact.
- *
+ *
* @return the id of the artifact
*/
ArtifactRevisionId getId();
@@ -92,7 +92,7 @@ public interface Artifact extends ExtendableItem {
/**
* Returns true if this artifact represents a module metadata artifact, false if it's a
* published artifact
- *
+ *
* @return true if this artifact represents a module metadata artifact, false if it's a
* published artifact
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/module/descriptor/Configuration.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/module/descriptor/Configuration.java b/src/java/org/apache/ivy/core/module/descriptor/Configuration.java
index 88061d0..cb808dc 100644
--- a/src/java/org/apache/ivy/core/module/descriptor/Configuration.java
+++ b/src/java/org/apache/ivy/core/module/descriptor/Configuration.java
@@ -86,7 +86,7 @@ public class Configuration extends DefaultExtendableItem implements InheritableI
/**
* Creates a new configuration.
- *
+ *
* @param name
* the name of the configuration
*/
@@ -102,7 +102,7 @@ public class Configuration extends DefaultExtendableItem implements InheritableI
/**
* Creates a new configuration.
- *
+ *
* @param name
* the name of the configuration
* @param visibility
@@ -150,7 +150,7 @@ public class Configuration extends DefaultExtendableItem implements InheritableI
/**
* Returns the deprecation message, or <tt>null</tt> if not specified.
- *
+ *
* @return Returns the deprecation message.
*/
public String getDeprecated() {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/module/descriptor/ConfigurationAware.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/module/descriptor/ConfigurationAware.java b/src/java/org/apache/ivy/core/module/descriptor/ConfigurationAware.java
index 2982f7a..38bc6eb 100644
--- a/src/java/org/apache/ivy/core/module/descriptor/ConfigurationAware.java
+++ b/src/java/org/apache/ivy/core/module/descriptor/ConfigurationAware.java
@@ -24,14 +24,14 @@ package org.apache.ivy.core.module.descriptor;
public interface ConfigurationAware {
/**
* Returns the configurations of the module to which the object is attached
- *
+ *
* @return an array of configuration names to which the object is attached
*/
public String[] getConfigurations();
/**
* Tells this object that it will now be part of the given configuration
- *
+ *
* @param confName
* the name of the configuration to which the object is now attached
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/module/descriptor/ConfigurationGroup.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/module/descriptor/ConfigurationGroup.java b/src/java/org/apache/ivy/core/module/descriptor/ConfigurationGroup.java
index e532ebd..5f827a7 100644
--- a/src/java/org/apache/ivy/core/module/descriptor/ConfigurationGroup.java
+++ b/src/java/org/apache/ivy/core/module/descriptor/ConfigurationGroup.java
@@ -39,7 +39,7 @@ public class ConfigurationGroup extends Configuration {
* actually not been recognized in the module, they will be <code>null</code> when accessed from
* {@link org.apache.ivy.core.module.descriptor.ConfigurationIntersection#getIntersectedConfiguration(String)}.
* </p>
- *
+ *
* @return the list of configurations' names this object is an intersection of.
*/
public String[] getMembersConfigurationNames() {
@@ -50,7 +50,7 @@ public class ConfigurationGroup extends Configuration {
* Returns the {@link Configuration} object for the given conf name, or <code>null</code> if the
* given conf name is not part of this group or if this conf name isn't defined in the module in
* which this group has been built.
- *
+ *
* @param confName
* the name of the configuration to return.
* @return the member {@link Configuration} object for the given conf name
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/module/descriptor/ConfigurationIntersection.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/module/descriptor/ConfigurationIntersection.java b/src/java/org/apache/ivy/core/module/descriptor/ConfigurationIntersection.java
index beba0ca..36f2bc3 100644
--- a/src/java/org/apache/ivy/core/module/descriptor/ConfigurationIntersection.java
+++ b/src/java/org/apache/ivy/core/module/descriptor/ConfigurationIntersection.java
@@ -40,7 +40,7 @@ public class ConfigurationIntersection extends Configuration {
* actually not been recognized in the module, they will be <code>null</code> when accessed from
* {@link #getIntersectedConfiguration(String)}.
* </p>
- *
+ *
* @return the list of configurations' names this object is an intersection of.
*/
public String[] getIntersectedConfigurationNames() {
@@ -51,7 +51,7 @@ public class ConfigurationIntersection extends Configuration {
* Returns the intersected {@link Configuration} object for the given conf name, or
* <code>null</code> if the given conf name is not part of this intersection or if this conf
* name isn't defined in the module in which this intersection has been built.
- *
+ *
* @param confName
* the name of the configuration to return.
* @return the intersected {@link Configuration} object for the given conf name
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/module/descriptor/DefaultDependencyArtifactDescriptor.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/module/descriptor/DefaultDependencyArtifactDescriptor.java b/src/java/org/apache/ivy/core/module/descriptor/DefaultDependencyArtifactDescriptor.java
index eca0ecf..4785a3f 100644
--- a/src/java/org/apache/ivy/core/module/descriptor/DefaultDependencyArtifactDescriptor.java
+++ b/src/java/org/apache/ivy/core/module/descriptor/DefaultDependencyArtifactDescriptor.java
@@ -85,7 +85,7 @@ public class DefaultDependencyArtifactDescriptor extends UnmodifiableExtendableI
/**
* Add a configuration for this artifact.
- *
+ *
* @param conf ditto
*/
public void addConfiguration(String conf) {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/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 a34837a..a3e86e7 100644
--- a/src/java/org/apache/ivy/core/module/descriptor/DefaultDependencyDescriptor.java
+++ b/src/java/org/apache/ivy/core/module/descriptor/DefaultDependencyDescriptor.java
@@ -254,6 +254,10 @@ public class DefaultDependencyDescriptor implements DependencyDescriptor {
* caller, the array returned is composed of the required configurations of the dependency
* described by this descriptor.
* </p>
+ *
+ * @param moduleConfiguration String
+ * @param requestedConfiguration String
+ * @return String[]
*/
public String[] getDependencyConfigurations(String moduleConfiguration,
String requestedConfiguration) {
@@ -598,7 +602,11 @@ public class DefaultDependencyDescriptor implements DependencyDescriptor {
/**
* only works when namespace is properly set. The behaviour is not specified if namespace is not
- * set
+ * set.
+ *
+ * @param moduleConfigurations String[]
+ * @param artifactId ditto
+ * @return boolean
*/
public boolean doesExclude(String[] moduleConfigurations, ArtifactId artifactId) {
if (namespace != null) {
@@ -615,7 +623,6 @@ 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/ef719aca/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 b286bc2..85b9c74 100644
--- a/src/java/org/apache/ivy/core/module/descriptor/DefaultModuleDescriptor.java
+++ b/src/java/org/apache/ivy/core/module/descriptor/DefaultModuleDescriptor.java
@@ -428,10 +428,9 @@ 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
+ * @return the configuration object with the given name in the current module descriptor, null
+ * if not found.
*/
public Configuration getConfiguration(String confName) {
Configuration configuration = configurations.get(confName);
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/module/descriptor/DependencyDescriptorMediator.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/module/descriptor/DependencyDescriptorMediator.java b/src/java/org/apache/ivy/core/module/descriptor/DependencyDescriptorMediator.java
index 611f458..18f4be8 100644
--- a/src/java/org/apache/ivy/core/module/descriptor/DependencyDescriptorMediator.java
+++ b/src/java/org/apache/ivy/core/module/descriptor/DependencyDescriptorMediator.java
@@ -33,7 +33,7 @@ public interface DependencyDescriptorMediator {
* information of any of its transitive dependencies, since it is called by dependency resolvers
* before actually resolving a dependency.
* </p>
- *
+ *
* @param dd
* the dependency descriptor which should be mediated.
* @return the mediated {@link DependencyDescriptor}, or the original
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/module/descriptor/ExcludeRule.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/module/descriptor/ExcludeRule.java b/src/java/org/apache/ivy/core/module/descriptor/ExcludeRule.java
index 33b0027..3ece496 100644
--- a/src/java/org/apache/ivy/core/module/descriptor/ExcludeRule.java
+++ b/src/java/org/apache/ivy/core/module/descriptor/ExcludeRule.java
@@ -29,21 +29,21 @@ public interface ExcludeRule extends ExtendableItem {
/**
* Returns the id of the described artifact, without revision information
- *
+ *
* @return ArtifactId
*/
public ArtifactId getId();
/**
* Returns the configurations of the module in which the artifact is asked
- *
+ *
* @return an array of configuration names in which the artifact is asked
*/
public String[] getConfigurations();
/**
* Returns the matcher to use to know if an artifact match the current descriptor
- *
+ *
* @return PatternMatcher
*/
public PatternMatcher getMatcher();
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/module/descriptor/IncludeRule.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/module/descriptor/IncludeRule.java b/src/java/org/apache/ivy/core/module/descriptor/IncludeRule.java
index 14d841d..254addd 100644
--- a/src/java/org/apache/ivy/core/module/descriptor/IncludeRule.java
+++ b/src/java/org/apache/ivy/core/module/descriptor/IncludeRule.java
@@ -29,21 +29,21 @@ public interface IncludeRule extends ExtendableItem {
/**
* Returns the id of the described artifact, without revision information
- *
+ *
* @return ArtifactId
*/
public ArtifactId getId();
/**
* Returns the configurations of the module in which the artifact is asked
- *
+ *
* @return an array of configuration names in which the artifact is asked
*/
public String[] getConfigurations();
/**
* Returns the matcher to use to know if an artifact match the current descriptor
- *
+ *
* @return PatternMatcher
*/
public PatternMatcher getMatcher();
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/module/descriptor/InheritableItem.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/module/descriptor/InheritableItem.java b/src/java/org/apache/ivy/core/module/descriptor/InheritableItem.java
index 07eae0c..1a7e1e7 100644
--- a/src/java/org/apache/ivy/core/module/descriptor/InheritableItem.java
+++ b/src/java/org/apache/ivy/core/module/descriptor/InheritableItem.java
@@ -21,7 +21,7 @@ import org.apache.ivy.core.module.id.ModuleRevisionId;
/**
* Interface for elements that can be inherited from a parent descriptor by a child descriptor.
- *
+ *
* @see Configuration
* @see DependencyDescriptor
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/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 6b4a2a0..03694aa 100644
--- a/src/java/org/apache/ivy/core/module/descriptor/ModuleDescriptor.java
+++ b/src/java/org/apache/ivy/core/module/descriptor/ModuleDescriptor.java
@@ -63,7 +63,7 @@ public interface ModuleDescriptor extends ExtendableItem, ArtifactInfo,
/**
* This method updates the resolved module revision id
- *
+ *
* @param revId ModuleRevisionId
*/
void setResolvedModuleRevisionId(ModuleRevisionId revId);
@@ -76,7 +76,7 @@ public interface ModuleDescriptor extends ExtendableItem, ArtifactInfo,
/**
* This method update the resolved publication date
- *
+ *
* @param publicationDate Date
*/
void setResolvedPublicationDate(Date publicationDate);
@@ -158,7 +158,7 @@ public interface ModuleDescriptor extends ExtendableItem, ArtifactInfo,
* Writes this module descriptor as an ivy file. If this descriptor was obtained through the
* parsing of an ivy file, it should keep the layout of the file the most possible similar to
* the original one.
- *
+ *
* @param ivyFile
* the destination ivy file
* @throws ParseException if something goes wrong
@@ -182,7 +182,7 @@ public interface ModuleDescriptor extends ExtendableItem, ArtifactInfo,
* 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.
- *
+ *
* @return the Artifact representing this module descriptor itself.
*/
Artifact getMetadataArtifact();
@@ -203,7 +203,7 @@ public interface ModuleDescriptor extends ExtendableItem, ArtifactInfo,
/**
* Module Descriptor exclude rules are used to exclude (usually transitive) dependencies for the
* whole module.
- *
+ *
* @return an array of all {@link ExcludeRule} this module descriptor currently holds.
*/
public ExcludeRule[] getAllExcludeRules();
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/module/descriptor/OverrideDependencyDescriptorMediator.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/module/descriptor/OverrideDependencyDescriptorMediator.java b/src/java/org/apache/ivy/core/module/descriptor/OverrideDependencyDescriptorMediator.java
index cbf7482..bebdf14 100644
--- a/src/java/org/apache/ivy/core/module/descriptor/OverrideDependencyDescriptorMediator.java
+++ b/src/java/org/apache/ivy/core/module/descriptor/OverrideDependencyDescriptorMediator.java
@@ -30,7 +30,7 @@ public class OverrideDependencyDescriptorMediator implements DependencyDescripto
/**
* Constructs a new instance.
- *
+ *
* @param branch
* the branch to give to mediated dependency descriptors, <code>null</code> to keep
* the original branch.
@@ -46,7 +46,7 @@ public class OverrideDependencyDescriptorMediator implements DependencyDescripto
/**
* Returns the version this mediator will give to mediated descriptors, or <code>null</code> if
* this mediator does not override version.
- *
+ *
* @return the version this mediator will give to mediated descriptors.
*/
public String getVersion() {
@@ -56,7 +56,7 @@ public class OverrideDependencyDescriptorMediator implements DependencyDescripto
/**
* Returns the branch this mediator will give to mediated descriptors, or <code>null</code> if
* this mediator does not override branch.
- *
+ *
* @return the branch this mediator will give to mediated descriptors.
*/
public String getBranch() {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/module/id/ArtifactRevisionId.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/module/id/ArtifactRevisionId.java b/src/java/org/apache/ivy/core/module/id/ArtifactRevisionId.java
index ca34585..3c10cc4 100644
--- a/src/java/org/apache/ivy/core/module/id/ArtifactRevisionId.java
+++ b/src/java/org/apache/ivy/core/module/id/ArtifactRevisionId.java
@@ -24,7 +24,7 @@ import org.apache.ivy.util.extendable.UnmodifiableExtendableItem;
/**
* Identifies an artifact in a particular module revision
- *
+ *
* @see <a href="package-summary.html">org.apache.ivy.core.module.id</a>
*/
public class ArtifactRevisionId extends UnmodifiableExtendableItem {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/module/id/ModuleId.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/module/id/ModuleId.java b/src/java/org/apache/ivy/core/module/id/ModuleId.java
index 7effb7d..b2866b6 100644
--- a/src/java/org/apache/ivy/core/module/id/ModuleId.java
+++ b/src/java/org/apache/ivy/core/module/id/ModuleId.java
@@ -28,7 +28,7 @@ import org.apache.ivy.core.IvyPatternHelper;
/**
* Identifies a module, without revision information
- *
+ *
* @see <a href="package-summary.html">org.apache.ivy.core.module.id</a>
*/
public class ModuleId implements Comparable<ModuleId> {
@@ -39,7 +39,7 @@ public class ModuleId implements Comparable<ModuleId> {
/**
* Returns a ModuleId for the given organization and module name.
- *
+ *
* @param org
* the module's organization, can be <code>null</code>
* @param name
@@ -57,7 +57,7 @@ public class ModuleId implements Comparable<ModuleId> {
* This is useful to reduce the number of instances of ModuleId kept in memory, and thus reduce
* memory footprint.
* </p>
- *
+ *
* @param moduleId
* the module id to return
* @return a unit instance of the given module id.
@@ -89,7 +89,7 @@ public class ModuleId implements Comparable<ModuleId> {
/**
* Constructor.
- *
+ *
* @param organisation
* The organisation which creates the module.
* @param name
@@ -107,7 +107,7 @@ public class ModuleId implements Comparable<ModuleId> {
/**
* Returns the name of the module.
- *
+ *
* @return The name of the module.
*/
public String getName() {
@@ -116,7 +116,7 @@ public class ModuleId implements Comparable<ModuleId> {
/**
* Returns the name of the organisation.
- *
+ *
* @return The name of the organisation.
*/
public String getOrganisation() {
@@ -163,7 +163,7 @@ public class ModuleId implements Comparable<ModuleId> {
/**
* Returns the encoded String representing this ModuleId.
- *
+ *
* @return The ModuleId encoded as String.
*/
public String encodeToString() {
@@ -173,7 +173,7 @@ public class ModuleId implements Comparable<ModuleId> {
/**
* Returns a Map of all attributes of this module id. The Map keys are attribute names as
* Strings, and values are corresponding attribute values (as String too).
- *
+ *
* @return A Map instance containing all the attributes and their values.
*/
public Map<String, String> getAttributes() {
@@ -182,7 +182,7 @@ public class ModuleId implements Comparable<ModuleId> {
/**
* Returns a ModuleId
- *
+ *
* @param encoded String
* @return The new ModuleId.
* @throws IllegalArgumentException
@@ -198,7 +198,7 @@ public class ModuleId implements Comparable<ModuleId> {
/**
* Pattern to use to matched mid text representation.
- *
+ *
* @see #parse(String)
*/
public static final Pattern MID_PATTERN = Pattern.compile("("
@@ -207,7 +207,7 @@ public class ModuleId implements Comparable<ModuleId> {
/**
* Parses the module id text representation and returns it as a {@link ModuleId} instance.
- *
+ *
* @param mid
* the module id text representation to parse
* @return the ModuleId instance corresponding to the representation
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/module/id/ModuleRevisionId.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/module/id/ModuleRevisionId.java b/src/java/org/apache/ivy/core/module/id/ModuleRevisionId.java
index 0d63514..a31d50a 100644
--- a/src/java/org/apache/ivy/core/module/id/ModuleRevisionId.java
+++ b/src/java/org/apache/ivy/core/module/id/ModuleRevisionId.java
@@ -32,7 +32,7 @@ import org.apache.ivy.util.extendable.UnmodifiableExtendableItem;
/**
* Identifies a module in a particular version
- *
+ *
* @see <a href="package-summary.html">org.apache.ivy.core.module.id</a>
*/
public class ModuleRevisionId extends UnmodifiableExtendableItem {
@@ -51,7 +51,7 @@ public class ModuleRevisionId extends UnmodifiableExtendableItem {
/**
* Pattern to use to matched mrid text representation.
- *
+ *
* @see #parse(String)
*/
public static final Pattern MRID_PATTERN = Pattern.compile("(" + STRICT_CHARS_PATTERN + "*)"
@@ -71,7 +71,7 @@ public class ModuleRevisionId extends UnmodifiableExtendableItem {
* <p>
* The result is unspecified if the module doesn't respect strict name conventions.
* </p>
- *
+ *
* @param mrid
* the text representation of the module (as returned by {@link #toString()}). Must
* not be <code>null</code>.
@@ -142,7 +142,7 @@ public class ModuleRevisionId extends UnmodifiableExtendableItem {
* <p>
* When using static newInstances methods, this method is already called.
* </p>
- *
+ *
* @param moduleRevisionId
* the module revision id to intern
* @return an interned ModuleRevisionId
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/module/id/ModuleRules.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/module/id/ModuleRules.java b/src/java/org/apache/ivy/core/module/id/ModuleRules.java
index 5c4948c..128dff4 100644
--- a/src/java/org/apache/ivy/core/module/id/ModuleRules.java
+++ b/src/java/org/apache/ivy/core/module/id/ModuleRules.java
@@ -48,6 +48,8 @@ import org.apache.ivy.util.filter.NoFilter;
* Rules themselves can be represented by any object, depending on the purpose of the rule (define
* which resolver to use, which TTL in cache, ...)
* </p>
+ *
+ * @param <T> a type parameter
*/
public class ModuleRules<T> {
@@ -70,7 +72,7 @@ public class ModuleRules<T> {
/**
* Defines a new rule for the given condition.
- *
+ *
* @param condition
* the condition for which the rule should be applied. Must not be <code>null</code>.
* @param rule
@@ -87,7 +89,7 @@ public class ModuleRules<T> {
/**
* Returns the rule object matching the given {@link ModuleId}, or <code>null</code> if no rule
* applies.
- *
+ *
* @param mid
* the {@link ModuleId} to search the rule for. Must not be <code>null</code>.
* @return the rule object matching the given {@link ModuleId}, or <code>null</code> if no rule
@@ -101,7 +103,7 @@ public class ModuleRules<T> {
/**
* Returns the rules objects matching the given {@link ModuleId}, or an empty array if no rule
* applies.
- *
+ *
* @param mid
* the {@link ModuleId} to search the rule for. Must not be <code>null</code>.
* @return an array of rule objects matching the given {@link ModuleId}.
@@ -113,7 +115,7 @@ public class ModuleRules<T> {
/**
* Returns the rule object matching the given {@link ModuleRevisionId}, or <code>null</code> if
* no rule applies.
- *
+ *
* @param mrid
* the {@link ModuleRevisionId} to search the rule for. Must not be <code>null</code>
* .
@@ -128,7 +130,7 @@ public class ModuleRules<T> {
/**
* Returns the rule object matching the given {@link ModuleId} and accepted by the given
* {@link Filter}, or <code>null</code> if no rule applies.
- *
+ *
* @param mid
* the {@link ModuleRevisionId} to search the rule for. Must not be <code>null</code>
* .
@@ -149,7 +151,7 @@ public class ModuleRules<T> {
/**
* Returns the rule object matching the given {@link ModuleRevisionId} and accepted by the given
* {@link Filter}, or <code>null</code> if no rule applies.
- *
+ *
* @param mrid
* the {@link ModuleRevisionId} to search the rule for. Must not be <code>null</code>
* .
@@ -183,7 +185,7 @@ public class ModuleRules<T> {
/**
* Returns the rules object matching the given {@link ModuleRevisionId} and accepted by the
* given {@link Filter}, or an empty array if no rule applies.
- *
+ *
* @param mrid
* the {@link ModuleRevisionId} to search the rule for. Must not be <code>null</code>
* .
@@ -214,7 +216,7 @@ public class ModuleRules<T> {
/**
* Dump the list of rules to {@link Message#debug(String)}
- *
+ *
* @param prefix
* the prefix to use for each line dumped
*/
@@ -236,7 +238,7 @@ public class ModuleRules<T> {
* The rules are returned in a Map where they keys are the MapMatchers matching the rules
* object, and the values are the rules object themselves.
* </p>
- *
+ *
* @return an unmodifiable view of all the rules defined on this ModuleRules.
*/
public Map<MapMatcher, T> getAllRules() {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/publish/PublishOptions.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/publish/PublishOptions.java b/src/java/org/apache/ivy/core/publish/PublishOptions.java
index 3c604cd..7dcc48d 100644
--- a/src/java/org/apache/ivy/core/publish/PublishOptions.java
+++ b/src/java/org/apache/ivy/core/publish/PublishOptions.java
@@ -33,7 +33,7 @@ import org.apache.ivy.core.module.descriptor.Artifact;
* 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 (on the artifacts) can
* return null safely.
- *
+ *
* @see PublishEngine
*/
public class PublishOptions {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/report/ArtifactDownloadReport.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/report/ArtifactDownloadReport.java b/src/java/org/apache/ivy/core/report/ArtifactDownloadReport.java
index f4a7553..8a9b9d1 100644
--- a/src/java/org/apache/ivy/core/report/ArtifactDownloadReport.java
+++ b/src/java/org/apache/ivy/core/report/ArtifactDownloadReport.java
@@ -76,7 +76,7 @@ public class ArtifactDownloadReport {
}
/**
- *
+ *
* @return the type of the downloaded artifact
*/
public String getType() {
@@ -143,7 +143,7 @@ public class ArtifactDownloadReport {
/**
* Returns the File where the artifact is available on the local filesystem, or
* <code>null</code> if and only if the artifact caching failed.
- *
+ *
* @return the file where the artifact is now available on the local filesystem.
*/
public File getLocalFile() {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/report/MetadataArtifactDownloadReport.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/report/MetadataArtifactDownloadReport.java b/src/java/org/apache/ivy/core/report/MetadataArtifactDownloadReport.java
index be3181f..ddafd08 100644
--- a/src/java/org/apache/ivy/core/report/MetadataArtifactDownloadReport.java
+++ b/src/java/org/apache/ivy/core/report/MetadataArtifactDownloadReport.java
@@ -33,7 +33,7 @@ public class MetadataArtifactDownloadReport extends ArtifactDownloadReport {
/**
* Returns <code>true</code> if the resolution of this metadata artifact required at least one
* access to the repository, or <code>false</code> if only provisioned data was used.
- *
+ *
* @return <code>true</code> if the resolution of this metadata artifact required at least one
* access to the repository
*/
@@ -48,7 +48,7 @@ public class MetadataArtifactDownloadReport extends ArtifactDownloadReport {
/**
* Returns the location on the local filesystem where the original metadata artifact is
* provisioned, or <code>null</code> if the provisioning failed.
- *
+ *
* @return the location on the local filesystem where the original metadata artifact is
* provisioned.
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/repository/RepositoryManagementEngine.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/repository/RepositoryManagementEngine.java b/src/java/org/apache/ivy/core/repository/RepositoryManagementEngine.java
index 286d7b4..ae769cc 100644
--- a/src/java/org/apache/ivy/core/repository/RepositoryManagementEngine.java
+++ b/src/java/org/apache/ivy/core/repository/RepositoryManagementEngine.java
@@ -173,7 +173,7 @@ public class RepositoryManagementEngine {
* This method may take a long time to proceed. It should never be called from event dispatch
* thread in a GUI.
* </p>
- *
+ *
* @throws IllegalStateException
* if the repository has not been loaded yet
* @see #load()
@@ -200,7 +200,7 @@ public class RepositoryManagementEngine {
/**
* Returns the number of Module Revision in the repository.
- *
+ *
* @return the number of module revisions in the repository.
* @throws IllegalStateException
* if the repository has not been loaded yet
@@ -213,7 +213,7 @@ public class RepositoryManagementEngine {
/**
* Returns the number of ModuleId in the repository.
- *
+ *
* @return the number of ModuleId in the repository.
* @throws IllegalStateException
* if the repository has not been loaded yet
@@ -226,7 +226,7 @@ public class RepositoryManagementEngine {
/**
* Returns Module Revisions which have no dependers.
- *
+ *
* @return a Collection of the {@link ModuleRevisionId} of module revisions which have no
* dependers in the repository.
* @throws IllegalStateException
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/resolve/ResolveData.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/resolve/ResolveData.java b/src/java/org/apache/ivy/core/resolve/ResolveData.java
index 0877f8b..74221f0 100644
--- a/src/java/org/apache/ivy/core/resolve/ResolveData.java
+++ b/src/java/org/apache/ivy/core/resolve/ResolveData.java
@@ -160,7 +160,7 @@ public class ResolveData {
/**
* Returns the VisitNode currently visited, or <code>null</code> if there is no node currently
* visited in this context.
- *
+ *
* @return the VisitNode currently visited
*/
public VisitNode getCurrentVisitNode() {
@@ -170,7 +170,7 @@ public class ResolveData {
/**
* Sets the currently visited node. WARNING: This should only be called by Ivy core
* ResolveEngine!
- *
+ *
* @param currentVisitNode VisitNode
*/
void setCurrentVisitNode(VisitNode currentVisitNode) {
@@ -196,7 +196,7 @@ public class ResolveData {
/**
* Updates the visit data currently associated with the given mrid with the given node and the
* visit nodes of the old visitData for the given rootModuleConf
- *
+ *
* @param mrid
* the module revision id for which the update should be done
* @param node
@@ -327,7 +327,7 @@ public class ResolveData {
* this decision, even when included in a chain. The chain responsibility is only to set this
* current resolved module revision to enable the resolver to take the decision.
* </p>
- *
+ *
* @param mr
* the last {@link ResolvedModuleRevision} which has been currently resolved.
*/
@@ -340,7 +340,7 @@ public class ResolveData {
* <p>
* It can be <code>null</code>.
* </p>
- *
+ *
* @return the last {@link ResolvedModuleRevision} which has been currently resolved.
*/
public ResolvedModuleRevision getCurrentResolvedModuleRevision() {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/resolve/ResolvedModuleRevision.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/resolve/ResolvedModuleRevision.java b/src/java/org/apache/ivy/core/resolve/ResolvedModuleRevision.java
index 5fefcaf..b209d04 100644
--- a/src/java/org/apache/ivy/core/resolve/ResolvedModuleRevision.java
+++ b/src/java/org/apache/ivy/core/resolve/ResolvedModuleRevision.java
@@ -58,7 +58,7 @@ public class ResolvedModuleRevision {
/**
* Returns the identifier of the resolved module.
- *
+ *
* @return the identifier of the resolved module.
*/
public ModuleRevisionId getId() {
@@ -67,7 +67,7 @@ public class ResolvedModuleRevision {
/**
* Returns the date of publication of the resolved module.
- *
+ *
* @return the date of publication of the resolved module.
*/
public Date getPublicationDate() {
@@ -76,7 +76,7 @@ public class ResolvedModuleRevision {
/**
* Returns the descriptor of the resolved module.
- *
+ *
* @return the descriptor of the resolved module.
*/
public ModuleDescriptor getDescriptor() {
@@ -85,7 +85,7 @@ public class ResolvedModuleRevision {
/**
* The resolver which resolved this ResolvedModuleRevision
- *
+ *
* @return The resolver which resolved this ResolvedModuleRevision
*/
public DependencyResolver getResolver() {
@@ -94,7 +94,7 @@ public class ResolvedModuleRevision {
/**
* The resolver to use to download artifacts
- *
+ *
* @return The resolver to use to download artifacts
*/
public DependencyResolver getArtifactResolver() {
@@ -103,7 +103,7 @@ public class ResolvedModuleRevision {
/**
* Returns a report of the resolved module metadata artifact provisioning.
- *
+ *
* @return a report of the resolved module metadata artifact provisioning.
*/
public MetadataArtifactDownloadReport getReport() {
@@ -117,7 +117,7 @@ public class ResolvedModuleRevision {
* This is used as an indication for CompositeResolver, to know if they should continue to look
* for a better ResolvedModuleRevision if possible, or stop with this instance.
* </p>
- *
+ *
* @return <code>true</code> if this resolved module revision should be forced as the one being
* returned.
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/retrieve/RetrieveOptions.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/retrieve/RetrieveOptions.java b/src/java/org/apache/ivy/core/retrieve/RetrieveOptions.java
index d3d4443..7f27d56 100644
--- a/src/java/org/apache/ivy/core/retrieve/RetrieveOptions.java
+++ b/src/java/org/apache/ivy/core/retrieve/RetrieveOptions.java
@@ -23,7 +23,7 @@ import org.apache.ivy.util.filter.FilterHelper;
/**
* A set of options used during retrieve related tasks
- *
+ *
* @see RetrieveEngine
*/
public class RetrieveOptions extends LogOptions {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/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 2523e41..342079d 100644
--- a/src/java/org/apache/ivy/core/settings/IvySettings.java
+++ b/src/java/org/apache/ivy/core/settings/IvySettings.java
@@ -311,6 +311,8 @@ public class IvySettings implements SortEngineSettings, PublishEngineSettings, P
/**
* Call this method to ask ivy to configure some variables using either a remote or a local
* properties file
+ *
+ * @param remote boolean
*/
public synchronized void configureRepositories(boolean remote) {
if (!repositoriesConfigured) {
@@ -1210,6 +1212,8 @@ public class IvySettings implements SortEngineSettings, PublishEngineSettings, P
/**
* Returns the file names of the files that should be ignored when creating a file listing.
+ *
+ * @return String[]
*/
public synchronized String[] getIgnorableFilenames() {
return listingIgnore.toArray(new String[listingIgnore.size()]);
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/settings/IvyVariableContainer.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/settings/IvyVariableContainer.java b/src/java/org/apache/ivy/core/settings/IvyVariableContainer.java
index e3d15a4..ba2af68 100644
--- a/src/java/org/apache/ivy/core/settings/IvyVariableContainer.java
+++ b/src/java/org/apache/ivy/core/settings/IvyVariableContainer.java
@@ -29,7 +29,7 @@ public interface IvyVariableContainer extends Cloneable {
/**
* Specifies the prefix used to indicate a variable is an environment variable. If the prefix
* doesn't end with a '.', it will be added automatically.
- *
+ *
* @param prefix
* the prefix to use for the environment variables
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/settings/IvyVariableContainerImpl.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/settings/IvyVariableContainerImpl.java b/src/java/org/apache/ivy/core/settings/IvyVariableContainerImpl.java
index 8d89091..68da2c9 100644
--- a/src/java/org/apache/ivy/core/settings/IvyVariableContainerImpl.java
+++ b/src/java/org/apache/ivy/core/settings/IvyVariableContainerImpl.java
@@ -39,7 +39,7 @@ public class IvyVariableContainerImpl implements IvyVariableContainer {
/*
* (non-Javadoc)
- *
+ *
* @see org.apache.ivy.core.settings.IvyVariableContainer#setVariable(java.lang.String,
* java.lang.String, boolean)
*/
@@ -74,7 +74,7 @@ public class IvyVariableContainerImpl implements IvyVariableContainer {
/*
* (non-Javadoc)
- *
+ *
* @see org.apache.ivy.core.settings.IvyVariableContainer#getVariable(java.lang.String)
*/
public String getVariable(String name) {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/settings/Validatable.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/settings/Validatable.java b/src/java/org/apache/ivy/core/settings/Validatable.java
index f79370d..8c133c4 100644
--- a/src/java/org/apache/ivy/core/settings/Validatable.java
+++ b/src/java/org/apache/ivy/core/settings/Validatable.java
@@ -24,7 +24,7 @@ public interface Validatable {
/**
* Validates the Validatable, throwing an {@link IllegalStateException} if the current state is
* not valid.
- *
+ *
* @throws IllegalStateException
* if the state of the {@link Validatable} is not valid.
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/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 e6757d7..6e30b25 100644
--- a/src/java/org/apache/ivy/core/sort/ModuleInSort.java
+++ b/src/java/org/apache/ivy/core/sort/ModuleInSort.java
@@ -36,14 +36,14 @@ import org.apache.ivy.util.Message;
* The added fields are:
* </p>
* <ul>
- * <li><code>isSorted</code> : is <i>true</i> if and only if this module has already been added to
+ * <li><code>isSorted</code> : is <i>true</i> if and only if 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
+ * <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
+ * <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,
+ * <li><code>caller</code> : During the sort, we traverse recursively the graph. When doing that,
* caller point to the parent element.</li>
* </ul>
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/sort/NonMatchingVersionReporter.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/sort/NonMatchingVersionReporter.java b/src/java/org/apache/ivy/core/sort/NonMatchingVersionReporter.java
index d713bd6..0584f87 100644
--- a/src/java/org/apache/ivy/core/sort/NonMatchingVersionReporter.java
+++ b/src/java/org/apache/ivy/core/sort/NonMatchingVersionReporter.java
@@ -25,7 +25,7 @@ public interface NonMatchingVersionReporter {
/**
* Report to the user that ivy has detected that a module to sort has a dependency on an other
* module to sort, but the revisions doesn't match.
- *
+ *
* @param descriptor
* The non matching dependency descriptor.
* @param md
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/core/sort/SortEngine.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/core/sort/SortEngine.java b/src/java/org/apache/ivy/core/sort/SortEngine.java
index e6b6774..d4ddbbc 100644
--- a/src/java/org/apache/ivy/core/sort/SortEngine.java
+++ b/src/java/org/apache/ivy/core/sort/SortEngine.java
@@ -45,7 +45,7 @@ public class SortEngine {
/**
* Same as {@link #sortModuleDescriptors(Collection, SortOptions)} but for <code>IvyNode</code>
* s.
- *
+ *
* @param nodes
* a Collection of nodes to sort
* @param options
@@ -95,7 +95,7 @@ public class SortEngine {
* Sorts the given ModuleDescriptors from the less dependent to the more dependent. This sort
* ensures that a ModuleDescriptor is always found in the list before all ModuleDescriptors
* depending directly on it.
- *
+ *
* @param moduleDescriptors
* a Collection of ModuleDescriptor to sort
* @param options
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/osgi/core/BundleInfo.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/osgi/core/BundleInfo.java b/src/java/org/apache/ivy/osgi/core/BundleInfo.java
index 8840351..2d078bc 100644
--- a/src/java/org/apache/ivy/osgi/core/BundleInfo.java
+++ b/src/java/org/apache/ivy/osgi/core/BundleInfo.java
@@ -26,7 +26,7 @@ import org.apache.ivy.osgi.util.Version;
/**
* Bundle info extracted from the bundle manifest.
- *
+ *
*/
public class BundleInfo {
@@ -378,4 +378,4 @@ public class BundleInfo {
return set;
}
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/osgi/core/ManifestHeaderValue.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/osgi/core/ManifestHeaderValue.java b/src/java/org/apache/ivy/osgi/core/ManifestHeaderValue.java
index d793975..1b64b7c 100644
--- a/src/java/org/apache/ivy/osgi/core/ManifestHeaderValue.java
+++ b/src/java/org/apache/ivy/osgi/core/ManifestHeaderValue.java
@@ -26,7 +26,7 @@ import java.util.List;
/**
* Parse a header of a manifest. The manifest header is composed with the following rules:
- *
+ *
* <pre>
* header ::= header-element (',' header-element)*
* header-element ::= values (';' (attribute | directive) )*
@@ -131,7 +131,7 @@ public class ManifestHeaderValue {
/**
* Default constructor
- *
+ *
* @param header
* the header to parse
*/
@@ -142,7 +142,7 @@ public class ManifestHeaderValue {
/**
* Do the parsing
- *
+ *
* @throws ParseException
*/
void parse() throws ParseException {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/osgi/core/ManifestParser.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/osgi/core/ManifestParser.java b/src/java/org/apache/ivy/osgi/core/ManifestParser.java
index dcac35e..90685b1 100644
--- a/src/java/org/apache/ivy/osgi/core/ManifestParser.java
+++ b/src/java/org/apache/ivy/osgi/core/ManifestParser.java
@@ -33,7 +33,7 @@ import org.apache.ivy.osgi.util.VersionRange;
/**
* Provides an OSGi manifest parser.
- *
+ *
*/
public class ManifestParser {
@@ -269,7 +269,7 @@ public class ManifestParser {
/**
* Ensure that the lines are not longer than 72 characters, so it can be parsed by the
* {@link Manifest} class
- *
+ *
* @param manifest ditto
* @return String
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/osgi/filter/MultiOperatorFilter.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/osgi/filter/MultiOperatorFilter.java b/src/java/org/apache/ivy/osgi/filter/MultiOperatorFilter.java
index 8872d01..309b0ad 100644
--- a/src/java/org/apache/ivy/osgi/filter/MultiOperatorFilter.java
+++ b/src/java/org/apache/ivy/osgi/filter/MultiOperatorFilter.java
@@ -35,7 +35,7 @@ public abstract class MultiOperatorFilter extends OSGiFilter {
}
}
- abstract protected char operator();
+ protected abstract char operator();
@Override
public void append(StringBuffer builder) {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/osgi/filter/OSGiFilterParser.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/osgi/filter/OSGiFilterParser.java b/src/java/org/apache/ivy/osgi/filter/OSGiFilterParser.java
index da9ed9e..3be59d9 100644
--- a/src/java/org/apache/ivy/osgi/filter/OSGiFilterParser.java
+++ b/src/java/org/apache/ivy/osgi/filter/OSGiFilterParser.java
@@ -51,7 +51,7 @@ public class OSGiFilterParser {
/**
* Default constructor
- *
+ *
* @param text
* the header to parse
*/
@@ -62,9 +62,9 @@ public class OSGiFilterParser {
/**
* Do the parsing
- *
+ *
* @return OSGiFilter
- *
+ *
* @throws ParseException
*/
OSGiFilter parse() throws ParseException {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/osgi/filter/UniOperatorFilter.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/osgi/filter/UniOperatorFilter.java b/src/java/org/apache/ivy/osgi/filter/UniOperatorFilter.java
index 59c6962..19f1556 100644
--- a/src/java/org/apache/ivy/osgi/filter/UniOperatorFilter.java
+++ b/src/java/org/apache/ivy/osgi/filter/UniOperatorFilter.java
@@ -25,7 +25,7 @@ public abstract class UniOperatorFilter extends OSGiFilter {
this.subFilter = subFilter;
}
- abstract protected char operator();
+ protected abstract char operator();
@Override
public void append(StringBuffer builder) {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/osgi/repo/AbstractFSManifestIterable.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/osgi/repo/AbstractFSManifestIterable.java b/src/java/org/apache/ivy/osgi/repo/AbstractFSManifestIterable.java
index eb4b4f0..cbccda9 100644
--- a/src/java/org/apache/ivy/osgi/repo/AbstractFSManifestIterable.java
+++ b/src/java/org/apache/ivy/osgi/repo/AbstractFSManifestIterable.java
@@ -44,13 +44,13 @@ public abstract class AbstractFSManifestIterable<T> implements Iterable<Manifest
return new FSManifestIterator();
}
- abstract protected List<T> listBundleFiles(T dir) throws IOException;
+ protected abstract List<T> listBundleFiles(T dir) throws IOException;
- abstract protected List<T> listDirs(T dir) throws IOException;
+ protected abstract List<T> listDirs(T dir) throws IOException;
- abstract protected InputStream getInputStream(T f) throws IOException;
+ protected abstract InputStream getInputStream(T f) throws IOException;
- abstract protected URI buildBundleURI(T location) throws IOException;
+ protected abstract URI buildBundleURI(T location) throws IOException;
class FSManifestIterator implements Iterator<ManifestAndLocation> {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/osgi/repo/AbstractOSGiResolver.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/osgi/repo/AbstractOSGiResolver.java b/src/java/org/apache/ivy/osgi/repo/AbstractOSGiResolver.java
index 2612fbe..2a73d21 100644
--- a/src/java/org/apache/ivy/osgi/repo/AbstractOSGiResolver.java
+++ b/src/java/org/apache/ivy/osgi/repo/AbstractOSGiResolver.java
@@ -119,7 +119,7 @@ public abstract class AbstractOSGiResolver extends BasicResolver {
}
}
- abstract protected void init();
+ protected abstract void init();
public RepoDescriptor getRepoDescriptor() {
ensureInit();
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/osgi/repo/FSManifestIterable.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/osgi/repo/FSManifestIterable.java b/src/java/org/apache/ivy/osgi/repo/FSManifestIterable.java
index bfa97b5..3d71760 100644
--- a/src/java/org/apache/ivy/osgi/repo/FSManifestIterable.java
+++ b/src/java/org/apache/ivy/osgi/repo/FSManifestIterable.java
@@ -70,7 +70,7 @@ public class FSManifestIterable extends AbstractFSManifestIterable<File> {
/**
* Default constructor
- *
+ *
* @param root
* the root directory of the file system to lookup
*/
@@ -123,4 +123,4 @@ public class FSManifestIterable extends AbstractFSManifestIterable<File> {
}
}));
}
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/osgi/repo/RepoDescriptor.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/osgi/repo/RepoDescriptor.java b/src/java/org/apache/ivy/osgi/repo/RepoDescriptor.java
index 22a57d1..31bdd60 100644
--- a/src/java/org/apache/ivy/osgi/repo/RepoDescriptor.java
+++ b/src/java/org/apache/ivy/osgi/repo/RepoDescriptor.java
@@ -22,12 +22,12 @@ import java.util.Set;
public abstract class RepoDescriptor {
- abstract public Iterator<ModuleDescriptorWrapper> getModules();
+ public abstract Iterator<ModuleDescriptorWrapper> getModules();
- abstract public Set<String> getCapabilities();
+ public abstract Set<String> getCapabilities();
- abstract public Set<ModuleDescriptorWrapper> findModules(String requirement, String value);
+ public abstract Set<ModuleDescriptorWrapper> findModules(String requirement, String value);
- abstract public Set<String> getCapabilityValues(String capabilityName);
+ public abstract Set<String> getCapabilityValues(String capabilityName);
}
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/osgi/repo/RepositoryManifestIterable.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/osgi/repo/RepositoryManifestIterable.java b/src/java/org/apache/ivy/osgi/repo/RepositoryManifestIterable.java
index 2c23516..88ac784 100644
--- a/src/java/org/apache/ivy/osgi/repo/RepositoryManifestIterable.java
+++ b/src/java/org/apache/ivy/osgi/repo/RepositoryManifestIterable.java
@@ -36,7 +36,7 @@ public class RepositoryManifestIterable extends AbstractFSManifestIterable<Strin
/**
* Default constructor
- *
+ *
* @param repo
* the root directory of the file system to lookup
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/osgi/util/DelegatingHandler.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/osgi/util/DelegatingHandler.java b/src/java/org/apache/ivy/osgi/util/DelegatingHandler.java
index 5d5b2a3..a314d57 100644
--- a/src/java/org/apache/ivy/osgi/util/DelegatingHandler.java
+++ b/src/java/org/apache/ivy/osgi/util/DelegatingHandler.java
@@ -300,10 +300,12 @@ public class DelegatingHandler extends DefaultHandler implements DTDHandler, Con
protected void doEndElement(String uri, String localName, String name) throws SAXException {
}
- public static abstract class ChildElementHandler<DH extends DelegatingHandler> {
+ public abstract static class ChildElementHandler<DH extends DelegatingHandler> {
/**
- * Deprecated because of renaming due spell check.
+ * @param child DH
+ * @throws SAXParseException on failure
+ * @deprecated because of renaming due spell check.
*/
@Deprecated
public void childHanlded(DH child) throws SAXParseException {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/osgi/util/ParseUtil.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/osgi/util/ParseUtil.java b/src/java/org/apache/ivy/osgi/util/ParseUtil.java
index bb31d0c..39078b9 100644
--- a/src/java/org/apache/ivy/osgi/util/ParseUtil.java
+++ b/src/java/org/apache/ivy/osgi/util/ParseUtil.java
@@ -26,7 +26,7 @@ public class ParseUtil {
* Parses delimited string and returns an array containing the tokens. This parser obeys quotes,
* so the delimiter character will be ignored if it is inside of a quote. This method assumes
* that the quote character is not included in the set of delimiter characters.
- *
+ *
* @param value
* the delimited string to parse.
* @param delim
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/osgi/util/Version.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/osgi/util/Version.java b/src/java/org/apache/ivy/osgi/util/Version.java
index 9a5f868..a82be77 100644
--- a/src/java/org/apache/ivy/osgi/util/Version.java
+++ b/src/java/org/apache/ivy/osgi/util/Version.java
@@ -61,7 +61,7 @@ public class Version implements Comparable<Version> {
/**
* Build a version from another one while appending an extra qualifier
- *
+ *
* @param baseVersion
* Version
* @param extraQualifier
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/osgi/util/VersionRange.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/osgi/util/VersionRange.java b/src/java/org/apache/ivy/osgi/util/VersionRange.java
index b477145..8d8be94 100644
--- a/src/java/org/apache/ivy/osgi/util/VersionRange.java
+++ b/src/java/org/apache/ivy/osgi/util/VersionRange.java
@@ -67,7 +67,7 @@ public class VersionRange {
/**
* Default constructor
- *
+ *
* @param version
* the version to parse
*/
@@ -78,7 +78,7 @@ public class VersionRange {
/**
* Do the parsing
- *
+ *
* @throws ParseException
*/
void parse() throws ParseException {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/conflict/ConflictManager.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/conflict/ConflictManager.java b/src/java/org/apache/ivy/plugins/conflict/ConflictManager.java
index 645cbe5..426acec 100644
--- a/src/java/org/apache/ivy/plugins/conflict/ConflictManager.java
+++ b/src/java/org/apache/ivy/plugins/conflict/ConflictManager.java
@@ -31,7 +31,7 @@ public interface ConflictManager {
* this conflict manager is not able to resolve conflicts with the current data found in the
* IvyNodes and need them to be fully loaded, it will return null to indicate that no conflict
* resolution has been done.
- *
+ *
* @param parent
* the ivy node parent for which the conflict is to be resolved
* @param conflicts
@@ -50,7 +50,7 @@ public interface ConflictManager {
* This will never happen if the conflict manager doesn't blacklist any module, so providing an
* empty implementation in this case is fine.
* </p>
- *
+ *
* @param dd
* the dependency descriptor for which all revisions are blacklisted.
* @param foundBlacklisted
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/conflict/LatestConflictManager.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/conflict/LatestConflictManager.java b/src/java/org/apache/ivy/plugins/conflict/LatestConflictManager.java
index 541648e..04db4c8 100644
--- a/src/java/org/apache/ivy/plugins/conflict/LatestConflictManager.java
+++ b/src/java/org/apache/ivy/plugins/conflict/LatestConflictManager.java
@@ -103,8 +103,9 @@ public class LatestConflictManager extends AbstractConflictManager {
ArrayList<IvyNode> unevicted = new ArrayList<IvyNode>();
for (IvyNode node : conflicts) {
- if (!node.isCompletelyEvicted())
+ if (!node.isCompletelyEvicted()) {
unevicted.add(node);
+ }
}
if (unevicted.size() > 0) {
conflicts = unevicted;
@@ -150,7 +151,7 @@ public class LatestConflictManager extends AbstractConflictManager {
/**
* To conform to configurator API
- *
+ *
* @param strategyName ditto
*/
public void setLatest(String strategyName) {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/conflict/RegexpConflictManager.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/conflict/RegexpConflictManager.java b/src/java/org/apache/ivy/plugins/conflict/RegexpConflictManager.java
index 3312e45..bb71d1a 100644
--- a/src/java/org/apache/ivy/plugins/conflict/RegexpConflictManager.java
+++ b/src/java/org/apache/ivy/plugins/conflict/RegexpConflictManager.java
@@ -29,16 +29,16 @@ import org.apache.ivy.util.Message;
/**
* A ConflictManager that can be used to resolve conflicts based on regular expressions of the
* revision of the module. The conflict manager is added like this:
- *
+ *
* <pre>
* <!-- Match all revisions, but ignore the last dot(.) and the character after it.
* Used to match api changes in out milestones. -->
* <conflict-managers>
- * <regexp-cm name="regexp"
+ * <regexp-cm name="regexp"
* regexp="(.*)\..$" ignoreNonMatching="true"/>
* </conflict-managers>
* </pre>
- *
+ *
* The regular expression must contain a capturing group. The group will be used to resolve the
* conflicts by an String.equals() test. If ignoreNonMatching is false non matching modules will
* result in an exception. If it is true they will be compared by their full revision.
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/latest/LatestStrategy.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/latest/LatestStrategy.java b/src/java/org/apache/ivy/plugins/latest/LatestStrategy.java
index 8cebce5..02bdd5a 100644
--- a/src/java/org/apache/ivy/plugins/latest/LatestStrategy.java
+++ b/src/java/org/apache/ivy/plugins/latest/LatestStrategy.java
@@ -25,7 +25,7 @@ public interface LatestStrategy {
* Finds the latest artifact among the given artifacts info. The definition of 'latest' depends
* on the strategy itself. Given artifacts info are all good candidate. If the given date is not
* null, then found artifact should not be later than this date.
- *
+ *
* @param infos ArtifactInfo[]
* @param date Date
* @return the latest artifact among the given ones.
@@ -35,7 +35,7 @@ public interface LatestStrategy {
/**
* Sorts the given artifacts info from the oldest one to the latest one. The definition of
* 'latest' depends on the strategy itself. Given artifacts info are all good candidate.
- *
+ *
* @param infos ArtifactInfo[]
* @return List<ArtifactInfo>
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/lock/DeleteOnExitHook.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/lock/DeleteOnExitHook.java b/src/java/org/apache/ivy/plugins/lock/DeleteOnExitHook.java
index 112f760..bb86970 100644
--- a/src/java/org/apache/ivy/plugins/lock/DeleteOnExitHook.java
+++ b/src/java/org/apache/ivy/plugins/lock/DeleteOnExitHook.java
@@ -51,4 +51,4 @@ class DeleteOnExitHook {
itr.remove();
}
}
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/matcher/AbstractPatternMatcher.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/matcher/AbstractPatternMatcher.java b/src/java/org/apache/ivy/plugins/matcher/AbstractPatternMatcher.java
index 28aecfd..88707c1 100644
--- a/src/java/org/apache/ivy/plugins/matcher/AbstractPatternMatcher.java
+++ b/src/java/org/apache/ivy/plugins/matcher/AbstractPatternMatcher.java
@@ -26,7 +26,7 @@ public abstract class AbstractPatternMatcher implements PatternMatcher {
/**
* Create a new instance of a pattern matcher
- *
+ *
* @param name
* the name of the pattern matcher. Never null.
*/
@@ -50,7 +50,7 @@ public abstract class AbstractPatternMatcher implements PatternMatcher {
/**
* Returns an instance of the implementation specific matcher.
- *
+ *
* @param expression
* the string to be matched.
* @return the instance of the related matcher. Never null.
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/matcher/Matcher.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/matcher/Matcher.java b/src/java/org/apache/ivy/plugins/matcher/Matcher.java
index 0a2cf77..300c7ab 100644
--- a/src/java/org/apache/ivy/plugins/matcher/Matcher.java
+++ b/src/java/org/apache/ivy/plugins/matcher/Matcher.java
@@ -24,7 +24,7 @@ public interface Matcher {
/**
* Check whether a given string is matched by this matcher.
- *
+ *
* @param input
* the string to be matched. Cannot be null.
* @return true if the input string is matched, false otherwise.
@@ -36,7 +36,7 @@ public interface Matcher {
* used only as a performance trick, to avoid scanning for things when you already know exactly
* what you want. In the install task where it used it avoid scanning the repository to list all
* modules to find that only one matches, and that it has the name requested. </i>
- *
+ *
* @return true if the matcher only matches when the expression is equals to the input, false
* otherwise.
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/matcher/RegexpPatternMatcher.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/matcher/RegexpPatternMatcher.java b/src/java/org/apache/ivy/plugins/matcher/RegexpPatternMatcher.java
index aa97974..ce1c706 100644
--- a/src/java/org/apache/ivy/plugins/matcher/RegexpPatternMatcher.java
+++ b/src/java/org/apache/ivy/plugins/matcher/RegexpPatternMatcher.java
@@ -22,7 +22,7 @@ import java.util.regex.PatternSyntaxException;
/**
* A pattern matcher matching input using regular expressions.
- *
+ *
* @see Pattern
*/
public final/* @Immutable */class RegexpPatternMatcher extends AbstractPatternMatcher {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/parser/AbstractModuleDescriptorParser.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/parser/AbstractModuleDescriptorParser.java b/src/java/org/apache/ivy/plugins/parser/AbstractModuleDescriptorParser.java
index 6307ff0..104ffb6 100644
--- a/src/java/org/apache/ivy/plugins/parser/AbstractModuleDescriptorParser.java
+++ b/src/java/org/apache/ivy/plugins/parser/AbstractModuleDescriptorParser.java
@@ -191,7 +191,7 @@ public abstract class AbstractModuleDescriptorParser implements ModuleDescriptor
* the condition evaluates to true, the configuration is returned, if the condition
* evaluates to false, null is returned. If there are no conditions, the configuration
* itself is returned.
- *
+ *
* @param conf
* the configuration to evaluate
* @param dd
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/parser/ModuleDescriptorParser.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/parser/ModuleDescriptorParser.java b/src/java/org/apache/ivy/plugins/parser/ModuleDescriptorParser.java
index cfd3636..cb723ef 100644
--- a/src/java/org/apache/ivy/plugins/parser/ModuleDescriptorParser.java
+++ b/src/java/org/apache/ivy/plugins/parser/ModuleDescriptorParser.java
@@ -38,7 +38,7 @@ public interface ModuleDescriptorParser {
/**
* Convert a module descriptor to an ivy file. This method MUST close the given input stream
* when job is finished
- *
+ *
* @param is input stream with opened on original module descriptor resource
* @param res Resource
* @param destFile File
@@ -53,7 +53,7 @@ public interface ModuleDescriptorParser {
/**
* Return the 'type' of module artifacts this parser is parsing
- *
+ *
* @return the 'type' of module artifacts this parser is parsing
*/
public String getType();
@@ -61,7 +61,7 @@ public interface ModuleDescriptorParser {
/**
* Returns the module metadata artifact corresponding to the given module revision id that this
* parser parses
- *
+ *
* @param res
* the resource for which the module artifact should be returned
* @param mrid
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/parser/ModuleDescriptorParserRegistry.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/parser/ModuleDescriptorParserRegistry.java b/src/java/org/apache/ivy/plugins/parser/ModuleDescriptorParserRegistry.java
index b7626df..c3c0834 100644
--- a/src/java/org/apache/ivy/plugins/parser/ModuleDescriptorParserRegistry.java
+++ b/src/java/org/apache/ivy/plugins/parser/ModuleDescriptorParserRegistry.java
@@ -49,7 +49,7 @@ public final class ModuleDescriptorParserRegistry extends AbstractModuleDescript
/**
* Adds a the given parser to this registry.
- *
+ *
* @param parser
* the parser to add
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/parser/m2/PomModuleDescriptorBuilder.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/parser/m2/PomModuleDescriptorBuilder.java b/src/java/org/apache/ivy/plugins/parser/m2/PomModuleDescriptorBuilder.java
index 4967457..ce32778 100644
--- a/src/java/org/apache/ivy/plugins/parser/m2/PomModuleDescriptorBuilder.java
+++ b/src/java/org/apache/ivy/plugins/parser/m2/PomModuleDescriptorBuilder.java
@@ -716,7 +716,7 @@ public class PomModuleDescriptorBuilder {
/**
* Get PomDependencyData.
- *
+ *
* @return PomDependencyData
*/
public PomDependencyData getPomDependencyData() {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/parser/m2/PomWriterOptions.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/parser/m2/PomWriterOptions.java b/src/java/org/apache/ivy/plugins/parser/m2/PomWriterOptions.java
index 212ea1b..dbf9110 100644
--- a/src/java/org/apache/ivy/plugins/parser/m2/PomWriterOptions.java
+++ b/src/java/org/apache/ivy/plugins/parser/m2/PomWriterOptions.java
@@ -137,7 +137,7 @@ public class PomWriterOptions {
/**
* Returns the scope mapped to the given configuration array.
- *
+ *
* @param confs
* the configurations for which the scope should be returned
* @return the scope to which the conf is mapped
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/parser/xml/XmlModuleDescriptorWriter.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/parser/xml/XmlModuleDescriptorWriter.java b/src/java/org/apache/ivy/plugins/parser/xml/XmlModuleDescriptorWriter.java
index 828307b..8792f72 100644
--- a/src/java/org/apache/ivy/plugins/parser/xml/XmlModuleDescriptorWriter.java
+++ b/src/java/org/apache/ivy/plugins/parser/xml/XmlModuleDescriptorWriter.java
@@ -339,7 +339,7 @@ public final class XmlModuleDescriptorWriter {
/**
* Writes the extra attributes of the given {@link ExtendableItem} to the given
* <tt>PrintWriter</tt>.
- *
+ *
* @param item
* the {@link ExtendableItem}, cannot be <tt>null</tt>
* @param out
@@ -354,7 +354,7 @@ public final class XmlModuleDescriptorWriter {
/**
* Writes the specified <tt>Map</tt> containing the extra attributes to the given
* <tt>PrintWriter</tt>.
- *
+ *
* @param extra
* the extra attributes, can be <tt>null</tt>
* @param out
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/repository/Resource.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/repository/Resource.java b/src/java/org/apache/ivy/plugins/repository/Resource.java
index 950c02a..ebab257 100644
--- a/src/java/org/apache/ivy/plugins/repository/Resource.java
+++ b/src/java/org/apache/ivy/plugins/repository/Resource.java
@@ -45,14 +45,14 @@ import java.io.InputStream;
public interface Resource {
/**
* Get the name of the resource.
- *
+ *
* @return the repository's assigned resource name/identifier.
*/
public String getName();
/**
* Get the date the resource was last modified
- *
+ *
* @return A <code>long</code> value representing the time the file was last modified, measured
* in milliseconds since the epoch (00:00:00 GMT, January 1, 1970), or <code>0L</code>
* if the file does not exist or if an I/O error occurs.
@@ -61,7 +61,7 @@ public interface Resource {
/**
* Get the resource size
- *
+ *
* @return a <code>long</code> value representing the size of the resource in bytes.
*/
public long getContentLength();
@@ -69,21 +69,21 @@ public interface Resource {
/**
* Determine if the resource is available. Note that this method only checks for
* availability, not for actual existence.
- *
+ *
* @return <code>boolean</code> value indicating if the resource is available.
*/
public boolean exists();
/**
* Is this resource local to this host, i.e. is it on the file system?
- *
+ *
* @return <code>boolean</code> value indicating if the resource is local.
*/
public boolean isLocal();
/**
* Clones this resource with a new resource with a different name
- *
+ *
* @param cloneName
* the name of the clone
* @return the cloned resource
@@ -92,7 +92,7 @@ public interface Resource {
/**
* Opens a stream on this resource
- *
+ *
* @return the opened input stream
* @throws IOException if something goes wrong
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/repository/sftp/SFTPRepository.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/repository/sftp/SFTPRepository.java b/src/java/org/apache/ivy/plugins/repository/sftp/SFTPRepository.java
index 3b31ee9..d1e18e4 100644
--- a/src/java/org/apache/ivy/plugins/repository/sftp/SFTPRepository.java
+++ b/src/java/org/apache/ivy/plugins/repository/sftp/SFTPRepository.java
@@ -80,7 +80,7 @@ public class SFTPRepository extends AbstractSshBasedRepository {
/**
* This method is similar to getResource, except that the returned resource is fully initialized
* (resolved in the sftp repository), and that the given string is a full remote path
- *
+ *
* @param path
* the full remote path in the repository of the resource
* @return a fully initialized resource, able to answer to all its methods without needing any
@@ -237,7 +237,7 @@ public class SFTPRepository extends AbstractSshBasedRepository {
/**
* Checks the existence for a remote file
- *
+ *
* @param file
* to check
* @param channel
@@ -256,7 +256,7 @@ public class SFTPRepository extends AbstractSshBasedRepository {
* Establish the connection to the server if not yet connected, and listen to ivy events for
* closing connection when resolve is finished. Not meant to be used in multi threaded
* environment.
- *
+ *
* @return the ChannelSftp with which a connection is established
* @throws IOException
* if any connection problem occurs
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/repository/ssh/Scp.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/repository/ssh/Scp.java b/src/java/org/apache/ivy/plugins/repository/ssh/Scp.java
index 934ac7d..a8579dd 100644
--- a/src/java/org/apache/ivy/plugins/repository/ssh/Scp.java
+++ b/src/java/org/apache/ivy/plugins/repository/ssh/Scp.java
@@ -350,7 +350,7 @@ public class Scp {
/**
* Receive a file via scp and store it in a stream
- *
+ *
* @param channel
* ssh channel to use
* @param file
@@ -463,7 +463,7 @@ public class Scp {
/**
* Copy a local file to a remote site, uses the specified mode when creating the file on the
* remote side.
- *
+ *
* @param localFile
* Path and name of local file. Must be absolute.
* @param remoteTargetDir
@@ -522,7 +522,7 @@ public class Scp {
/**
* Download a file from the remote server to a local file.
- *
+ *
* @param remoteFile
* Path and name of the remote file.
* @param localTarget
@@ -540,7 +540,7 @@ public class Scp {
/**
* Download a file from the remote server into an OutputStream
- *
+ *
* @param remoteFile
* Path and name of the remote file.
* @param localTarget
@@ -577,7 +577,7 @@ public class Scp {
/**
* Initiates an SCP sequence but stops after getting fileinformation header
- *
+ *
* @param remoteFile
* to get information for
* @return the file information got
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/repository/ssh/SshRepository.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/repository/ssh/SshRepository.java b/src/java/org/apache/ivy/plugins/repository/ssh/SshRepository.java
index 4590a67..65dd378 100644
--- a/src/java/org/apache/ivy/plugins/repository/ssh/SshRepository.java
+++ b/src/java/org/apache/ivy/plugins/repository/ssh/SshRepository.java
@@ -59,6 +59,9 @@ public class SshRepository extends AbstractSshBasedRepository {
/**
* create a new resource with lazy initializing
+ *
+ * @param source String
+ * @return Resource
*/
public Resource getResource(String source) {
Message.debug("SShRepository:getResource called: " + source);
@@ -443,6 +446,8 @@ public class SshRepository extends AbstractSshBasedRepository {
/**
* return ssh as scheme use the Resolver type name here? would be nice if it would be static, so
* we could use SshResolver.getTypeName()
+ *
+ * @return String
*/
protected String getRepositoryScheme() {
return "ssh";
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/repository/ssh/SshResource.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/repository/ssh/SshResource.java b/src/java/org/apache/ivy/plugins/repository/ssh/SshResource.java
index 74a0cca..ac93ab4 100644
--- a/src/java/org/apache/ivy/plugins/repository/ssh/SshResource.java
+++ b/src/java/org/apache/ivy/plugins/repository/ssh/SshResource.java
@@ -62,7 +62,7 @@ public class SshResource implements Resource {
/*
* (non-Javadoc)
- *
+ *
* @see org.apache.ivy.repository.Resource#exists()
*/
public boolean exists() {
@@ -74,7 +74,7 @@ public class SshResource implements Resource {
/*
* (non-Javadoc)
- *
+ *
* @see org.apache.ivy.repository.Resource#getContentLength()
*/
public long getContentLength() {
@@ -86,7 +86,7 @@ public class SshResource implements Resource {
/*
* (non-Javadoc)
- *
+ *
* @see org.apache.ivy.repository.Resource#getLastModified()
*/
public long getLastModified() {
@@ -108,7 +108,7 @@ public class SshResource implements Resource {
/*
* (non-Javadoc)
- *
+ *
* @see org.apache.ivy.repository.Resource#getName()
*/
public String getName() {