http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/version/VersionMatcher.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/version/VersionMatcher.java b/src/java/org/apache/ivy/plugins/version/VersionMatcher.java index 41f9533..184b28e 100644 --- a/src/java/org/apache/ivy/plugins/version/VersionMatcher.java +++ b/src/java/org/apache/ivy/plugins/version/VersionMatcher.java @@ -45,7 +45,7 @@ public interface VersionMatcher { /** * Indicates if the given asked ModuleRevisionId should be considered as dynamic for the current * VersionMatcher or not. - * + * * @param askedMrid * the dependency module revision id as asked by a module * @return true if this revision is considered as a dynamic one, false otherwise @@ -55,7 +55,7 @@ public interface VersionMatcher { /** * Indicates if this version matcher considers that the module revision found matches the asked * one. - * + * * @param askedMrid ModuleRevisionId * @param foundMrid ModuleRevisionId * @return boolean @@ -66,7 +66,9 @@ public interface VersionMatcher { * Indicates if this VersionMatcher needs module descriptors to determine if a module revision * matches the asked one. Note that returning true in this method may imply big performance * issues. - * + * + * @param askedMrid ModuleRevisionId + * @param foundMrid ModuleRevisionId * @return boolean */ public boolean needModuleDescriptor(ModuleRevisionId askedMrid, ModuleRevisionId foundMrid); @@ -76,7 +78,7 @@ public interface VersionMatcher { * method can be called even needModuleDescriptor(ModuleRevisionId askedMrid, ModuleRevisionId * foundMrid) returns false, so it is required to implement it in any case, a usual default * implementation being: return accept(askedMrid, foundMD.getResolvedModuleRevisionId()); - * + * * @param askedMrid ModuleRevisionId * @param foundMD ModuleDescriptor * @return boolean @@ -88,7 +90,7 @@ public interface VersionMatcher { * should be considered the greater. If there is not enough information to know which one is the * greater, the dynamic one should be considered greater and this method should return 0. This * method should never be called with a askedMrid for which isDynamic returns false. - * + * * @param askedMrid * the dynamic revision to compare * @param foundMrid @@ -103,7 +105,7 @@ public interface VersionMatcher { /** * Returns the version matcher name identifying this version matcher - * + * * @return the version matcher name identifying this version matcher */ public String getName();
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/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 aca4007..c938007 100644 --- a/src/java/org/apache/ivy/util/FileUtil.java +++ b/src/java/org/apache/ivy/util/FileUtil.java @@ -57,9 +57,9 @@ public final class FileUtil { // Utility class } - // according to tests by users, 64kB seems to be a good value for the buffer used during copy + // according to tests by users, 64kB seems to be a good value for the buffer used during copy; // further improvements could be obtained using NIO API - private static final int BUFFER_SIZE = 64 * 1024; + private static final int BUFFER_SIZE = 64 * 1024; private static final byte[] EMPTY_BUFFER = new byte[0]; @@ -67,13 +67,12 @@ public final class FileUtil { public static void symlinkInMass(Map<File, File> destToSrcMap, boolean overwrite) throws IOException { - - // This pattern could be more forgiving if somebody wanted it to be... - // ...but this should satisfy 99+% of all needs, without letting unsafe operations be done. + // This pattern could be more forgiving if somebody wanted it to be... but this should + // satisfy 99+% of all needs, without letting unsafe operations be done. // If you paths is not supported, you then skip this mass option. // NOTE: A space inside the path is allowed (I can't control other programmers who like them - // in their working directory names)... - // but trailing spaces on file names will be checked otherwise and refused. + // in their working directory names)... but trailing spaces on file names will be checked + // otherwise and refused. try { StringBuffer sb = new StringBuffer(); @@ -456,10 +455,14 @@ public final class FileUtil { /** * Returns a list of Files composed of all directories being parent of file and child of root + - * file and root themselves. Example: getPathFiles(new File("test"), new - * File("test/dir1/dir2/file.txt")) => {new File("test/dir1"), new File("test/dir1/dir2"), new - * File("test/dir1/dir2/file.txt") } Note that if root is not an ancestor of file, or if root is - * null, all directories from the file system root will be returned. + * file and root themselves. Example: <code>getPathFiles(new File("test"), new + * File("test/dir1/dir2/file.txt")) => {new File("test/dir1"), new File("test/dir1/dir2"), + * new File("test/dir1/dir2/file.txt") }</code> Note that if root is not an ancestor of file, or + * if root is null, all directories from the file system root will be returned. + * + * @param root File + * @param file File + * @return List<File> */ public static List<File> getPathFiles(File root, File file) { List<File> ret = new ArrayList<File>(); @@ -475,15 +478,13 @@ public final class FileUtil { } /** - * Returns a collection of all Files being contained in the given directory, recursively, - * including directories. - * * @param dir * The directory from which all files, including files in subdirectory) are * extracted. * @param ignore * a Collection of filenames which must be excluded from listing - * @return A collection containing all the files of the given directory and it's subdirectories. + * @return a collection containing all the files of the given directory and it's subdirectories, + * recursively. */ public static Collection<File> listAll(File dir, Collection<String> ignore) { return listAll(dir, new ArrayList<File>(), ignore); @@ -534,12 +535,9 @@ public final class FileUtil { * Unlike {@link File#getCanonicalPath()} this method specifically does not resolve symbolic * links. * - * @param path - * the path to be normalized. + * @param path the path to be normalized. * @return the normalized version of the path. - * - * @throws java.lang.NullPointerException - * if path is null. + * @throws NullPointerException if path is null. */ public static File normalize(final String path) { Stack<String> s = new Stack<String>(); @@ -577,21 +575,20 @@ public final class FileUtil { /** * Dissect the specified absolute path. * - * @param path - * the path to dissect. + * @param path the path to dissect. * @return String[] {root, remaining path}. - * @throws java.lang.NullPointerException - * if path is null. + * @throws NullPointerException if path is null. * @since Ant 1.7 */ private static String[] dissect(String path) { char sep = File.separatorChar; path = path.replace('/', sep).replace('\\', sep); - // // make sure we are dealing with an absolute path - // if (!isAbsolutePath(path)) { - // throw new BuildException(path + " is not an absolute path"); - // } + /* // make sure we are dealing with an absolute path + * if (!isAbsolutePath(path)) { + * throw new BuildException(path + " is not an absolute path"); + * } + */ String root = null; int colon = path.indexOf(':'); if (colon > 0) { // && (ON_DOS || ON_NETWARE)) { @@ -627,8 +624,8 @@ public final class FileUtil { /** * Get the length of the file, or the sum of the children lengths if it is a directory * - * @param file - * @return + * @param file File + * @return long */ public static long getFileLength(File file) { long l = 0; http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/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 1151872..01f31dc 100644 --- a/src/java/org/apache/ivy/util/StringUtils.java +++ b/src/java/org/apache/ivy/util/StringUtils.java @@ -47,8 +47,7 @@ public final class StringUtils { * 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 + * @param t the throwable to get the error message from * @return the error message of the given exception */ public static String getErrorMessage(Throwable t) { @@ -89,7 +88,7 @@ public final class StringUtils { * Example: * * <pre> - * join(new String[] {"one", "two", "three"}, ", ") -> "one, two, three" + * join(new String[] {"one", "two", "three"}, ", ") -> "one, two, three" * </pre> * * @param objs @@ -110,7 +109,9 @@ public final class StringUtils { } // basic string codec (same algo as CVS passfile, inspired by ant CVSPass class - /** Array contain char conversion data */ + /** + * Array containing char conversion data + */ private static final char[] SHIFTS = {0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 114, 120, 53, 79, 96, 109, 72, 108, 70, 64, 76, 67, 116, 74, 68, 87, 111, 52, 75, 119, 49, 34, 82, 81, 95, 65, @@ -130,7 +131,7 @@ public final class StringUtils { * Encrypt the given string in a way which anybody having access to this method algorithm can * 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). + * (char < 256). * * @param str * the string to encrypt http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/util/XMLHelper.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/util/XMLHelper.java b/src/java/org/apache/ivy/util/XMLHelper.java index 78d691e..894ccc8 100644 --- a/src/java/org/apache/ivy/util/XMLHelper.java +++ b/src/java/org/apache/ivy/util/XMLHelper.java @@ -95,6 +95,9 @@ public abstract class XMLHelper { /** * Convert an URL to a valid systemId according to RFC 2396. + * + * @param url URL + * @return String */ public static String toSystemId(URL url) { try { @@ -105,9 +108,9 @@ public abstract class XMLHelper { } // IMPORTANT: validation errors are only notified to the given handler, and - // do not cause exception - // implement warning error and fatalError methods in handler to be informed - // of validation errors + // do not cause exception implement warning error and fatalError methods in + // handler to be informed of validation errors + public static void parse(URL xmlURL, URL schema, DefaultHandler handler) throws SAXException, IOException, ParserConfigurationException { parse(xmlURL, schema, handler, null); @@ -177,12 +180,12 @@ public abstract class XMLHelper { /** * Escapes invalid XML characters in the given character data using XML entities. For the - * moment, only the following characters are being escaped: (<), (&), (') and ("). - * - * Remark: we don't escape the (>) character to keep the readability of the configuration - * mapping! The XML spec only requires that the (&) and (<) characters are being escaped inside - * character data. - * + * moment, only the following characters are being escaped: (<), (&), (') and ("). + * + * Remark: we don't escape the (>) character to keep the readability of the configuration + * mapping! The XML spec only requires that the (&) and (<) characters are being escaped + * inside character data. + * * @param text * the character data to escape * @return the escaped character data http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/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 9e79e13..a665a00 100644 --- a/src/java/org/apache/ivy/util/filter/FilterHelper.java +++ b/src/java/org/apache/ivy/util/filter/FilterHelper.java @@ -54,19 +54,19 @@ public final class FilterHelper { } /** - * Returns a new collection containing only the items from the given collection, which are - * accepted by the filter. - * + * @param <T> The type parameter * @param col * The collection to filter. * @param filter * The filter to use. - * @return A new collection instance containing the only the instance accepted by the filter. + * @return a new collection instance containing the only the the items from the given + * collection, which are accepted by the filter. * - * <br /> - * Comment: We could have used - * <a href="http://jakarta.apache.org/commons/collections/";>Commons-Collections</a> - * facility for this. If we accepted to add dependencies on third party jars. + * <p> + * Comment: We could have used + * <a href="http://jakarta.apache.org/commons/collections/";>Commons Collections</a> facility for + * this, if we accepted additional dependencies on third party jars. + * </p> */ public static <T> Collection<T> filter(Collection<T> col, Filter<T> filter) { if (filter == null) { http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/util/url/URLHandler.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/util/url/URLHandler.java b/src/java/org/apache/ivy/util/url/URLHandler.java index 96b51d9..b429ef9 100644 --- a/src/java/org/apache/ivy/util/url/URLHandler.java +++ b/src/java/org/apache/ivy/util/url/URLHandler.java @@ -83,48 +83,44 @@ public interface URLHandler { /** * Please prefer getURLInfo when several infos are needed. - * - * @param url - * the url to check + * + * @param url the url to check * @return true if the target is reachable */ public boolean isReachable(URL url); /** * Please prefer getURLInfo when several infos are needed. - * - * @param url - * the url to check + * + * @param url the url to check + * @param timeout the timeout in milliseconds * @return true if the target is reachable */ public boolean isReachable(URL url, int timeout); /** - * Returns the length of the target if the given url is reachable, and without error code in - * case of http urls. Please prefer getURLInfo when several infos are needed. - * - * @param url - * the url to check - * @return the length of the target if available, 0 if not reachable + * Please prefer getURLInfo when several infos are needed. + * + * @param url the url to check + * @return the length of the target if the given url is reachable, 0 otherwise. No error code in + * case of http urls. */ public long getContentLength(URL url); /** - * Returns the length of the target if the given url is reachable, and without error code in - * case of http urls. - * * @param url * the url to check * @param timeout - * the maximum time before considering an url is not reachable a timeout of zero - * indicates no timeout - * @return the length of the target if available, 0 if not reachable + * the maximum time before considering an url is not reachable a + * timeout of zero indicates no timeout + * @return the length of the target if the given url is reachable, 0 otherwise. No error code in + * case of http urls. */ public long getContentLength(URL url, int timeout); /** * Please prefer getURLInfo when several infos are needed. - * + * * @param url * the url to check * @return last modified timestamp of the given url @@ -133,33 +129,28 @@ public interface URLHandler { /** * Please prefer getURLInfo when several infos are needed. - * - * @param url - * the url to check + * + * @param url the url to check + * @param timeout the timeout in milliseconds * @return last modified timestamp of the given url */ public long getLastModified(URL url, int timeout); /** - * Returns the URLInfo of the given url or a {@link #UNAVAILABLE} instance, if the url is not - * reachable. - * * @param url * The url from which information is retrieved. - * @return The URLInfo extracted from the given url, or {@link #UNAVAILABLE} when the url is not - * available. + * @return The URLInfo extracted from the given url, or {@link #UNAVAILABLE} instance when the + * url is not reachable. */ public URLInfo getURLInfo(URL url); /** - * never returns null, return UNAVAILABLE when url is not reachable - * * @param url * The url from which information is retrieved. * @param timeout * The timeout in milliseconds. * @return The URLInfo extracted from the given url, or {@link #UNAVAILABLE} when the url is not - * available. + * reachable, never null. */ public URLInfo getURLInfo(URL url, int timeout); http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/util/url/URLHandlerRegistry.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/util/url/URLHandlerRegistry.java b/src/java/org/apache/ivy/util/url/URLHandlerRegistry.java index 8bffe97..cd78811 100644 --- a/src/java/org/apache/ivy/util/url/URLHandlerRegistry.java +++ b/src/java/org/apache/ivy/util/url/URLHandlerRegistry.java @@ -39,7 +39,7 @@ public final class URLHandlerRegistry { /** * This method is used to get appropriate http downloader depending on Jakarta Commons * HttpClient availability in classpath, or simply use jdk url handling in other cases. - * + * * @return most accurate http downloader */ public static URLHandler getHttp() {
