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:03 UTC
[08/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/plugins/repository/vfs/VfsRepository.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/repository/vfs/VfsRepository.java b/src/java/org/apache/ivy/plugins/repository/vfs/VfsRepository.java
index 914757f..f086822 100644
--- a/src/java/org/apache/ivy/plugins/repository/vfs/VfsRepository.java
+++ b/src/java/org/apache/ivy/plugins/repository/vfs/VfsRepository.java
@@ -120,6 +120,7 @@ public class VfsRepository extends AbstractRepository {
*
* @param vfsURI
* a <code>String</code> identifying a VFS Resource
+ * @return Resource
* @throws IOException on failure
* @see "Supported File Systems in the jakarta-commons-vfs documentation"
*/
@@ -162,6 +163,7 @@ public class VfsRepository extends AbstractRepository {
*
* @param vfsURI
* providing identifying a VFS provided resource
+ * @return List
* @throws IOException
* on failure.
* @see "Supported File Systems in the jakarta-commons-vfs documentation"
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/resolver/AbstractPatternsBasedResolver.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/resolver/AbstractPatternsBasedResolver.java b/src/java/org/apache/ivy/plugins/resolver/AbstractPatternsBasedResolver.java
index ff99b8e..e493cce 100644
--- a/src/java/org/apache/ivy/plugins/resolver/AbstractPatternsBasedResolver.java
+++ b/src/java/org/apache/ivy/plugins/resolver/AbstractPatternsBasedResolver.java
@@ -272,7 +272,7 @@ public abstract class AbstractPatternsBasedResolver extends BasicResolver {
/**
* example of pattern : ~/Workspace/[module]/[module].ivy.xml
- *
+ *
* @param pattern String
*/
public void addIvyPattern(String pattern) {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/resolver/AbstractResolver.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/resolver/AbstractResolver.java b/src/java/org/apache/ivy/plugins/resolver/AbstractResolver.java
index b310ed8..ed8a3d9 100644
--- a/src/java/org/apache/ivy/plugins/resolver/AbstractResolver.java
+++ b/src/java/org/apache/ivy/plugins/resolver/AbstractResolver.java
@@ -133,7 +133,7 @@ public abstract class AbstractResolver implements DependencyResolver, HasLatestS
/**
* this method should remove sensitive information from a location to be displayed in a log
- *
+ *
* @param name
* location
* @return location with sensitive data replaced by stars
@@ -206,6 +206,10 @@ public abstract class AbstractResolver implements DependencyResolver, HasLatestS
/**
* Default implementation downloads the artifact without taking advantage of its location
+ *
+ * @param artifact ArtifactOrigin
+ * @param options DownloadOptions
+ * @return ArtifactDownloadReport
*/
public ArtifactDownloadReport download(ArtifactOrigin artifact, DownloadOptions options) {
DownloadReport r = download(new Artifact[] {artifact.getArtifact()}, options);
@@ -219,6 +223,9 @@ public abstract class AbstractResolver implements DependencyResolver, HasLatestS
/**
* Default implementation actually download the artifact Subclasses should overwrite this to
* avoid the download
+ *
+ * @param artifact ArtifactOrigin
+ * @return ArtifactOrigin
*/
public ArtifactOrigin locate(Artifact artifact) {
DownloadReport dr = download(new Artifact[] {artifact}, new DownloadOptions());
@@ -498,7 +505,7 @@ public abstract class AbstractResolver implements DependencyResolver, HasLatestS
/**
* Returns true if rmr1 is after rmr2, using the latest strategy to determine which is the
* latest
- *
+ *
* @param rmr1 ResolvedModuleRevision
* @param rmr2 ResolvedModuleRevision
* @param date Date
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/resolver/AbstractWorkspaceResolver.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/resolver/AbstractWorkspaceResolver.java b/src/java/org/apache/ivy/plugins/resolver/AbstractWorkspaceResolver.java
index 5444ab0..016bd99 100644
--- a/src/java/org/apache/ivy/plugins/resolver/AbstractWorkspaceResolver.java
+++ b/src/java/org/apache/ivy/plugins/resolver/AbstractWorkspaceResolver.java
@@ -226,7 +226,7 @@ public abstract class AbstractWorkspaceResolver extends AbstractResolver {
return newMd;
}
- abstract protected List<Artifact> createWorkspaceArtifacts(ModuleDescriptor md);
+ protected abstract List<Artifact> createWorkspaceArtifacts(ModuleDescriptor md);
public void publish(Artifact artifact, File src, boolean overwrite) throws IOException {
throw new UnsupportedOperationException("publish not supported by " + getName());
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/resolver/BasicResolver.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/resolver/BasicResolver.java b/src/java/org/apache/ivy/plugins/resolver/BasicResolver.java
index 3f550b0..ae0ce47 100644
--- a/src/java/org/apache/ivy/plugins/resolver/BasicResolver.java
+++ b/src/java/org/apache/ivy/plugins/resolver/BasicResolver.java
@@ -638,7 +638,7 @@ public abstract class BasicResolver extends AbstractResolver {
/**
* When the resolver has many choices, this function helps choosing one
- *
+ *
* @param rress
* the list of resolved resource which the resolver found to fit the requirement
* @param rmdparser
@@ -749,7 +749,7 @@ public abstract class BasicResolver extends AbstractResolver {
* <p>
* Remember to call the super implementation when overriding this method.
* </p>
- *
+ *
* @param names
* the list to filter.
* @return the filtered list
@@ -981,7 +981,7 @@ public abstract class BasicResolver extends AbstractResolver {
/**
* Checks the given resource checksum if a checksum resource exists.
- *
+ *
* @param resource
* the resource to check
* @param dest
@@ -1086,7 +1086,7 @@ public abstract class BasicResolver extends AbstractResolver {
/**
* Sets the module descriptor presence rule. Should be one of {@link #DESCRIPTOR_REQUIRED} or
* {@link #DESCRIPTOR_OPTIONAL}.
- *
+ *
* @param descriptorRule
* the descriptor rule to use with this resolver.
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/resolver/DualResolver.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/resolver/DualResolver.java b/src/java/org/apache/ivy/plugins/resolver/DualResolver.java
index 76b7e54..376a862 100644
--- a/src/java/org/apache/ivy/plugins/resolver/DualResolver.java
+++ b/src/java/org/apache/ivy/plugins/resolver/DualResolver.java
@@ -206,7 +206,7 @@ public class DualResolver extends AbstractResolver {
/**
* Sets the module descriptor presence rule. Should be one of {@link #DESCRIPTOR_REQUIRED} or
* {@link #DESCRIPTOR_OPTIONAL}.
- *
+ *
* @param descriptorRule
* the descriptor rule to use with this resolver.
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/resolver/FileSystemResolver.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/resolver/FileSystemResolver.java b/src/java/org/apache/ivy/plugins/resolver/FileSystemResolver.java
index f6e1e40..8f2aad8 100644
--- a/src/java/org/apache/ivy/plugins/resolver/FileSystemResolver.java
+++ b/src/java/org/apache/ivy/plugins/resolver/FileSystemResolver.java
@@ -46,7 +46,7 @@ public class FileSystemResolver extends RepositoryResolver {
/**
* Transactional mode.
- *
+ *
* auto: use transaction if possible, only log verbose message if not true: always use
* transaction, fail if not supported false: never use transactions
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/resolver/IBiblioResolver.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/resolver/IBiblioResolver.java b/src/java/org/apache/ivy/plugins/resolver/IBiblioResolver.java
index 7fa4780..7dc37b4 100644
--- a/src/java/org/apache/ivy/plugins/resolver/IBiblioResolver.java
+++ b/src/java/org/apache/ivy/plugins/resolver/IBiblioResolver.java
@@ -282,7 +282,7 @@ public class IBiblioResolver extends URLResolver {
/**
* Sets the root of the maven like repository. The maven like repository is necessarily an http
* repository.
- *
+ *
* @param root
* the root of the maven like repository
* @throws IllegalArgumentException
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/resolver/IvyRepResolver.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/resolver/IvyRepResolver.java b/src/java/org/apache/ivy/plugins/resolver/IvyRepResolver.java
index 7e08bbc..53b2d01 100644
--- a/src/java/org/apache/ivy/plugins/resolver/IvyRepResolver.java
+++ b/src/java/org/apache/ivy/plugins/resolver/IvyRepResolver.java
@@ -148,7 +148,7 @@ public class IvyRepResolver extends URLResolver {
/**
* Sets the root of the maven like repository. The maven like repository is necessarily an http
* repository.
- *
+ *
* @param root
* the root of the maven like repository
* @throws IllegalArgumentException
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/resolver/RepositoryResolver.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/resolver/RepositoryResolver.java b/src/java/org/apache/ivy/plugins/resolver/RepositoryResolver.java
index 0084da0..435a27a 100644
--- a/src/java/org/apache/ivy/plugins/resolver/RepositoryResolver.java
+++ b/src/java/org/apache/ivy/plugins/resolver/RepositoryResolver.java
@@ -169,7 +169,7 @@ public class RepositoryResolver extends AbstractPatternsBasedResolver {
/**
* List all revisions as resolved resources for the given artifact in the given repository using
* the given pattern, and using the given mrid except its revision.
- *
+ *
* @param repository
* the repository in which revisions should be located
* @param mrid
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/resolver/util/ResourceMDParser.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/resolver/util/ResourceMDParser.java b/src/java/org/apache/ivy/plugins/resolver/util/ResourceMDParser.java
index 211f8c7..7586027 100644
--- a/src/java/org/apache/ivy/plugins/resolver/util/ResourceMDParser.java
+++ b/src/java/org/apache/ivy/plugins/resolver/util/ResourceMDParser.java
@@ -22,7 +22,7 @@ import org.apache.ivy.plugins.repository.Resource;
public interface ResourceMDParser {
/**
* Parses the module descriptor designed by the given resource.
- *
+ *
* @param resource
* the resource at which the module descriptor is located
* @param rev
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/resolver/util/URLLister.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/resolver/util/URLLister.java b/src/java/org/apache/ivy/plugins/resolver/util/URLLister.java
index db1cd32..70fabcd 100644
--- a/src/java/org/apache/ivy/plugins/resolver/util/URLLister.java
+++ b/src/java/org/apache/ivy/plugins/resolver/util/URLLister.java
@@ -25,7 +25,7 @@ public interface URLLister {
/**
* Indicates if this lister is able to list urls with the given pattern. In general, only
* protocol is used.
- *
+ *
* @param pattern ditto
* @return boolean
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/trigger/AbstractTrigger.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/trigger/AbstractTrigger.java b/src/java/org/apache/ivy/plugins/trigger/AbstractTrigger.java
index c4e02a6..c588867 100644
--- a/src/java/org/apache/ivy/plugins/trigger/AbstractTrigger.java
+++ b/src/java/org/apache/ivy/plugins/trigger/AbstractTrigger.java
@@ -29,7 +29,7 @@ import org.apache.ivy.util.filter.Filter;
* the only method to implement in subclasses is {@link IvyListener#progress(IvyEvent)} which should
* do whatever the trigger needs to do when the event occurs. This method will only be called when
* an event matching the trigger filter occurs.
- *
+ *
* @since 1.4
*/
public abstract class AbstractTrigger implements Trigger {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/trigger/LogTrigger.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/trigger/LogTrigger.java b/src/java/org/apache/ivy/plugins/trigger/LogTrigger.java
index 08d4d1a..b66f1a3 100644
--- a/src/java/org/apache/ivy/plugins/trigger/LogTrigger.java
+++ b/src/java/org/apache/ivy/plugins/trigger/LogTrigger.java
@@ -54,7 +54,7 @@ public class LogTrigger extends AbstractTrigger {
/**
* Logs the given message.
- *
+ *
* @param message
* the message to log
*/
@@ -92,7 +92,7 @@ public class LogTrigger extends AbstractTrigger {
/**
* Message to write.
- *
+ *
* @param msg
* Sets the value for the message variable.
*/
@@ -102,7 +102,7 @@ public class LogTrigger extends AbstractTrigger {
/**
* File to write to.
- *
+ *
* @param file
* the file to write to, if not set, echo to standard Ivy logging
*/
@@ -112,7 +112,7 @@ public class LogTrigger extends AbstractTrigger {
/**
* If true, append to existing file.
- *
+ *
* @param append
* if true, append to existing file, default is false.
*/
@@ -123,7 +123,7 @@ public class LogTrigger extends AbstractTrigger {
/**
* Declare the encoding to use when outputting to a file; Use "" for the platform's default
* encoding.
- *
+ *
* @param encoding
* the character encoding to use.
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/version/AbstractVersionMatcher.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/version/AbstractVersionMatcher.java b/src/java/org/apache/ivy/plugins/version/AbstractVersionMatcher.java
index b127005..e0f711f 100644
--- a/src/java/org/apache/ivy/plugins/version/AbstractVersionMatcher.java
+++ b/src/java/org/apache/ivy/plugins/version/AbstractVersionMatcher.java
@@ -56,6 +56,11 @@ public abstract class AbstractVersionMatcher implements VersionMatcher, IvySetti
/**
* This method should be overridden in most cases, because it uses the default contract to
* return 1 when it's not possible to know which revision is greater.
+ *
+ * @param askedMrid ModuleRevisionId
+ * @param foundMrid ModuleRevisionId
+ * @param staticComparator Comparator
+ * @return int
*/
public int compare(ModuleRevisionId askedMrid, ModuleRevisionId foundMrid,
Comparator staticComparator) {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/version/ChainVersionMatcher.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/version/ChainVersionMatcher.java b/src/java/org/apache/ivy/plugins/version/ChainVersionMatcher.java
index a1c159d..e5e82b2 100644
--- a/src/java/org/apache/ivy/plugins/version/ChainVersionMatcher.java
+++ b/src/java/org/apache/ivy/plugins/version/ChainVersionMatcher.java
@@ -50,7 +50,7 @@ public class ChainVersionMatcher extends AbstractVersionMatcher {
/**
* Adds a {@link VersionMatcher} to the chain.
- *
+ *
* @param matcher
* the version matcher to add. Must not be null
*/
@@ -65,7 +65,7 @@ public class ChainVersionMatcher extends AbstractVersionMatcher {
/**
* Sets the settings this matcher will use, and set to the matcher in the chain which implements
* {@link IvySettingsAware}.
- *
+ *
* @param settings
* the settings to use in the whole chain. Must not be null.
*/
@@ -84,7 +84,7 @@ public class ChainVersionMatcher extends AbstractVersionMatcher {
* <p>
* The list is returned as an unmodifiable view on the actual list of matchers, and will thus
* reflect further changes made in the chain.
- *
+ *
* @return the list of matchers in the chain. Is never null.
*/
public List getMatchers() {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/version/LatestVersionMatcher.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/version/LatestVersionMatcher.java b/src/java/org/apache/ivy/plugins/version/LatestVersionMatcher.java
index cc60696..dbfe79e 100644
--- a/src/java/org/apache/ivy/plugins/version/LatestVersionMatcher.java
+++ b/src/java/org/apache/ivy/plugins/version/LatestVersionMatcher.java
@@ -61,6 +61,11 @@ public class LatestVersionMatcher extends AbstractVersionMatcher {
/**
* If we don't need a module descriptor we can consider the dynamic revision to be greater. If
* we need a module descriptor then we can't know which one is greater and return 0.
+ *
+ * @param askedMrid ModuleRevisionId
+ * @param foundMrid ModuleRevisionId
+ * @param staticComparator Comparator
+ * @return int
*/
public int compare(ModuleRevisionId askedMrid, ModuleRevisionId foundMrid,
Comparator staticComparator) {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/version/Match.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/version/Match.java b/src/java/org/apache/ivy/plugins/version/Match.java
index 85465cc..cb02d30 100644
--- a/src/java/org/apache/ivy/plugins/version/Match.java
+++ b/src/java/org/apache/ivy/plugins/version/Match.java
@@ -30,7 +30,7 @@ import org.apache.ivy.plugins.matcher.Matcher;
import org.apache.ivy.plugins.matcher.PatternMatcher;
/**
- *
+ *
*/
public class Match {
private String revision;
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/plugins/version/PatternVersionMatcher.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/plugins/version/PatternVersionMatcher.java b/src/java/org/apache/ivy/plugins/version/PatternVersionMatcher.java
index 66f51a2..a108847 100644
--- a/src/java/org/apache/ivy/plugins/version/PatternVersionMatcher.java
+++ b/src/java/org/apache/ivy/plugins/version/PatternVersionMatcher.java
@@ -27,7 +27,7 @@ import org.apache.ivy.core.module.id.ModuleRevisionId;
import org.apache.ivy.plugins.matcher.Matcher;
/**
- *
+ *
*/
public class PatternVersionMatcher extends AbstractVersionMatcher {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/util/AbstractMessageLogger.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/util/AbstractMessageLogger.java b/src/java/org/apache/ivy/util/AbstractMessageLogger.java
index 5e2f8e9..8a203dd 100644
--- a/src/java/org/apache/ivy/util/AbstractMessageLogger.java
+++ b/src/java/org/apache/ivy/util/AbstractMessageLogger.java
@@ -120,7 +120,7 @@ public abstract class AbstractMessageLogger implements MessageLogger {
/**
* Indicates the end of a long running task
- *
+ *
* @param msg
* the message associated with long running task end.
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/util/Checks.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/util/Checks.java b/src/java/org/apache/ivy/util/Checks.java
index 6b9e927..9e94ba8 100644
--- a/src/java/org/apache/ivy/util/Checks.java
+++ b/src/java/org/apache/ivy/util/Checks.java
@@ -28,7 +28,7 @@ public final class Checks {
/**
* Checks that an object is not null, and throw an exception if the object is null.
- *
+ *
* @param o
* the object to check
* @param objectName
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/util/ChecksumHelper.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/util/ChecksumHelper.java b/src/java/org/apache/ivy/util/ChecksumHelper.java
index b3d1e61..d873e4c 100644
--- a/src/java/org/apache/ivy/util/ChecksumHelper.java
+++ b/src/java/org/apache/ivy/util/ChecksumHelper.java
@@ -67,7 +67,7 @@ public final class ChecksumHelper {
/**
* Checks the checksum of the given file against the given checksumFile, and throws an
* IOException if the checksum is not compliant
- *
+ *
* @param dest
* the file to test
* @param checksumFile
@@ -159,7 +159,7 @@ public final class ChecksumHelper {
/**
* Convert a byte[] array to readable string format. This makes the "hex" readable!
- *
+ *
* @return result String buffer in String format
* @param in
* byte[] buffer to convert to string format
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/util/ConfigurationUtils.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/util/ConfigurationUtils.java b/src/java/org/apache/ivy/util/ConfigurationUtils.java
index 343ece9..597942c 100644
--- a/src/java/org/apache/ivy/util/ConfigurationUtils.java
+++ b/src/java/org/apache/ivy/util/ConfigurationUtils.java
@@ -40,7 +40,7 @@ public final class ConfigurationUtils {
/**
* Replace the wildcards in the given configuration array, by the name of the given
* ModuleDescriptor
- *
+ *
* The supported wildcards are:
* <ul>
* <li><b><tt>*</tt> :</b> all configurations</li>
@@ -49,7 +49,7 @@ public final class ConfigurationUtils {
* </ul>
* If the given array of configurations is <code>null</code>, all configurations from the given
* module descriptor are returned, including if this array is empty.
- *
+ *
* @param confs
* the configurations, can contain wildcards
* @param md
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/util/Configurator.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/util/Configurator.java b/src/java/org/apache/ivy/util/Configurator.java
index 9513070..4350049 100644
--- a/src/java/org/apache/ivy/util/Configurator.java
+++ b/src/java/org/apache/ivy/util/Configurator.java
@@ -40,7 +40,7 @@ import org.apache.ivy.core.IvyPatternHelper;
* <p>
* Example (based on <a href="http://ant.apache.org/manual/develop.html#writingowntask">Ant
* Example</a>):
- *
+ *
* <pre>
* Configurator conf = new Configurator();
* conf.typeDef("buildpath", "Sample$BuildPath");
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/util/Credentials.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/util/Credentials.java b/src/java/org/apache/ivy/util/Credentials.java
index 682e35a..613c9c9 100644
--- a/src/java/org/apache/ivy/util/Credentials.java
+++ b/src/java/org/apache/ivy/util/Credentials.java
@@ -18,7 +18,7 @@
package org.apache.ivy.util;
/**
- *
+ *
*/
public class Credentials {
private String realm;
@@ -63,6 +63,8 @@ public class Credentials {
/**
* Return a string that can be used for debug purpose. It contains only stars for each password
* character.
+ *
+ * @return String
*/
public String toString() {
return getKey() + " " + getUserName() + "/" + getPasswdAsStars();
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/util/FileResolver.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/util/FileResolver.java b/src/java/org/apache/ivy/util/FileResolver.java
index 75e918c..b951c5e 100644
--- a/src/java/org/apache/ivy/util/FileResolver.java
+++ b/src/java/org/apache/ivy/util/FileResolver.java
@@ -30,15 +30,15 @@ public interface FileResolver {
* Return the canonical form of a path, or raise an {@link IllegalArgumentException} if the path
* is not valid for this {@link FileResolver}.
* <p>
- *
+ *
* @param path
* The path of the file to resolve. Must not be <code>null</code>.
* @param filename
* The name of the file to resolve. This is used only for exception message if any.
* Must not be <code>null</code>.
- *
+ *
* @return the resolved File.
- *
+ *
*/
File resolveFile(String path, String filename);
}
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/util/FileUtil.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/util/FileUtil.java b/src/java/org/apache/ivy/util/FileUtil.java
index 17fbaf4..ad4fb10 100644
--- a/src/java/org/apache/ivy/util/FileUtil.java
+++ b/src/java/org/apache/ivy/util/FileUtil.java
@@ -362,7 +362,7 @@ public final class FileUtil {
* <p>
* The BufferedReader is closed when this method returns.
* </p>
- *
+ *
* @param in
* the {@link BufferedReader} to read from
* @return a String with the whole content read from the {@link BufferedReader}
@@ -386,7 +386,7 @@ public final class FileUtil {
/**
* Reads the entire content of the file and returns it as a String.
- *
+ *
* @param f
* the file to read from
* @return a String with the file content
@@ -402,7 +402,7 @@ public final class FileUtil {
* <p>
* The input stream is closed when this method returns.
* </p>
- *
+ *
* @param is
* the {@link InputStream} to read from
* @return a String with the input stream content
@@ -430,7 +430,7 @@ public final class FileUtil {
/**
* Recursively delete file
- *
+ *
* @param file
* the file to delete
* @return true if the deletion completed successfully (ie if the file does not exist on the
@@ -523,7 +523,7 @@ public final class FileUtil {
/**
* "Normalize" the given absolute path.
- *
+ *
* <p>
* This includes:
* <ul>
@@ -534,7 +534,7 @@ public final class FileUtil {
* </ul>
* Unlike {@link File#getCanonicalPath()} this method specifically does not resolve symbolic
* links.
- *
+ *
* @param path the path to be normalized.
* @return the normalized version of the path.
* @throws NullPointerException if path is null.
@@ -602,7 +602,7 @@ public final class FileUtil {
sbPath.append(currentChar);
continue;
}
- final char previousChar = rest.charAt(i -1);
+ final char previousChar = rest.charAt(i - 1);
if (currentChar != sep || previousChar != sep) {
sbPath.append(currentChar);
}
@@ -625,7 +625,7 @@ public final class FileUtil {
/**
* Get the length of the file, or the sum of the children lengths if it is a directory
- *
+ *
* @param file File
* @return long
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/util/HostUtil.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/util/HostUtil.java b/src/java/org/apache/ivy/util/HostUtil.java
index ae4a41b..5f32184 100644
--- a/src/java/org/apache/ivy/util/HostUtil.java
+++ b/src/java/org/apache/ivy/util/HostUtil.java
@@ -22,7 +22,7 @@ import java.net.UnknownHostException;
/**
* This class contains basic helper methods for the Host.
- *
+ *
*/
public final class HostUtil {
@@ -37,7 +37,7 @@ public final class HostUtil {
/**
* This method returns the name of the current Host, if this name cannot be determined,
* localhost will be returned.
- *
+ *
* @return The name of the current "local" Host.
*/
public static String getLocalHostName() {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/util/MemoryUtil.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/util/MemoryUtil.java b/src/java/org/apache/ivy/util/MemoryUtil.java
index d27beba..db425f1 100644
--- a/src/java/org/apache/ivy/util/MemoryUtil.java
+++ b/src/java/org/apache/ivy/util/MemoryUtil.java
@@ -30,7 +30,7 @@ public final class MemoryUtil {
/**
* Returns the approximate size of a default instance of the given class.
- *
+ *
* @param clazz
* the class to evaluate.
* @return the estimated size of instance, in bytes.
@@ -57,7 +57,7 @@ public final class MemoryUtil {
* Returns the currently used memory, after calling garbage collector and waiting enough to get
* maximal chance it is actually called. But since {@link Runtime#gc()} is only advisory,
* results returned by this method should be treated as rough approximation only.
- *
+ *
* @return the currently used memory, in bytes.
*/
public static long getUsedMemory() {
@@ -86,4 +86,4 @@ public final class MemoryUtil {
public static void main(String[] args) throws ClassNotFoundException {
System.out.println(sizeOf(Class.forName(args[0])));
}
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/util/Message.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/util/Message.java b/src/java/org/apache/ivy/util/Message.java
index 1e6b67f..8259d0e 100644
--- a/src/java/org/apache/ivy/util/Message.java
+++ b/src/java/org/apache/ivy/util/Message.java
@@ -55,7 +55,7 @@ public final class Message {
/**
* Returns the current default logger.
- *
+ *
* @return the current default logger; is never <code>null</code>.
*/
public static MessageLogger getDefaultLogger() {
@@ -64,7 +64,7 @@ public final class Message {
/**
* Change the default logger used when no other logger is currently configured
- *
+ *
* @param logger
* the new default logger, must not be <code>null</code>
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/util/MessageLogger.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/util/MessageLogger.java b/src/java/org/apache/ivy/util/MessageLogger.java
index f08c0a5..623680f 100644
--- a/src/java/org/apache/ivy/util/MessageLogger.java
+++ b/src/java/org/apache/ivy/util/MessageLogger.java
@@ -32,7 +32,7 @@ import java.util.List;
* message at a lower level (usually {@link Message#MSG_VERBOSE}) and log the message at the actual
* level only when {@link #sumupProblems()} is called.
* </p>
- *
+ *
* @see Message
*/
public interface MessageLogger {
@@ -41,7 +41,7 @@ public interface MessageLogger {
* <p>
* <code>level</code> constants are defined in the {@link Message} class.
* </p>
- *
+ *
* @param msg
* the message to log
* @param level
@@ -57,7 +57,7 @@ public interface MessageLogger {
/**
* Same as {@link #log(String, int)}, but without adding any contextual information to the
* message.
- *
+ *
* @param msg
* the message to log
* @param level
@@ -105,4 +105,4 @@ public interface MessageLogger {
public abstract void setShowProgress(boolean progress);
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/util/MessageLoggerEngine.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/util/MessageLoggerEngine.java b/src/java/org/apache/ivy/util/MessageLoggerEngine.java
index 07c5658..c8ec767 100644
--- a/src/java/org/apache/ivy/util/MessageLoggerEngine.java
+++ b/src/java/org/apache/ivy/util/MessageLoggerEngine.java
@@ -57,7 +57,7 @@ public class MessageLoggerEngine implements MessageLogger {
/**
* Sets the logger used when the stack is empty.
- *
+ *
* @param defaultLogger
* the logger to use when the stack is empty.
*/
@@ -67,7 +67,7 @@ public class MessageLoggerEngine implements MessageLogger {
/**
* Push a logger on the stack.
- *
+ *
* @param logger
* the logger to push. Must not be <code>null</code>.
*/
@@ -90,7 +90,7 @@ public class MessageLoggerEngine implements MessageLogger {
/**
* Returns the current logger, or the default one if there is no logger in the stack
- *
+ *
* @return the current logger, or the default one if there is no logger in the stack
*/
public MessageLogger peekLogger() {
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/util/StringUtils.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/util/StringUtils.java b/src/java/org/apache/ivy/util/StringUtils.java
index 01f31dc..c179f8a 100644
--- a/src/java/org/apache/ivy/util/StringUtils.java
+++ b/src/java/org/apache/ivy/util/StringUtils.java
@@ -46,7 +46,7 @@ public final class StringUtils {
* Returns the error message associated with the given Throwable. The error message returned
* will try to be as precise as possible, handling cases where e.getMessage() is not meaningful,
* like {@link NullPointerException} for instance.
- *
+ *
* @param t the throwable to get the error message from
* @return the error message of the given exception
*/
@@ -67,7 +67,7 @@ public final class StringUtils {
/**
* Returns the exception stack trace as a String.
- *
+ *
* @param e
* the exception to get the stack trace from.
* @return the exception stack trace
@@ -84,13 +84,13 @@ public final class StringUtils {
/**
* Joins the given object array in one string, each separated by the given separator.
- *
+ *
* Example:
- *
+ *
* <pre>
* join(new String[] {"one", "two", "three"}, ", ") -> "one, two, three"
* </pre>
- *
+ *
* @param objs
* The array of objects (<code>toString()</code> is used).
* @param sep
@@ -132,7 +132,7 @@ public final class StringUtils {
* easily decrypt. This is useful only to avoid clear string storage in a file for example, but
* shouldn't be considered as a real mean of security. This only works with simple characters
* (char < 256).
- *
+ *
* @param str
* the string to encrypt
* @return the encrypted version of the string
@@ -156,7 +156,7 @@ public final class StringUtils {
/**
* Decrypts a string encrypted with encrypt.
- *
+ *
* @param str
* the encrypted string to decrypt
* @return The decrypted string.
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/util/extendable/ExtendableItem.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/util/extendable/ExtendableItem.java b/src/java/org/apache/ivy/util/extendable/ExtendableItem.java
index 408be7e..7a8724f 100644
--- a/src/java/org/apache/ivy/util/extendable/ExtendableItem.java
+++ b/src/java/org/apache/ivy/util/extendable/ExtendableItem.java
@@ -23,7 +23,7 @@ public interface ExtendableItem {
/**
* Gets the value of an attribute Can be used to access the value of a standard attribute (like
* organisation, revision) or of an extra attribute.
- *
+ *
* @param attName
* the name of the attribute to get
* @return the value of the attribute, null if the attribute doesn't exist
@@ -33,7 +33,7 @@ public interface ExtendableItem {
/**
* Gets the value of an extra attribute Can be used only to access the value of an extra
* attribute, not a standard one (like organisation, revision)
- *
+ *
* @param attName
* the name of the extra attribute to get. This name can be either qualified or
* unqualified.
@@ -45,7 +45,7 @@ public interface ExtendableItem {
* Returns a Map of all attributes of this extendable item, including standard and extra ones.
* The Map keys are attribute names as Strings, and values are corresponding attribute values
* (as String too). Extra attributes are included in unqualified form only.
- *
+ *
* @return A Map instance containing all the attributes and their values.
*/
Map<String, String> getAttributes();
@@ -54,7 +54,7 @@ public interface ExtendableItem {
* Returns a Map of all extra attributes of this extendable item. The Map keys are
* <b>unqualified</b> attribute names as Strings, and values are corresponding attribute values
* (as String too)
- *
+ *
* @return A Map instance containing all the extra attributes and their values.
* @see #getQualifiedExtraAttributes()
*/
@@ -70,7 +70,7 @@ public interface ExtendableItem {
* An attribute name is qualified with a namespace exactly the same way xml attributes are
* qualified. Thus qualified attribute names are of the form <code>prefix:name</code>
* </p>
- *
+ *
* @return A Map instance containing all the extra attributes and their values.
* @see #getExtraAttributes()
*/
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/util/extendable/ExtendableItemHelper.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/util/extendable/ExtendableItemHelper.java b/src/java/org/apache/ivy/util/extendable/ExtendableItemHelper.java
index 3cc0f8d..56eb3a0 100644
--- a/src/java/org/apache/ivy/util/extendable/ExtendableItemHelper.java
+++ b/src/java/org/apache/ivy/util/extendable/ExtendableItemHelper.java
@@ -42,7 +42,7 @@ public final class ExtendableItemHelper {
/**
* Extract from the XML attribute the extra Ivy ones
- *
+ *
* @param settings ParserSettings
* @param attributes Attributes
* @param ignoredAttNames
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/util/filter/FilterHelper.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/util/filter/FilterHelper.java b/src/java/org/apache/ivy/util/filter/FilterHelper.java
index a665a00..6022778 100644
--- a/src/java/org/apache/ivy/util/filter/FilterHelper.java
+++ b/src/java/org/apache/ivy/util/filter/FilterHelper.java
@@ -61,7 +61,7 @@ public final class FilterHelper {
* The filter to use.
* @return a new collection instance containing the only the the items from the given
* collection, which are accepted by the filter.
- *
+ *
* <p>
* Comment: We could have used
* <a href="http://jakarta.apache.org/commons/collections/">Commons Collections</a> facility for
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/util/url/ApacheURLLister.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/util/url/ApacheURLLister.java b/src/java/org/apache/ivy/util/url/ApacheURLLister.java
index b1dc456..7243697 100644
--- a/src/java/org/apache/ivy/util/url/ApacheURLLister.java
+++ b/src/java/org/apache/ivy/util/url/ApacheURLLister.java
@@ -47,7 +47,7 @@ public class ApacheURLLister {
/**
* Returns a list of sub urls of the given url. The returned list is a list of URL.
- *
+ *
* @param url
* The base URL from which to retrieve the listing.
* @return a list of sub urls of the given url.
@@ -60,7 +60,7 @@ public class ApacheURLLister {
/**
* Returns a list of sub 'directories' of the given url. The returned list is a list of URL.
- *
+ *
* @param url
* The base URL from which to retrieve the listing.
* @return a list of sub 'directories' of the given url.
@@ -74,7 +74,7 @@ public class ApacheURLLister {
/**
* Returns a list of sub 'files' (in opposition to directories) of the given url. The returned
* list is a list of URL.
- *
+ *
* @param url
* The base URL from which to retrieve the listing.
* @return a list of sub 'files' of the given url.
@@ -88,7 +88,7 @@ public class ApacheURLLister {
/**
* Retrieves a {@link List} of {@link URL}s corresponding to the files and/or directories found
* at the supplied base URL.
- *
+ *
* @param url
* The base URL from which to retrieve the listing.
* @param includeFiles
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/util/url/BasicURLHandler.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/util/url/BasicURLHandler.java b/src/java/org/apache/ivy/util/url/BasicURLHandler.java
index 51e0de1..50a0fbc 100644
--- a/src/java/org/apache/ivy/util/url/BasicURLHandler.java
+++ b/src/java/org/apache/ivy/util/url/BasicURLHandler.java
@@ -34,7 +34,7 @@ import org.apache.ivy.util.FileUtil;
import org.apache.ivy.util.Message;
/**
- *
+ *
*/
public class BasicURLHandler extends AbstractURLHandler {
@@ -100,7 +100,7 @@ public class BasicURLHandler extends AbstractURLHandler {
/**
* Extract the charset from the Content-Type header string, or default to ISO-8859-1 as per
* rfc2616-sec3.html#sec3.7.1 .
- *
+ *
* @param contentType
* the Content-Type header string
* @return the charset as specified in the content type, or ISO-8859-1 if unspecified.
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/util/url/CredentialsStore.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/util/url/CredentialsStore.java b/src/java/org/apache/ivy/util/url/CredentialsStore.java
index 50b973c..fa4c955 100644
--- a/src/java/org/apache/ivy/util/url/CredentialsStore.java
+++ b/src/java/org/apache/ivy/util/url/CredentialsStore.java
@@ -26,7 +26,7 @@ import org.apache.ivy.util.Credentials;
import org.apache.ivy.util.Message;
/**
- *
+ *
*/
public final class CredentialsStore {
/**
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/ef719aca/src/java/org/apache/ivy/util/url/IvyAuthenticator.java
----------------------------------------------------------------------
diff --git a/src/java/org/apache/ivy/util/url/IvyAuthenticator.java b/src/java/org/apache/ivy/util/url/IvyAuthenticator.java
index 40fa50a..905da4e 100644
--- a/src/java/org/apache/ivy/util/url/IvyAuthenticator.java
+++ b/src/java/org/apache/ivy/util/url/IvyAuthenticator.java
@@ -25,7 +25,7 @@ import org.apache.ivy.util.Credentials;
import org.apache.ivy.util.Message;
/**
- *
+ *
*/
public final class IvyAuthenticator extends Authenticator {