http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/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 bebdc1f..16fb967 100644 --- a/src/java/org/apache/ivy/osgi/util/DelegatingHandler.java +++ b/src/java/org/apache/ivy/osgi/util/DelegatingHandler.java @@ -107,7 +107,7 @@ public class DelegatingHandler extends DefaultHandler implements DTDHandler, Con /** * Return an sort of identifier of the current element being parsed. It will only be used for * logging purpose. - * + * * @return an empty string by default */ protected String getCurrentElementIdentifier() { @@ -160,10 +160,11 @@ public class DelegatingHandler extends DefaultHandler implements DTDHandler, Con } /** - * @throws SAXException + * By default do nothing. + * + * @throws SAXException API told me so */ protected void doStartDocument() throws SAXException { - // by default do nothing } @Override @@ -179,10 +180,11 @@ public class DelegatingHandler extends DefaultHandler implements DTDHandler, Con } /** - * @throws SAXException + * By default do nothing. + * + * @throws SAXException API told me so */ protected void doEndDocument() throws SAXException { - // by default do nothing } @Override @@ -231,23 +233,27 @@ public class DelegatingHandler extends DefaultHandler implements DTDHandler, Con } /** - * Called when the expected node is achieved - * + * Called when the expected node is achieved; nothing to do by default. + * * @param atts * the xml attributes attached to the expected node * @exception SAXException * in case the parsing should be completely stopped */ protected void handleAttributes(Attributes atts) throws SAXException { - // nothing to do by default } /** - * @throws SAXException + * By default do nothing. + * + * @param uri String + * @param localName String + * @param name String + * @param atts Attributes + * @throws SAXException API told me so */ protected void doStartElement(String uri, String localName, String name, Attributes atts) throws SAXException { - // by default do nothing } @Override @@ -284,10 +290,14 @@ public class DelegatingHandler extends DefaultHandler implements DTDHandler, Con } /** - * @throws SAXException + * By default do nothing. + * + * @param uri String + * @param localName String + * @param name String + * @throws SAXException API told me so */ protected void doEndElement(String uri, String localName, String name) throws SAXException { - // by default do nothing } public static abstract class ChildElementHandler<DH extends DelegatingHandler> { @@ -315,7 +325,10 @@ public class DelegatingHandler extends DefaultHandler implements DTDHandler, Con } /** - * @throws SAXException + * @param ch char[] + * @param start int + * @param length int + * @throws SAXException if something goes wrong */ protected void doCharacters(char[] ch, int start, int length) throws SAXException { if (bufferingChar) { @@ -336,10 +349,13 @@ public class DelegatingHandler extends DefaultHandler implements DTDHandler, Con } /** - * @throws SAXException + * By default do nothing. + * + * @param prefix String + * @param uri String + * @throws SAXException API told me so */ protected void doStartPrefixMapping(String prefix, String uri) throws SAXException { - // by default do nothing } @Override @@ -355,10 +371,12 @@ public class DelegatingHandler extends DefaultHandler implements DTDHandler, Con } /** - * @throws SAXException + * By default do nothing. + * + * @param prefix String + * @throws SAXException API told me so */ protected void doEndPrefixMapping(String prefix) throws SAXException { - // by default do nothing } @Override @@ -374,10 +392,14 @@ public class DelegatingHandler extends DefaultHandler implements DTDHandler, Con } /** - * @throws SAXException + * By default do nothing + * + * @param ch char[] + * @param start int + * @param length int + * @throws SAXException API told me so */ protected void doIgnorableWhitespace(char[] ch, int start, int length) throws SAXException { - // by default do nothing } @Override @@ -394,11 +416,15 @@ public class DelegatingHandler extends DefaultHandler implements DTDHandler, Con } /** - * @throws SAXException + * By default do nothing. + * + * @param name String + * @param publicId String + * @param systemId String + * @throws SAXException API told me so */ protected void doNotationDecl(String name, String publicId, String systemId) throws SAXException { - // by default do nothing } @Override @@ -414,10 +440,13 @@ public class DelegatingHandler extends DefaultHandler implements DTDHandler, Con } /** - * @throws SAXException + * By default do nothing + * + * @param target String + * @param data String + * @throws SAXException API told me so */ protected void doProcessingInstruction(String target, String data) throws SAXException { - // by default do nothing } @Override @@ -433,10 +462,12 @@ public class DelegatingHandler extends DefaultHandler implements DTDHandler, Con } /** - * @throws SAXException + * By default do nothing. + * + * @param name String + * @throws SAXException API told me so */ protected void doSkippedEntity(String name) throws SAXException { - // by default do nothing } @Override @@ -453,11 +484,16 @@ public class DelegatingHandler extends DefaultHandler implements DTDHandler, Con } /** - * @throws SAXException + * By default do nothing. + * + * @param name String + * @param publicId String + * @param systemId String + * @param notationName String + * @throws SAXException API told me so */ protected void doUnparsedEntityDecl(String name, String publicId, String systemId, String notationName) throws SAXException { - // by default do nothing } // ERROR HANDLING @@ -475,10 +511,12 @@ public class DelegatingHandler extends DefaultHandler implements DTDHandler, Con } /** - * @throws SAXException + * By default do nothing. + * + * @param exception SAXParseException + * @throws SAXException API told me so */ protected void doWarning(SAXParseException exception) throws SAXException { - // by default do nothing } @Override @@ -494,10 +532,12 @@ public class DelegatingHandler extends DefaultHandler implements DTDHandler, Con } /** - * @throws SAXException + * By default do nothing. + * + * @param exception SAXParseException + * @throws SAXException API told me so */ protected void doError(SAXParseException exception) throws SAXException { - // by default do nothing } @Override @@ -513,10 +553,12 @@ public class DelegatingHandler extends DefaultHandler implements DTDHandler, Con } /** - * @throws SAXException + * By default do nothing. + * + * @param exception SAXParseException + * @throws SAXException API told me so */ protected void doFatalError(SAXParseException exception) throws SAXException { - // by default do nothing } // //////////////////////
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/circular/CircularDependencyHelper.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/circular/CircularDependencyHelper.java b/src/java/org/apache/ivy/plugins/circular/CircularDependencyHelper.java index 69dbdba..123dd96 100644 --- a/src/java/org/apache/ivy/plugins/circular/CircularDependencyHelper.java +++ b/src/java/org/apache/ivy/plugins/circular/CircularDependencyHelper.java @@ -34,7 +34,7 @@ public final class CircularDependencyHelper { /** * Returns a string representation of this circular dependency graph - * + * * @param mrids * in order of circular dependency * @return a string representation of this circular dependency graph @@ -62,7 +62,8 @@ public final class CircularDependencyHelper { /** * @param loopElements - * a List<ModuleDescriptor> + * a List<ModuleDescriptor> + * @return String */ public static String formatMessageFromDescriptors(List loopElements) { ModuleRevisionId[] mrids = new ModuleRevisionId[loopElements.size()]; http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/conflict/LatestCompatibleConflictManager.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/conflict/LatestCompatibleConflictManager.java b/src/java/org/apache/ivy/plugins/conflict/LatestCompatibleConflictManager.java index 4501e72..e7b0ff6 100644 --- a/src/java/org/apache/ivy/plugins/conflict/LatestCompatibleConflictManager.java +++ b/src/java/org/apache/ivy/plugins/conflict/LatestCompatibleConflictManager.java @@ -46,17 +46,17 @@ import org.apache.ivy.util.Message; * set of compatible dependencies, even if it requires stepping back to older revisions (as long as * they are in the set of compatibility). * <p> - * Here is an example of what this conflict manager is able to do:<br/> + * Here is an example of what this conflict manager is able to do: + * </p> * <b>Available Modules</b>: - * * <pre> * #A;2->{ #B;[1.0,1.5] #C;[2.0,2.5] } * #B;1.4->#D;1.5 * #B;1.5->#D;2.0 * #C;2.5->#D;[1.0,1.6] * </pre> - * - * <b>Result</b>: #B;1.4, #C;2.5, #D;1.5<br/> + * <b>Result</b>: #B;1.4, #C;2.5, #D;1.5 + * <p> * <b>Details</b>The conflict manager finds that the latest matching version of #B (1.5) depends on * a version of #D incompatible with what is expected by the latest matching version of #C. Hence * the conflict manager blacklists #B;1.5, and the version range [1.0,1.5] is resolved again to end @@ -126,7 +126,7 @@ public class LatestCompatibleConflictManager extends LatestConflictManager { * Handles an incompatible conflict * <p> * An incompatible conflicts is handled with this pseudo algorithm: - * + * * <pre> * take latest among two nodes in conflict * for all callers @@ -139,9 +139,9 @@ public class LatestCompatibleConflictManager extends LatestConflictManager { * else * throw strict conflict exception * </pre> - * + * * </p> - * + * * @param parent * the parent node of nodes in conflict * @param conflicts @@ -238,7 +238,7 @@ public class LatestCompatibleConflictManager extends LatestConflictManager { /** * Tries to blacklist exactly one version for all callers paths. - * + * * @param versionMatcher * the version matcher to use to interpret versions * @param conflictParent http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/latest/WorkspaceLatestStrategy.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/latest/WorkspaceLatestStrategy.java b/src/java/org/apache/ivy/plugins/latest/WorkspaceLatestStrategy.java index 64ef7ec..97ab192 100644 --- a/src/java/org/apache/ivy/plugins/latest/WorkspaceLatestStrategy.java +++ b/src/java/org/apache/ivy/plugins/latest/WorkspaceLatestStrategy.java @@ -22,8 +22,8 @@ import java.util.List; /** * A strategy which delegate to another strategy, unless for the latest and working revisions which - * are considered as superior to any other revision. < br/> - * NB : it is for internal usage of Ivy only! + * are considered as superior to any other revision. + * <p>NB : it is for internal usage of Ivy only!</p> */ public class WorkspaceLatestStrategy extends AbstractLatestStrategy { http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/lock/FileBasedLockStrategy.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/lock/FileBasedLockStrategy.java b/src/java/org/apache/ivy/plugins/lock/FileBasedLockStrategy.java index 8fa2643..142898c 100644 --- a/src/java/org/apache/ivy/plugins/lock/FileBasedLockStrategy.java +++ b/src/java/org/apache/ivy/plugins/lock/FileBasedLockStrategy.java @@ -139,12 +139,12 @@ public abstract class FileBasedLockStrategy extends AbstractLockStrategy { /** * Determine the state of the lockfile. - * + * * Must be called from within a synchronized block. - * + * * Three possibilities exist: - The lock is held by the current thread (>0) - The lock is held * by one or more different threads (-1) - The lock is not held at all (0). - * + * * @param file * file to lock * @param forThread @@ -169,10 +169,10 @@ public abstract class FileBasedLockStrategy extends AbstractLockStrategy { /** * Record that this thread holds the lock. - * + * * Asserts that the lock has been previously grabbed by this thread. Must be called from a * synchronized block in which the lock was grabbed. - * + * * @param file * file which has been locked * @param forThread @@ -193,11 +193,11 @@ public abstract class FileBasedLockStrategy extends AbstractLockStrategy { /** * Decrease depth of this thread's lock. - * + * * Must be called within a synchronized block. - * + * * If this returns 0, the caller is responsible for releasing the lock within that same block. - * + * * @param file * file for which lock depth is being decreased * @param forThread @@ -225,6 +225,9 @@ public abstract class FileBasedLockStrategy extends AbstractLockStrategy { /** * Return a string naming the threads which currently hold this lock. + * + * @param file File + * @return String */ protected String getCurrentLockHolderNames(File file) { StringBuilder sb = new StringBuilder(); http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/lock/LockStrategy.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/lock/LockStrategy.java b/src/java/org/apache/ivy/plugins/lock/LockStrategy.java index a28d6f8..31a0fb8 100644 --- a/src/java/org/apache/ivy/plugins/lock/LockStrategy.java +++ b/src/java/org/apache/ivy/plugins/lock/LockStrategy.java @@ -28,10 +28,11 @@ import org.apache.ivy.core.module.descriptor.Artifact; * Note that some implementations may actually choose to NOT perform locking, when no lock is * necessary (cache not shared). Some other implementations may choose to lock the cache for the * download of a whole module (not possible yet), or at the artifact level. - * <p> * </p> + * <p> * The lock methods should return true when the lock is either actually acquired or not performed by - * the strategy. </p> + * the strategy. + * </p> * <p> * Locking used in the locking strategy must support reentrant lock. Reentrant locking should be * performed for the whole strategy. @@ -41,14 +42,14 @@ public interface LockStrategy { /** * Returns the name of the strategy - * + * * @return the name of the strategy */ String getName(); /** * Performs a lock before downloading the given {@link Artifact} to the given file. - * + * * @param artifact * the artifact about to be downloaded * @param artifactFileToDownload @@ -62,7 +63,7 @@ public interface LockStrategy { /** * Release the lock acquired for an artifact download. - * + * * @param artifact * the artifact for which the lock was acquired * @param artifactFileToDownload http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/matcher/ExactOrRegexpPatternMatcher.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/matcher/ExactOrRegexpPatternMatcher.java b/src/java/org/apache/ivy/plugins/matcher/ExactOrRegexpPatternMatcher.java index 68e2f74..0e45c14 100644 --- a/src/java/org/apache/ivy/plugins/matcher/ExactOrRegexpPatternMatcher.java +++ b/src/java/org/apache/ivy/plugins/matcher/ExactOrRegexpPatternMatcher.java @@ -20,11 +20,12 @@ package org.apache.ivy.plugins.matcher; /** * A pattern matcher that tries to match exactly the input with the expression, or match it as a * pattern. - * <p/> + * <p> * The evaluation for matching is perform first by checking if expression and input are equals (via * equals method) else it attempts to do it by trying to match the input using the expression as a * regexp. - * + * </p> + * * @see ExactPatternMatcher * @see RegexpPatternMatcher */ http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/matcher/ExactPatternMatcher.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/matcher/ExactPatternMatcher.java b/src/java/org/apache/ivy/plugins/matcher/ExactPatternMatcher.java index 0613e38..c29eff7 100644 --- a/src/java/org/apache/ivy/plugins/matcher/ExactPatternMatcher.java +++ b/src/java/org/apache/ivy/plugins/matcher/ExactPatternMatcher.java @@ -19,9 +19,10 @@ package org.apache.ivy.plugins.matcher; /** * Implementation of an exact matcher. - * <p/> + * <p> * The matching will be performed against an expression being a string. It will only matches if both * strings are equal (per equals()) rule or if both strings are null. + * </p> */ public/* @Immutable */final class ExactPatternMatcher extends AbstractPatternMatcher { http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/matcher/GlobPatternMatcher.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/matcher/GlobPatternMatcher.java b/src/java/org/apache/ivy/plugins/matcher/GlobPatternMatcher.java index 96a8d3a..9e9b22a 100644 --- a/src/java/org/apache/ivy/plugins/matcher/GlobPatternMatcher.java +++ b/src/java/org/apache/ivy/plugins/matcher/GlobPatternMatcher.java @@ -30,10 +30,12 @@ import org.apache.oro.text.regex.Perl5Matcher; * <li>* - Matches zero or more characters</li> * <li>? - Matches exactly one character.</li> * </ul> - * <p/> - * <b> Note that this matcher is available only with <a href="http://jakarta.apache.org/oro"Apache - * Jakarta Oro 2.0.8</a> in your classpath.</b> - * + * <p> + * NOTE: this matcher is available only with + * <a href="http://jakarta.apache.org/oro";>Apache Jakarta Oro 2.0.8</a> + * in your classpath. + * </p> + * * @see <a href="http://jakarta.apache.org/oro/api/org/apache/oro/text/GlobCompiler.html";>GlobCompiler</a> */ public/* @Immutable */final class GlobPatternMatcher extends AbstractPatternMatcher { http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/matcher/PatternMatcher.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/matcher/PatternMatcher.java b/src/java/org/apache/ivy/plugins/matcher/PatternMatcher.java index 27b35eb..16b5145 100644 --- a/src/java/org/apache/ivy/plugins/matcher/PatternMatcher.java +++ b/src/java/org/apache/ivy/plugins/matcher/PatternMatcher.java @@ -19,9 +19,10 @@ package org.apache.ivy.plugins.matcher; /** * Interface for a pattern matcher. - * <p/> + * <p> * The pattern matcher is the main abstraction regarding the matching of an expression. * Implementation may vary depending on the expression syntax handling that is desired. + * </p> */ public interface PatternMatcher { @@ -52,7 +53,7 @@ public interface PatternMatcher { /** * Return the matcher for the given expression. - * + * * @param expression * the expression to be matched. Cannot be null ? * @return the matcher instance for the given expression. Never null. @@ -61,7 +62,7 @@ public interface PatternMatcher { /** * return the name of this pattern matcher - * + * * @return the name of this pattern matcher. Never null. * @see #EXACT * @see #REGEXP http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/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 0971f33..cfd3636 100644 --- a/src/java/org/apache/ivy/plugins/parser/ModuleDescriptorParser.java +++ b/src/java/org/apache/ivy/plugins/parser/ModuleDescriptorParser.java @@ -39,8 +39,12 @@ 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 is input stream with opened on original module descriptor resource + * @param res Resource + * @param destFile File + * @param md ModuleDescriptor + * @throws ParseException if something goes wrong + * @throws IOException if something goes wrong */ public void toIvyFile(InputStream is, Resource res, File destFile, ModuleDescriptor md) throws ParseException, IOException; http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/parser/ParserSettings.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/parser/ParserSettings.java b/src/java/org/apache/ivy/plugins/parser/ParserSettings.java index 662736c..8294547 100644 --- a/src/java/org/apache/ivy/plugins/parser/ParserSettings.java +++ b/src/java/org/apache/ivy/plugins/parser/ParserSettings.java @@ -55,7 +55,7 @@ public interface ParserSettings { String getDefaultBranch(ModuleId moduleId); /** - * Returns the namespace context in which the current descriptor is parsed. + * @return the namespace context in which the current descriptor is parsed. */ Namespace getContextNamespace(); http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/parser/m2/PomModuleDescriptorParser.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/parser/m2/PomModuleDescriptorParser.java b/src/java/org/apache/ivy/plugins/parser/m2/PomModuleDescriptorParser.java index 9bb6433..ced6e55 100644 --- a/src/java/org/apache/ivy/plugins/parser/m2/PomModuleDescriptorParser.java +++ b/src/java/org/apache/ivy/plugins/parser/m2/PomModuleDescriptorParser.java @@ -59,11 +59,13 @@ import org.xml.sax.SAXException; /** * A parser for Maven 2 POM. * <p> - * The configurations used in the generated module descriptor mimics the behavior defined by maven 2 - * scopes, as documented here:<br/> - * http://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html The - * PomModuleDescriptorParser use a PomDomReader to read the pom, and the PomModuleDescriptorBuilder - * to write the ivy module descriptor using the info read by the PomDomReader. + * The configurations used in the generated module descriptor mimics the behavior defined by Maven 2 + * scopes, as documented + * <a href="http://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html";>here</a>. + * The PomModuleDescriptorParser use a PomDomReader to read the pom, and the + * PomModuleDescriptorBuilder to write the ivy module descriptor using the info read by the + * PomDomReader. + * </p> */ public final class PomModuleDescriptorParser implements ModuleDescriptorParser { http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/parser/m2/PomReader.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/parser/m2/PomReader.java b/src/java/org/apache/ivy/plugins/parser/m2/PomReader.java index b9e8201..93d128b 100644 --- a/src/java/org/apache/ivy/plugins/parser/m2/PomReader.java +++ b/src/java/org/apache/ivy/plugins/parser/m2/PomReader.java @@ -156,6 +156,9 @@ public class PomReader { * Add a property if not yet set and value is not null. This guarantees * that property keeps the first value that is put on it and that the * properties are never null. + * + * @param prop String + * @param val String */ public void setProperty(String prop, String val) { if (!properties.containsKey(prop) && val != null) { http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/parser/xml/XmlModuleDescriptorParser.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/parser/xml/XmlModuleDescriptorParser.java b/src/java/org/apache/ivy/plugins/parser/xml/XmlModuleDescriptorParser.java index a272d65..0dcdb8a 100644 --- a/src/java/org/apache/ivy/plugins/parser/xml/XmlModuleDescriptorParser.java +++ b/src/java/org/apache/ivy/plugins/parser/xml/XmlModuleDescriptorParser.java @@ -107,8 +107,8 @@ public class XmlModuleDescriptorParser extends AbstractModuleDescriptorParser { * the real resource to parse, used for log only * @param validate boolean * @return ModuleDescriptor - * @throws ParseException - * @throws IOException + * @throws ParseException if something goes wrong + * @throws IOException if something goes wrong */ public ModuleDescriptor parseDescriptor(ParserSettings ivySettings, URL xmlURL, Resource res, boolean validate) throws ParseException, IOException { @@ -136,7 +136,7 @@ public class XmlModuleDescriptorParser extends AbstractModuleDescriptorParser { * <p> * Override this method if you want to use a custom Parser. * </p> - * + * * @param ivySettings * the settings to use during parsing * @return the Parser instance used for parsing Ivy files @@ -396,7 +396,7 @@ public class XmlModuleDescriptorParser extends AbstractModuleDescriptorParser { /** * Default parent location to check (for dev ONLY) - * + * * @return a relative path to a parent module descriptor */ protected String getDefaultParentLocation() { @@ -411,9 +411,9 @@ public class XmlModuleDescriptorParser extends AbstractModuleDescriptorParser { * <li>cache to find a resolved parent descriptor</li> * <li>ask repositories to retrieve the parent module descriptor</li> * </ul> - * + * * @param attributes Attributes - * @throws ParseException + * @throws ParseException if something goes wrong */ protected void extendsStarted(Attributes attributes) throws ParseException { String parentOrganisation = settings.substitute(attributes.getValue("organisation")); @@ -482,7 +482,7 @@ public class XmlModuleDescriptorParser extends AbstractModuleDescriptorParser { /** * Merge current module with a given module descriptor and specify what should be inherited * through extendTypes argument - * + * * @param extendTypes * specify what should be inherited * @param parent @@ -521,7 +521,7 @@ public class XmlModuleDescriptorParser extends AbstractModuleDescriptorParser { /** * Merge everything from a given parent - * + * * @param parent * a given parent module descriptor */ @@ -536,7 +536,7 @@ public class XmlModuleDescriptorParser extends AbstractModuleDescriptorParser { /** * Explain how to inherit metadata related to info element - * + * * @param parent * a given parent module descriptor */ @@ -589,7 +589,7 @@ public class XmlModuleDescriptorParser extends AbstractModuleDescriptorParser { /** * Describes how to merge configurations elements - * + * * @param parent * the module descriptor */ @@ -612,7 +612,7 @@ public class XmlModuleDescriptorParser extends AbstractModuleDescriptorParser { /** * Describes how dependencies should be inherited - * + * * @param dependencies * array of dependencies to inherit */ @@ -628,7 +628,7 @@ public class XmlModuleDescriptorParser extends AbstractModuleDescriptorParser { /** * Describes how to merge description - * + * * @param description * description going to be inherited */ @@ -641,7 +641,7 @@ public class XmlModuleDescriptorParser extends AbstractModuleDescriptorParser { /** * Describes how to merge licenses - * + * * @param licenses * licenses going to be inherited */ @@ -653,7 +653,7 @@ public class XmlModuleDescriptorParser extends AbstractModuleDescriptorParser { /** * Describes how to merge exclude rules - * + * * @param excludeRules * exclude rules going to be inherited */ @@ -665,11 +665,11 @@ public class XmlModuleDescriptorParser extends AbstractModuleDescriptorParser { /** * Returns the parent module using the location attribute (for dev purpose). - * + * * @param location * a given location - * @throws IOException - * @throws ParseException + * @throws IOException if something goes wrong + * @throws ParseException if something goes wrong */ private ModuleDescriptor parseParentModuleOnFilesystem(String location) throws IOException, ParseException { @@ -702,12 +702,12 @@ public class XmlModuleDescriptorParser extends AbstractModuleDescriptorParser { /** * Describe how to parse a {@link ModuleDescriptor} by asking repositories - * + * * @param parentMrid * a given {@link ModuleRevisionId} to find * @return a {@link ModuleDescriptor} if found. Return null if no {@link ModuleDescriptor} * was found - * @throws ParseException + * @throws ParseException if something goes wrong */ protected ModuleDescriptor parseOtherIvyFile(ModuleRevisionId parentMrid) throws ParseException { @@ -911,11 +911,12 @@ public class XmlModuleDescriptorParser extends AbstractModuleDescriptorParser { String branch = settings.substitute(attributes.getValue("branch")); String branchConstraint = settings.substitute(attributes.getValue("branchConstraint")); - // if (branchConstraint == null) { - // // there was no branch constraint before, so we should - // // set the branchConstraint to the current default branch - // branchConstraint = settings.getDefaultBranch(ModuleId.newInstance(org, name)); - // } + /* if (branchConstraint == null) { + * // there was no branch constraint before, so we should + * // set the branchConstraint to the current default branch + * branchConstraint = settings.getDefaultBranch(ModuleId.newInstance(org, name)); + * } + */ String rev = settings.substitute(attributes.getValue("rev")); String revConstraint = settings.substitute(attributes.getValue("revConstraint")); @@ -1167,15 +1168,12 @@ public class XmlModuleDescriptorParser extends AbstractModuleDescriptorParser { protected void addConfiguration(String c) { confAware.addConfiguration(c); if (state == State.EXCLUDE) { - // we are adding a configuration to a module wide exclude rule - // we have nothing special to do here, the rule has already been added to the module - // descriptor + // we are adding a configuration to a module wide exclude rule we have nothing + // special to do here, the rule has already been added to the module descriptor } else { // we are currently adding a configuration to either an include, exclude or artifact - // element - // of a dependency. This means that we have to add this element to the corresponding - // conf - // of the current dependency descriptor + // element of a dependency. This means that we have to add this element to the + // corresponding conf of the current dependency descriptor if (confAware instanceof DependencyArtifactDescriptor) { dd.addDependencyArtifact(c, (DependencyArtifactDescriptor) confAware); } else if (confAware instanceof IncludeRule) { http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/parser/xml/XmlModuleDescriptorUpdater.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/parser/xml/XmlModuleDescriptorUpdater.java b/src/java/org/apache/ivy/plugins/parser/xml/XmlModuleDescriptorUpdater.java index b373acf..b1aafa9 100644 --- a/src/java/org/apache/ivy/plugins/parser/xml/XmlModuleDescriptorUpdater.java +++ b/src/java/org/apache/ivy/plugins/parser/xml/XmlModuleDescriptorUpdater.java @@ -84,11 +84,15 @@ public final class XmlModuleDescriptorUpdater { /** * used to copy a module descriptor xml file (also known as ivy file) and update the revisions * of its dependencies, its status and revision - * + * * @param srcURL * the url of the source module descriptor file * @param destFile * The file to which the updated module descriptor should be output + * @param options + * UpdateOptions + * @throws IOException if something goes wrong + * @throws SAXException if something goes wrong */ public static void update(URL srcURL, File destFile, UpdateOptions options) throws IOException, SAXException { @@ -932,7 +936,7 @@ public final class XmlModuleDescriptorUpdater { /** * Write XML elements that do not appear in the source descriptor, but have been copied in * from a parent module descriptor via <extends> declaration. - * + * * @param merged * child descriptor containing the merged data * @param items @@ -1003,7 +1007,7 @@ public final class XmlModuleDescriptorUpdater { * Collect the given list of inherited descriptor items into lists keyed by parent Id. Thus * all of the items inherited from parent A can be written together, then all of the items * from parent B, and so on. - * + * * @param merged * the merged child descriptor * @param items @@ -1077,13 +1081,13 @@ public final class XmlModuleDescriptorUpdater { * elements like "configurations" and "dependencies" appear in the parent descriptor, but * are completely missing in the child descriptor. * </p> - * + * * <p> * For example, if "moduleElement" is "dependencies", guarantees that "configurations" has * been written. If <code>moduleElement</code> is <code>null</code>, then all missing merged * elements will be flushed. * </p> - * + * * @param moduleElement * a descriptor element name, for example "configurations" or "info" */ @@ -1312,12 +1316,13 @@ public final class XmlModuleDescriptorUpdater { protected static interface ItemPrinter { /** * Print an XML representation of <code>item</code> to <code>out</code>. - * + * * @param parent * the module descriptor containing <code>item</code> * @param item * subcomponent of the descriptor, for example a {@link DependencyDescriptor} or * {@link Configuration} + * @param out PrintWriter */ public void print(ModuleDescriptor parent, Object item, PrintWriter out); } http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/report/XmlReportParser.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/report/XmlReportParser.java b/src/java/org/apache/ivy/plugins/report/XmlReportParser.java index c24fc11..a0d5737 100644 --- a/src/java/org/apache/ivy/plugins/report/XmlReportParser.java +++ b/src/java/org/apache/ivy/plugins/report/XmlReportParser.java @@ -322,6 +322,8 @@ public class XmlReportParser { /** * Returns the <tt>ModuleRevisionId</tt> of the resolved module. + * + * @return ModuleRevisionId */ public ModuleRevisionId getResolvedModule() { return parser.getResolvedModule(); http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/repository/Repository.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/repository/Repository.java b/src/java/org/apache/ivy/plugins/repository/Repository.java index 5bec765..e78f20a 100644 --- a/src/java/org/apache/ivy/plugins/repository/Repository.java +++ b/src/java/org/apache/ivy/plugins/repository/Repository.java @@ -26,28 +26,19 @@ import org.apache.ivy.core.module.descriptor.Artifact; /** * Represents a collection of resources available to Ivy. Ivy uses one or more repositories as both * a source of resources for Ivy enabled build systems and as a distribution center for resources - * generated by Ivy enabled build systems. </p> - * <p> - * A repository supports the following fundamental operations + * generated by Ivy enabled build systems. + * <p>A repository supports the following fundamental operations</p> * <ul> * <li>retrieving a resource from the repository.</li> * <li>transferring a resource to the repository.</li> * <li>retrieving a listing of resources.</li> * </ul> - * </p> - * <h4>Resource Retrieval</h4> </p> - * <p> - * {@link #get} retrieves a resource specified by a provided identifier creating a new file . - * </p> - * </p> <h4>resource Publication</h4> </p> - * <p> - * {@link #put} transfers a file to the repository. - * </p> - * </p> <h4>resource Listing</h4> </p> - * <p> - * {@link #list} returns a listing of file like objects belonging to a specified parent directory. - * </p> - * </p> + * <h3>Resource Retrieval</h3> + * <p>{@link #get} retrieves a resource specified by a provided identifier creating a new file.</p> + * <h3>Resource Publication</h3> + * <p>{@link #put} transfers a file to the repository.</p> + * <h2>resource Listing</h2> + * <p>{@link #list} returns a listing of file like objects belonging to a specified parent directory.</p> */ public interface Repository { @@ -55,7 +46,7 @@ public interface Repository { * Return the resource associated with a specified identifier. If the resource does not exist, * it should return a Resource with exists() returning false. An IOException should only be * thrown when a real IO problem occurs, like the impossibility to connect to a server. - * + * * @param source * A string identifying the resource. * @return The resource associated with the resource identifier. @@ -66,7 +57,7 @@ public interface Repository { /** * Fetch a resource from the repository. - * + * * @param source * A string identifying the resource to be fetched. * @param destination @@ -78,7 +69,7 @@ public interface Repository { /** * Transfer a resource to the repository - * + * * @param artifact * The artifact to be transferred. * @param source @@ -95,7 +86,7 @@ public interface Repository { /** * Return a listing of resources names - * + * * @param parent * The parent directory from which to generate the listing. * @return A listing of the parent directory's file content @@ -106,7 +97,7 @@ public interface Repository { /** * Add a listener to the repository. - * + * * @param listener * The listener to attach to the repository. */ @@ -114,7 +105,7 @@ public interface Repository { /** * Remove a listener on the repository - * + * * @param listener * The listener to remove */ @@ -122,7 +113,7 @@ public interface Repository { /** * Determine if a given listener is attached to the repository. - * + * * @param listener * The listener being queried * @return <code>true</code> if the provided listener is attached to the repository, @@ -132,14 +123,14 @@ public interface Repository { /** * Get the repository's file separator string. - * + * * @return The repository's file separator delimiter */ String getFileSeparator(); /** * Normalize a string. - * + * * @param source * The string to normalize. * @return The normalized string. @@ -148,6 +139,8 @@ public interface Repository { /** * Return the name of the repository + * + * @return String name */ String getName(); } http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/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 7a62269..950c02a 100644 --- a/src/java/org/apache/ivy/plugins/repository/Resource.java +++ b/src/java/org/apache/ivy/plugins/repository/Resource.java @@ -29,18 +29,17 @@ import java.io.InputStream; * <li>size of the resource in bytes.</li> * <li>if the resource is available.</li> * </ul> - * </p> <h4>Implementation Notes</h4> In implementing the interface you need to ensure the following - * behaviors: + * <h3>Implementation Notes</h3> + * In implementing the interface you need to ensure the following behaviors: * <ul> - * <li>All of the methods specified in the interface fail by returning an empty value ( - * <code>false</code>, <code>0</code>, <code>""</code>). In other words, the specified interface + * <li>All of the methods specified in the interface fail by returning an empty value + * (<code>false</code>, <code>0</code>, <code>""</code>). In other words, the specified interface * methods should not throw RuntimeExceptions.</li> * <li>Failure conditions should be logged using the {@link org.apache.ivy.util.Message#verbose} * method.</li> * <li>Failure of one of the interface's specified methods results in all other interface specified * methods returning an empty value (<code>false</code>, <code>0</code>, <code>""</code>).</li> * </ul> - * </p> */ public interface Resource { @@ -68,7 +67,7 @@ public interface Resource { public long getContentLength(); /** - * Determine if the resource is available. </p> Note that this method only checks for + * 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. @@ -95,6 +94,7 @@ public interface Resource { * Opens a stream on this resource * * @return the opened input stream + * @throws IOException if something goes wrong */ public InputStream openStream() throws IOException; } http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/repository/TransferEvent.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/repository/TransferEvent.java b/src/java/org/apache/ivy/plugins/repository/TransferEvent.java index 68c5adf..64517e7 100644 --- a/src/java/org/apache/ivy/plugins/repository/TransferEvent.java +++ b/src/java/org/apache/ivy/plugins/repository/TransferEvent.java @@ -25,25 +25,25 @@ import org.apache.ivy.core.event.IvyEvent; * TransferEvent is used to notify TransferListeners about progress in transfer of resources form/to * the repository This class is LARGELY inspired by org.apache.maven.wagon.events.TransferEvent * released under the following copyright license: - * + * * <pre> - * + * * Copyright 2001-2005 The Apache Software Foundation. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. - * + * * </pre> - * + * * Original class written by Michal Maczka. */ public class TransferEvent extends IvyEvent { @@ -184,9 +184,9 @@ public class TransferEvent extends IvyEvent { /** * Returns the request type. - * + * * @return Returns the request type. The Request type is one of - * <code>TransferEvent.REQUEST_GET<code> or <code>TransferEvent.REQUEST_PUT<code> + * TransferEvent.REQUEST_GET or TransferEvent.REQUEST_PUT */ public int getRequestType() { return requestType; @@ -194,10 +194,10 @@ public class TransferEvent extends IvyEvent { /** * Sets the request type - * + * * @param requestType * The requestType to set. The Request type value should be either - * <code>TransferEvent.REQUEST_GET<code> or <code>TransferEvent.REQUEST_PUT<code>. + * TransferEvent.REQUEST_GET or TransferEvent.REQUEST_PUT * @throws IllegalArgumentException * when */ @@ -303,22 +303,16 @@ public class TransferEvent extends IvyEvent { /** * Returns the elapsed time (in ms) between when the event entered one type until it entered * another event time. - * <p> - * This is especially useful to get the elapsed transfer time: - * + * <p>This is especially useful to get the elapsed transfer time:</p> * <pre> * getElapsedTime(TransferEvent.TRANSFER_STARTED, TransferEvent.TRANSFER_COMPLETED); * </pre> - * - * </p> - * <p> - * Special cases: + * <p>Special cases:</p> * <ul> * <li>returns -1 if the event never entered the fromEventType or the toEventType.</li> * <li>returns 0 if the event entered toEventType before fromEventType</li> * </ul> - * </p> - * + * * @param fromEventType * the event type constant from which time should be measured * @param toEventType @@ -345,7 +339,7 @@ public class TransferEvent extends IvyEvent { /** * Checks the given event type is a valid event type, throws an {@link IllegalArgumentException} * if it isn't - * + * * @param eventType * the event type to check */ http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/repository/ssh/AbstractSshBasedRepository.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/repository/ssh/AbstractSshBasedRepository.java b/src/java/org/apache/ivy/plugins/repository/ssh/AbstractSshBasedRepository.java index 276cc25..d61c0ba 100644 --- a/src/java/org/apache/ivy/plugins/repository/ssh/AbstractSshBasedRepository.java +++ b/src/java/org/apache/ivy/plugins/repository/ssh/AbstractSshBasedRepository.java @@ -68,10 +68,11 @@ public abstract class AbstractSshBasedRepository extends AbstractRepository { /** * get a new session using the default attributes if the given String is a full uri, use the * data from the uri instead - * + * * @param pathOrUri * might be just a path or a full ssh or sftp uri * @return matching Session + * @throws IOException if something goes wrong */ protected Session getSession(String pathOrUri) throws IOException { URI uri = parseURI(pathOrUri); @@ -134,7 +135,7 @@ public abstract class AbstractSshBasedRepository extends AbstractRepository { /** * Just check the uri for sanity - * + * * @param source * String of the uri * @return URI object of the String or null @@ -170,7 +171,7 @@ public abstract class AbstractSshBasedRepository extends AbstractRepository { /** * Called, when user was not found in URL. Maintain static hash of credentials and retrieve or * ask credentials for host. - * + * * @param host * host for which we want to get credentials. * @return credentials for given host @@ -194,7 +195,7 @@ public abstract class AbstractSshBasedRepository extends AbstractRepository { /** * closes the session and remove it from the cache (eg. on case of errors) - * + * * @param session * key for the cache * @param pathOrUri @@ -207,7 +208,7 @@ public abstract class AbstractSshBasedRepository extends AbstractRepository { /** * set the default user to use for the connection if no user is given or a PEM file is used - * + * * @param user * to use */ @@ -224,7 +225,7 @@ public abstract class AbstractSshBasedRepository extends AbstractRepository { /** * Sets the full file path to use for accessing a PEM key file - * + * * @param filePath * fully qualified name */ http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/repository/ssh/SshCache.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/repository/ssh/SshCache.java b/src/java/org/apache/ivy/plugins/repository/ssh/SshCache.java index de87655..7b24ecb 100644 --- a/src/java/org/apache/ivy/plugins/repository/ssh/SshCache.java +++ b/src/java/org/apache/ivy/plugins/repository/ssh/SshCache.java @@ -108,7 +108,7 @@ public final class SshCache { /** * attach an sftp channel to this cache entry - * + * * @param newChannel * to attach */ @@ -150,7 +150,7 @@ public final class SshCache { /** * key is username / host / port - * + * * @see #createCacheKey(String, String, int) for details */ private Map uriCacheMap = new HashMap(); @@ -177,7 +177,7 @@ public final class SshCache { /** * Creates a combined cache key from the given key parts - * + * * @param user * name of the user * @param host @@ -197,7 +197,7 @@ public final class SshCache { /** * retrieves a session entry for a given session from the cache - * + * * @param session * to retrieve cache entry for * @return null or the existing entry @@ -209,7 +209,7 @@ public final class SshCache { /** * Sets a session to a given combined key into the cache If an old session object already * exists, close and remove it - * + * * @param user * of the session * @param host @@ -246,7 +246,7 @@ public final class SshCache { /** * discards session entries from the cache - * + * * @param session * to clear */ @@ -259,10 +259,11 @@ public final class SshCache { /** * retrieves an sftp channel from the cache - * + * * @param session * to connect to * @return channelSftp or null if not successful (channel not existent or dead) + * @throws IOException if something goes wrong */ public ChannelSftp getChannelSftp(Session session) throws IOException { ChannelSftp channel = null; @@ -279,7 +280,7 @@ public final class SshCache { /** * attaches a channelSftp to an existing session cache entry - * + * * @param session * to attach the channel to * @param channel @@ -295,7 +296,7 @@ public final class SshCache { /** * Attempts to connect to a local SSH agent (using either UNIX sockets or PuTTY's Pageant) - * + * * @param jsch * Connection to be attached to an available local agent * @return true if connected to agent, false otherwise @@ -313,7 +314,7 @@ public final class SshCache { /** * Gets a session from the cache or establishes a new session if necessary - * + * * @param host * to connect to * @param port @@ -331,6 +332,7 @@ public final class SshCache { * @param allowedAgentUse * Whether to communicate with an agent for authentication * @return session or null if not successful + * @throws IOException if something goes wrong */ public Session getSession(String host, int port, String username, String userPassword, File pemFile, String pemPassword, File passFile, boolean allowedAgentUse) http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/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 cbe654f..4590a67 100644 --- a/src/java/org/apache/ivy/plugins/repository/ssh/SshRepository.java +++ b/src/java/org/apache/ivy/plugins/repository/ssh/SshRepository.java @@ -68,7 +68,7 @@ public class SshRepository extends AbstractSshBasedRepository { /** * Fetch the needed file information for a given file (size, last modification time) and report * it back in a SshResource - * + * * @param source * ssh uri for the file to get info for * @return SshResource filled with the needed information @@ -103,7 +103,7 @@ public class SshRepository extends AbstractSshBasedRepository { /** * Reads out the output of a ssh session exec - * + * * @param channel * Channel to read from * @param strStdout @@ -157,7 +157,7 @@ public class SshRepository extends AbstractSshBasedRepository { /* * (non-Javadoc) - * + * * @see org.apache.ivy.repository.Repository#list(java.lang.String) */ public List list(String parent) throws IOException { @@ -211,7 +211,7 @@ public class SshRepository extends AbstractSshBasedRepository { /** * Replace the argument placeholder with argument or append the argument if no placeholder is * present - * + * * @param command * with argument placeholder or not * @param argument ditto @@ -229,7 +229,7 @@ public class SshRepository extends AbstractSshBasedRepository { /* * (non-Javadoc) - * + * * @see org.apache.ivy.repository.Repository#put(java.io.File, java.lang.String, boolean) */ public void put(File source, String destination, boolean overwrite) throws IOException { @@ -279,7 +279,7 @@ public class SshRepository extends AbstractSshBasedRepository { /** * Tries to create a directory path on the target system - * + * * @param path * to create * @param session @@ -316,7 +316,7 @@ public class SshRepository extends AbstractSshBasedRepository { /** * check for existence of file or dir on target system - * + * * @param filePath * to the object to check * @param session @@ -337,7 +337,7 @@ public class SshRepository extends AbstractSshBasedRepository { /* * (non-Javadoc) - * + * * @see org.apache.ivy.repository.Repository#get(java.lang.String, java.io.File) */ public void get(String source, File destination) throws IOException { @@ -373,7 +373,7 @@ public class SshRepository extends AbstractSshBasedRepository { /** * sets the list command to use for a directory listing listing must be only the filename and * each filename on a separate line - * + * * @param cmd * to use. default is "ls -1" */ @@ -422,7 +422,7 @@ public class SshRepository extends AbstractSshBasedRepository { * The file separator is the separator to use on the target system On a unix system it is '/', * but I don't know, how this is solved on different ssh implementations. Using the default * might be fine - * + * * @param fileSeparator * The fileSeparator to use. default '/' */ @@ -433,6 +433,8 @@ public class SshRepository extends AbstractSshBasedRepository { /** * A four digit string (e.g., 0644, see "man chmod", "man open") specifying the permissions of * the published files. + * + * @param permissions String */ public void setPublishPermissions(String permissions) { this.publishPermissions = permissions; @@ -448,10 +450,11 @@ public class SshRepository extends AbstractSshBasedRepository { /** * Not really streaming...need to implement a proper streaming approach? - * + * * @param resource * to stream * @return InputStream of the resource data + * @throws IOException if something goes wrong */ public InputStream openStream(SshResource resource) throws IOException { Session session = getSession(resource.getName()); http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/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 6519811..914757f 100644 --- a/src/java/org/apache/ivy/plugins/repository/vfs/VfsRepository.java +++ b/src/java/org/apache/ivy/plugins/repository/vfs/VfsRepository.java @@ -117,10 +117,10 @@ public class VfsRepository extends AbstractRepository { /** * Get a VfsResource - * + * * @param vfsURI * a <code>String</code> identifying a VFS Resource - * @throws <code>IOException</code> on failure + * @throws IOException on failure * @see "Supported File Systems in the jakarta-commons-vfs documentation" */ public Resource getResource(String vfsURI) throws IOException { @@ -129,12 +129,12 @@ public class VfsRepository extends AbstractRepository { /** * Transfer a VFS Resource from the repository to the local file system. - * + * * @param srcVfsURI * a <code>String</code> identifying the VFS resource to be fetched * @param destination * a <code>File</code> identifying the destination file - * @throws <code>IOException</code> on failure + * @throws IOException on failure * @see "Supported File Systems in the jakarta-commons-vfs documentation" */ public void get(String srcVfsURI, File destination) throws IOException { @@ -159,7 +159,7 @@ public class VfsRepository extends AbstractRepository { /** * Return a listing of the contents of a parent directory. Listing is a set of strings * representing VFS URIs. - * + * * @param vfsURI * providing identifying a VFS provided resource * @throws IOException @@ -188,14 +188,14 @@ public class VfsRepository extends AbstractRepository { /** * Transfer an Ivy resource to a VFS repository - * + * * @param source * a <code>File</code> identifying the local file to transfer to the repository * @param vfsURI * a <code>String</code> identifying the destination VFS Resource. * @param overwrite * whether to overwrite an existing resource. - * @throws <code>IOException</code> on failure. + * @throws IOException on failure. * @see "Supported File Systems in the jakarta-commons-vfs documentation" */ public void put(File source, String vfsURI, boolean overwrite) throws IOException { http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/repository/vfs/VfsResource.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/repository/vfs/VfsResource.java b/src/java/org/apache/ivy/plugins/repository/vfs/VfsResource.java index 5a97924..444b2f9 100644 --- a/src/java/org/apache/ivy/plugins/repository/vfs/VfsResource.java +++ b/src/java/org/apache/ivy/plugins/repository/vfs/VfsResource.java @@ -83,7 +83,7 @@ public class VfsResource implements Resource { * Get a list of direct descendants of the given resource. Note that attempts to get a list of * children does <em>not</em> result in an error. Instead an error message is * logged and an empty ArrayList returned. - * + * * @return A <code>ArrayList</code> of VFSResources */ public List getChildren() { @@ -112,7 +112,7 @@ public class VfsResource implements Resource { /** * Get the name of the resource. - * + * * @return a <code>String</code> representing the Resource URL. */ public String getName() { @@ -126,9 +126,9 @@ public class VfsResource implements Resource { /** * The VFS FileName getURI method seems to have a bug in it where file: URIs will have 4 forward * slashes instead of 3. - * + * * @param vfsURI ditto - * @return a normalized <class>String</class> representing the VFS URI + * @return a normalized String representing the VFS URI */ public static String normalize(String vfsURI) { if (vfsURI == null) { @@ -143,7 +143,7 @@ public class VfsResource implements Resource { /** * Get the last modification time of the resource. - * + * * @return a <code>long</code> indicating last modified time. */ public long getLastModified() { @@ -153,7 +153,7 @@ public class VfsResource implements Resource { /** * Get the size of the resource - * + * * @return a <code>long</code> representing the size of the resource (in bytes). */ public long getContentLength() { @@ -163,7 +163,7 @@ public class VfsResource implements Resource { /** * Flag indicating whether a resource is available for querying - * + * * @return <code>true</code> if the resource is available for querying, <code>false</code> * otherwise. */ @@ -174,7 +174,7 @@ public class VfsResource implements Resource { /** * Return a flag indicating whether a provided VFS resource physically exists - * + * * @return <code>true</code> if the resource physically exists, <code>false</code> otherwise. */ public boolean physicallyExists() { http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/repository/vsftp/VsftpRepository.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/repository/vsftp/VsftpRepository.java b/src/java/org/apache/ivy/plugins/repository/vsftp/VsftpRepository.java index 1ec8f4f..59b99e7 100644 --- a/src/java/org/apache/ivy/plugins/repository/vsftp/VsftpRepository.java +++ b/src/java/org/apache/ivy/plugins/repository/vsftp/VsftpRepository.java @@ -306,6 +306,11 @@ public class VsftpRepository extends AbstractRepository { * we compare the response with the expected message and deal with it. The problem is that this * is very specific to the version of vsftp used for the test, That's why expected messages are * obtained using overriddable protected methods. + * + * @param command String + * @param expectedResponse Pattern + * @param timeout long + * @throws IOException if something goes wrong */ protected void sendCommand(String command, Pattern expectedResponse, long timeout) throws IOException { @@ -638,7 +643,7 @@ public class VsftpRepository extends AbstractRepository { /** * Parses a ls -l line and transforms it in a resource - * + * * @param file ditto * @param responseLine ditto * @return Resource @@ -729,7 +734,7 @@ public class VsftpRepository extends AbstractRepository { /** * Sets the reuse connection time. The same connection will be reused if the time here does not * last between two commands. O indicates that the connection should never be reused - * + * * @param time long */ public void setReuseConnection(long time) { http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/resolver/AbstractSshBasedResolver.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/resolver/AbstractSshBasedResolver.java b/src/java/org/apache/ivy/plugins/resolver/AbstractSshBasedResolver.java index 907ccb4..46be24a 100644 --- a/src/java/org/apache/ivy/plugins/resolver/AbstractSshBasedResolver.java +++ b/src/java/org/apache/ivy/plugins/resolver/AbstractSshBasedResolver.java @@ -47,7 +47,7 @@ public abstract class AbstractSshBasedResolver extends RepositoryResolver { /** * Sets the location of the Public Key file to use for authentication - * + * * @param filePath * full file path name */ @@ -57,7 +57,7 @@ public abstract class AbstractSshBasedResolver extends RepositoryResolver { /** * Determines whether a local SSH agent may be used for authentication - * + * * @param allowedAgentUse * true if an agent may be used if available */ @@ -69,6 +69,8 @@ public abstract class AbstractSshBasedResolver extends RepositoryResolver { * Optional password file. If set the repository will use it as an encrypted property file, to * load username and passwd entries, and to store them if the user choose to do so. Defaults to * user.dir/.ivy/[host].sftp.passwd, set it to null to disable this feature. + * + * @param passfile File */ public void setPassfile(File passfile) { getSshBasedRepository().setPassFile(passfile); @@ -89,7 +91,7 @@ public abstract class AbstractSshBasedResolver extends RepositoryResolver { * set and password based login is used, user will be prompted for it the password can also be * set by using a full url for the pattern, like * "sftp://user:[email protected]/path/to/repos/[artifact].[ext]"; - * + * * @param password * to use */ @@ -101,7 +103,7 @@ public abstract class AbstractSshBasedResolver extends RepositoryResolver { * Sets the password to use for decrypting key file (if it is encrypted) if no password is set * and the keyfile is encrypted, the user will be prompted for the password if the keyfile is * passwordless, this parameter will be ignored if given - * + * * @param password * to use */ @@ -112,7 +114,7 @@ public abstract class AbstractSshBasedResolver extends RepositoryResolver { /** * sets the user to use for the ssh communication the user can also be set by using a full url * for the pattern, like "ssh://[email protected]/path/to/repos/[artifact].[ext]" - * + * * @param user * on the target system */ @@ -123,7 +125,7 @@ public abstract class AbstractSshBasedResolver extends RepositoryResolver { /** * sets the host to use for the ssh communication the host can also be set by using a full url * for the pattern, like "ssh://myserver.com/path/to/repos/[artifact].[ext]" - * + * * @param host * of the target system */ @@ -135,7 +137,7 @@ public abstract class AbstractSshBasedResolver extends RepositoryResolver { * sets the port to use for the ssh communication port 22 is default the port can also be set by * using a full url for the pattern, like * "sftp://myserver.com:8022/path/to/repos/[artifact].[ext]"; - * + * * @param port * of the target system */ http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/resolver/DependencyResolver.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/resolver/DependencyResolver.java b/src/java/org/apache/ivy/plugins/resolver/DependencyResolver.java index 8bd4898..80b98d3 100644 --- a/src/java/org/apache/ivy/plugins/resolver/DependencyResolver.java +++ b/src/java/org/apache/ivy/plugins/resolver/DependencyResolver.java @@ -46,7 +46,7 @@ public interface DependencyResolver { /** * Should only be used by configurator - * + * * @param name * the new name of the resolver */ @@ -57,8 +57,11 @@ public interface DependencyResolver { * latest one (i.e. a revision uniquely identifying the revision of a module in the current * environment - If this revision is not able to identify uniquely the revision of the module * outside of the current environment, then the resolved revision must begin by ##) - * - * @throws ParseException + * + * @param dd DependencyDescriptor + * @param data ResolveData + * @return ResolvedModuleRevision + * @throws ParseException if something goes wrong */ ResolvedModuleRevision getDependency(DependencyDescriptor dd, ResolveData data) throws ParseException; @@ -66,7 +69,7 @@ public interface DependencyResolver { /** * Finds the module descriptor for the specified <tt>DependencyDescriptor</tt>. If this resolver * can't find the module descriptor, <tt>null</tt> is returned. - * + * * @param dd * the dependency descriptor * @param data @@ -86,7 +89,7 @@ public interface DependencyResolver { * The returned DownloadReport is never <code>null</code>, and always contain an * {@link ArtifactDownloadReport} for each requested Artifact. * </p> - * + * * @param artifacts * an array of artifacts to download. Must not be <code>null</code>. * @param options @@ -102,7 +105,7 @@ public interface DependencyResolver { * locates and downloads a set of artifacts. This method uses an {@link ArtifactOrigin}, and as * such is only used to materialize an already located Artifact. * </p> - * + * * @param artifact * the location of the artifact to download. Must not be <code>null</code>. * @param options @@ -114,7 +117,7 @@ public interface DependencyResolver { /** * Returns <code>true</code> if the given artifact can be located by this resolver and actually * exist. - * + * * @param artifact * the artifact which should be tested. * @return <code>true</code> if the given artifact can be located by this resolver and actually @@ -125,7 +128,7 @@ public interface DependencyResolver { /** * Locates the given artifact and returns its location if it can be located by this resolver and * if it actually exists, or <code>null</code> in other cases. - * + * * @param artifact * the artifact which should be located * @return the artifact location, or <code>null</code> if it can't be located by this resolver @@ -148,7 +151,7 @@ public interface DependencyResolver { /** * Reports last artifact download failure as Messages - * + * * @param art Artifact */ void reportFailure(Artifact art); @@ -159,21 +162,26 @@ public interface DependencyResolver { // are registered in ivy too. /** - * List all the values the given token can take if other tokens are set as described in the - * otherTokenValues map. For instance, if token = "revision" and the map contains - * "organisation"->"foo" "module"->"bar" The results will be the list of revisions of the module - * bar from the org foo. + * List all the values the given token can take if other tokens are set as + * described in the otherTokenValues map. For instance, if + * token = "revision" and the map contains "organisation"->"foo" "module"->"bar" + * The results will be the list of revisions of the module bar from the org foo. * <p> - * Note that listing does not take into account namespaces, and return raw information without - * any namespace transformation. The caller is responsible for calling namespace transformation - * with the Namespace returned by {@link #getNamespace()}. + * Note that listing does not take into account namespaces, and return raw + * information without any namespace transformation. The caller is + * responsible for calling namespace transformation with the Namespace + * returned by {@link #getNamespace()}. * </p> + * + * @param token String + * @param otherTokenValues Map + * @return String[] */ String[] listTokenValues(String token, Map<String, String> otherTokenValues); /** * Same as {@link #listTokenValues(String, Map)} but more generic. - * + * * @param tokens * the tokens of the query * @param criteria @@ -190,7 +198,7 @@ public interface DependencyResolver { /** * Returns the namespace associated with this resolver. - * + * * @return the namespace associated with this resolver. */ Namespace getNamespace(); @@ -202,7 +210,7 @@ public interface DependencyResolver { /** * Returns the {@link RepositoryCacheManager} used to manage the repository cache associated * with this dependency resolver. - * + * * @return the {@link RepositoryCacheManager} used to manage the repository cache associated * with this dependency resolver. */ http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/resolver/SshResolver.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/resolver/SshResolver.java b/src/java/org/apache/ivy/plugins/resolver/SshResolver.java index bdb5e98..3c68dcc 100644 --- a/src/java/org/apache/ivy/plugins/resolver/SshResolver.java +++ b/src/java/org/apache/ivy/plugins/resolver/SshResolver.java @@ -31,6 +31,8 @@ public class SshResolver extends AbstractSshBasedResolver { /** * A four digit string (e.g., 0644, see "man chmod", "man open") specifying the permissions of * the published files. + * + * @param permissions String */ public void setPublishPermissions(String permissions) { ((SshRepository) getRepository()).setPublishPermissions(permissions); @@ -39,7 +41,7 @@ public class SshResolver extends AbstractSshBasedResolver { /** * sets the path separator used on the target system. Not sure if this is used or if '/' is used * on all implementation. default is to use '/' - * + * * @param sep * file separator to use on the target system */ @@ -57,6 +59,8 @@ public class SshResolver extends AbstractSshBasedResolver { * the term %arg can be used in the command to substitute the path to be listed (e.g. * "ls -1 %arg | grep -v CVS" to get a listing without CVS directory) if %arg is not part of the * command, the path will be appended to the command default is: "ls -1" + * + * @param cmd String */ public void setListCommand(String cmd) { ((SshRepository) getRepository()).setListCommand(cmd); @@ -65,9 +69,11 @@ public class SshResolver extends AbstractSshBasedResolver { /** * set the command to check for existence of a file the command has to be a shell command * working on the target system and has to create an exit status of 0 for an existent file and - * <> 0 for a non existing file given as argument the term %arg can be used in the command to - * substitute the path to be listed if %arg is not part of the command, the path will be appended - * to the command default is: "ls" + * <> 0 for a non existing file given as argument the term %arg can be used in the command + * to substitute the path to be listed if %arg is not part of the command, the path will be + * appended to the command default is: "ls" + * + * @param cmd String */ public void setExistCommand(String cmd) { ((SshRepository) getRepository()).setExistCommand(cmd); @@ -78,6 +84,8 @@ public class SshResolver extends AbstractSshBasedResolver { * command working on the target system and has to create a directory with the given argument * the term %arg can be used in the command to substitute the path to be listed if %arg is not * part of the command, the path will be appended to the command default is: "mkdir" + * + * @param cmd String */ public void setCreateDirCommand(String cmd) { ((SshRepository) getRepository()).setExistCommand(cmd); http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/resolver/WorkspaceChainResolver.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/resolver/WorkspaceChainResolver.java b/src/java/org/apache/ivy/plugins/resolver/WorkspaceChainResolver.java index a3662cf..a1028d1 100644 --- a/src/java/org/apache/ivy/plugins/resolver/WorkspaceChainResolver.java +++ b/src/java/org/apache/ivy/plugins/resolver/WorkspaceChainResolver.java @@ -20,9 +20,9 @@ package org.apache.ivy.plugins.resolver; import org.apache.ivy.core.settings.IvySettings; /** - * Resolver which decorate normal resolver so that the workspace resolver can hijack the resolve - * process <br /> - * NB : it is for internal usage of Ivy only! + * Resolver which decorate normal resolver so that the workspace resolver can + * hijack the resolveprocess + * <p>NB : it is for internal usage of Ivy only!</p> */ public class WorkspaceChainResolver extends ChainResolver { http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/resolver/packager/PackagerCacheEntry.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/resolver/packager/PackagerCacheEntry.java b/src/java/org/apache/ivy/plugins/resolver/packager/PackagerCacheEntry.java index a7fe87a..b88f0e5 100644 --- a/src/java/org/apache/ivy/plugins/resolver/packager/PackagerCacheEntry.java +++ b/src/java/org/apache/ivy/plugins/resolver/packager/PackagerCacheEntry.java @@ -81,14 +81,14 @@ public class PackagerCacheEntry { /** * Attempt to build this entry. - * + * * @param packagerResource * packager metadata resource * @param properties * a map of properties to pass to the child Ant build responsible for dependency * packaging - * - * @throws IllegalStateException + * + * @throws IOException * if this entry has already been built */ public synchronized void build(Resource packagerResource, Map properties) throws IOException { @@ -176,6 +176,8 @@ public class PackagerCacheEntry { /** * Has this entry been successfully built? + * + * @return boolean */ public synchronized boolean isBuilt() { return this.built; @@ -183,7 +185,9 @@ public class PackagerCacheEntry { /** * Get a built artifact. - * + * + * @param artifact ditto + * @return ResolvedResource * @throws IllegalStateException * if this entry's built has not (yet) completed successfully */ http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/plugins/resolver/packager/PackagerResolver.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/plugins/resolver/packager/PackagerResolver.java b/src/java/org/apache/ivy/plugins/resolver/packager/PackagerResolver.java index 6a12ba1..26ed972 100644 --- a/src/java/org/apache/ivy/plugins/resolver/packager/PackagerResolver.java +++ b/src/java/org/apache/ivy/plugins/resolver/packager/PackagerResolver.java @@ -36,10 +36,11 @@ import org.apache.ivy.util.Message; /** * Resolver that performs a "build" operation to resolve artifacts. - * + * * <p> * The resolver is configured with a base URL, from which the "ivy.xml" and "packager.xml" files are * resolved. The latter file contains instructions describing how to build the actual artifacts. + * </p> */ public class PackagerResolver extends URLResolver { @@ -93,6 +94,8 @@ public class PackagerResolver extends URLResolver { /** * Set root directory under which builds take place. + * + * @param buildRoot File */ public void setBuildRoot(File buildRoot) { this.buildRoot = buildRoot; @@ -100,6 +103,8 @@ public class PackagerResolver extends URLResolver { /** * Returns root directory under which builds take place. + * + * @return File */ public File getBuildRoot() { return buildRoot; @@ -107,6 +112,8 @@ public class PackagerResolver extends URLResolver { /** * Set resource cache directory. + * + * @param resourceCache File */ public void setResourceCache(File resourceCache) { this.resourceCache = resourceCache; @@ -114,6 +121,8 @@ public class PackagerResolver extends URLResolver { /** * Get resource cache directory. + * + * @return File */ public File getResourceCache() { return resourceCache; @@ -121,6 +130,8 @@ public class PackagerResolver extends URLResolver { /** * Set base resource override URL pattern. + * + * @param resourceURL String */ public void setResourceURL(String resourceURL) { this.resourceURL = resourceURL; @@ -128,6 +139,8 @@ public class PackagerResolver extends URLResolver { /** * Set pattern for locating "packager.xml" files. + * + * @param pattern String */ public void setPackagerPattern(String pattern) { ArrayList list = new ArrayList(); @@ -137,6 +150,8 @@ public class PackagerResolver extends URLResolver { /** * Set whether to preserve build directories. Default is false. + * + * @param preserve boolean */ public void setPreserveBuildDirectories(boolean preserve) { this.preserve = preserve; @@ -144,6 +159,8 @@ public class PackagerResolver extends URLResolver { /** * Set whether to enable restricted mode. Default is true. + * + * @param restricted boolean */ public void setRestricted(boolean restricted) { this.restricted = restricted; @@ -151,6 +168,8 @@ public class PackagerResolver extends URLResolver { /** * Set whether to run ant with the -verbose flag. Default is false. + * + * @param verbose boolean */ public void setVerbose(boolean verbose) { this.verbose = verbose; @@ -158,6 +177,8 @@ public class PackagerResolver extends URLResolver { /** * Set whether to run ant with the -quiet flag. Default is false. + * + * @param quiet boolean */ public void setQuiet(boolean quiet) { this.quiet = quiet; @@ -165,6 +186,8 @@ public class PackagerResolver extends URLResolver { /** * Set whether to validate downloaded packager.xml files. Default is true. + * + * @param validate boolean */ public void setValidate(boolean validate) { this.validate = validate; @@ -185,7 +208,7 @@ public class PackagerResolver extends URLResolver { /** * Sets a property to be passed to the child Ant build responsible for packaging the dependency. - * + * * @param propertyKey * the property to pass * @param propertyValue
