Make Java 8 doclint happy; adjust javadoc Ant target; remove connection to svn from build.xml
Project: http://git-wip-us.apache.org/repos/asf/ant-ivy/repo Commit: http://git-wip-us.apache.org/repos/asf/ant-ivy/commit/baf03a91 Tree: http://git-wip-us.apache.org/repos/asf/ant-ivy/tree/baf03a91 Diff: http://git-wip-us.apache.org/repos/asf/ant-ivy/diff/baf03a91 Branch: refs/heads/master Commit: baf03a919c75822d1dcdaa7ffd460ec635b6a50f Parents: 6c92f32 Author: twogee <[email protected]> Authored: Sun May 28 11:30:37 2017 +0200 Committer: twogee <[email protected]> Committed: Sun May 28 11:40:55 2017 +0200 ---------------------------------------------------------------------- build.xml | 405 ++++++++++--------- src/java/org/apache/ivy/Ivy.java | 50 +-- src/java/org/apache/ivy/Ivy14.java | 8 +- .../org/apache/ivy/ant/AntBuildTrigger.java | 10 +- src/java/org/apache/ivy/ant/IvyAntSettings.java | 7 +- src/java/org/apache/ivy/ant/IvyBuildList.java | 10 +- src/java/org/apache/ivy/ant/IvyPublish.java | 2 + src/java/org/apache/ivy/ant/IvyResolve.java | 1 + src/java/org/apache/ivy/ant/IvyRetrieve.java | 12 +- src/java/org/apache/ivy/ant/IvyTask.java | 4 +- src/java/org/apache/ivy/core/IvyContext.java | 26 +- .../apache/ivy/core/RelativeUrlResolver.java | 9 +- .../apache/ivy/core/cache/ArtifactOrigin.java | 15 +- .../cache/DefaultRepositoryCacheManager.java | 38 +- .../org/apache/ivy/core/check/CheckEngine.java | 4 + .../apache/ivy/core/deliver/DeliverEngine.java | 8 +- .../apache/ivy/core/deliver/DeliverOptions.java | 31 +- .../org/apache/ivy/core/event/IvyEvent.java | 24 +- .../apache/ivy/core/event/IvyEventFilter.java | 9 +- .../descriptor/DefaultDependencyDescriptor.java | 36 +- .../descriptor/DefaultModuleDescriptor.java | 21 +- .../DependencyArtifactDescriptor.java | 22 +- .../module/descriptor/DependencyDescriptor.java | 24 +- .../module/descriptor/ExtendsDescriptor.java | 32 +- .../module/descriptor/ModuleDescriptor.java | 133 +++--- .../apache/ivy/core/module/id/ArtifactId.java | 4 +- .../ivy/core/module/id/MatcherLookup.java | 22 +- .../apache/ivy/core/publish/PublishEngine.java | 7 + .../core/report/ConfigurationResolveReport.java | 25 +- .../apache/ivy/core/report/DownloadStatus.java | 3 +- .../apache/ivy/core/report/ResolveReport.java | 22 +- .../org/apache/ivy/core/resolve/IvyNode.java | 57 ++- .../apache/ivy/core/resolve/IvyNodeCallers.java | 3 +- .../ivy/core/resolve/IvyNodeEviction.java | 10 +- .../apache/ivy/core/resolve/ResolveEngine.java | 47 ++- .../apache/ivy/core/resolve/ResolveOptions.java | 13 +- .../org/apache/ivy/core/resolve/VisitNode.java | 22 +- .../ivy/core/retrieve/RetrieveEngine.java | 9 +- .../ivy/core/retrieve/RetrieveReport.java | 10 + .../apache/ivy/core/search/SearchEngine.java | 20 +- .../apache/ivy/core/settings/IvySettings.java | 33 +- .../core/sort/CollectionOfModulesToSort.java | 6 +- .../ivy/core/sort/ModuleDescriptorSorter.java | 14 +- .../org/apache/ivy/core/sort/ModuleInSort.java | 17 +- .../apache/ivy/osgi/core/BundleInfoAdapter.java | 7 +- .../apache/ivy/osgi/util/DelegatingHandler.java | 108 +++-- .../circular/CircularDependencyHelper.java | 5 +- .../LatestCompatibleConflictManager.java | 16 +- .../plugins/latest/WorkspaceLatestStrategy.java | 4 +- .../ivy/plugins/lock/FileBasedLockStrategy.java | 19 +- .../apache/ivy/plugins/lock/LockStrategy.java | 11 +- .../matcher/ExactOrRegexpPatternMatcher.java | 5 +- .../plugins/matcher/ExactPatternMatcher.java | 3 +- .../ivy/plugins/matcher/GlobPatternMatcher.java | 10 +- .../ivy/plugins/matcher/PatternMatcher.java | 7 +- .../plugins/parser/ModuleDescriptorParser.java | 8 +- .../ivy/plugins/parser/ParserSettings.java | 2 +- .../parser/m2/PomModuleDescriptorParser.java | 12 +- .../apache/ivy/plugins/parser/m2/PomReader.java | 3 + .../parser/xml/XmlModuleDescriptorParser.java | 60 ++- .../parser/xml/XmlModuleDescriptorUpdater.java | 17 +- .../ivy/plugins/report/XmlReportParser.java | 2 + .../ivy/plugins/repository/Repository.java | 45 +-- .../apache/ivy/plugins/repository/Resource.java | 12 +- .../ivy/plugins/repository/TransferEvent.java | 36 +- .../ssh/AbstractSshBasedRepository.java | 13 +- .../ivy/plugins/repository/ssh/SshCache.java | 22 +- .../plugins/repository/ssh/SshRepository.java | 25 +- .../plugins/repository/vfs/VfsRepository.java | 14 +- .../ivy/plugins/repository/vfs/VfsResource.java | 16 +- .../repository/vsftp/VsftpRepository.java | 9 +- .../resolver/AbstractSshBasedResolver.java | 16 +- .../plugins/resolver/DependencyResolver.java | 46 ++- .../ivy/plugins/resolver/SshResolver.java | 16 +- .../resolver/WorkspaceChainResolver.java | 6 +- .../resolver/packager/PackagerCacheEntry.java | 12 +- .../resolver/packager/PackagerResolver.java | 27 +- .../ivy/plugins/version/VersionMatcher.java | 14 +- src/java/org/apache/ivy/util/FileUtil.java | 57 ++- src/java/org/apache/ivy/util/StringUtils.java | 11 +- src/java/org/apache/ivy/util/XMLHelper.java | 21 +- .../apache/ivy/util/filter/FilterHelper.java | 16 +- .../org/apache/ivy/util/url/URLHandler.java | 51 +-- .../apache/ivy/util/url/URLHandlerRegistry.java | 2 +- 84 files changed, 1151 insertions(+), 920 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/build.xml ---------------------------------------------------------------------- diff --git a/build.xml b/build.xml index d6f50b5..e16296c 100644 --- a/build.xml +++ b/build.xml @@ -18,50 +18,50 @@ --> <project name="ivy" default="coverage-report" xmlns:ivy="antlib:org.apache.ivy.ant"> - <property environment="env" /> - <property file="version.properties" /> - <property file="build.properties" /> + <property environment="env"/> + <property file="version.properties"/> + <property file="build.properties"/> - <property name="final.name" value="ivy.jar" /> + <property name="final.name" value="ivy.jar"/> <target name="init-ivy-user-home" unless="ivy.use.local.home"> <condition property="ivy.home" value="${env.IVY_HOME}"> - <isset property="env.IVY_HOME" /> + <isset property="env.IVY_HOME"/> </condition> - <property name="ivy.home" value="${user.home}/.ivy2" /> + <property name="ivy.home" value="${user.home}/.ivy2"/> </target> <target name="init-ivy-local-home" if="ivy.use.local.home"> - <property name="ivy.home" value="${basedir}/.ivy2" /> + <property name="ivy.home" value="${basedir}/.ivy2"/> </target> - <target name="init-ivy-home" depends="init-ivy-user-home, init-ivy-local-home" /> + <target name="init-ivy-home" depends="init-ivy-user-home,init-ivy-local-home"/> - <target name="init-ivy" depends="compile-bootstrap, init-ivy-home"> + <target name="init-ivy" depends="compile-bootstrap,init-ivy-home"> <taskdef resource="org/apache/ivy/ant/antlib.xml" uri="antlib:org.apache.ivy.ant"> <classpath> - <pathelement location="${core.classes.build.dir}" /> - <pathelement location="${bootstrap.classes.build.dir}" /> + <pathelement location="${core.classes.build.dir}"/> + <pathelement location="${bootstrap.classes.build.dir}"/> </classpath> </taskdef> - <ivy:configure override="true" /> + <ivy:configure override="true"/> </target> - <target name="install" depends="init-ivy-home, jar" + <target name="install" depends="init-ivy-home,jar" description="build Ivy and install it in Ivy user home for builds using Ivy user home to load Ivy jar"> - <property name="ivy.jar.file" value="${ivy.home}/jars/ivy.jar" /> - <copy file="${artifacts.build.dir}/jars/${final.name}" tofile="${ivy.jar.file}" /> + <property name="ivy.jar.file" value="${ivy.home}/jars/ivy.jar"/> + <copy file="${artifacts.build.dir}/jars/${final.name}" tofile="${ivy.jar.file}"/> </target> - <target name="install-ant" depends="init-ivy-home, jar" + <target name="install-ant" depends="init-ivy-home,jar" description="build Ivy and install it in Ant home lib"> <condition property="ant.home" value="${env.ANT_HOME}"> - <isset property="env.ANT_HOME" /> + <isset property="env.ANT_HOME"/> </condition> - <fail unless="ant.home" message="ANT_HOME environment variable or ant.home property required" /> - <copy file="${artifacts.build.dir}/jars/${final.name}" tofile="${ant.home}/lib/ivy.jar" /> + <fail unless="ant.home" message="ANT_HOME environment variable or ant.home property required"/> + <copy file="${artifacts.build.dir}/jars/${final.name}" tofile="${ant.home}/lib/ivy.jar"/> </target> <!-- ================================================================= @@ -70,111 +70,111 @@ <target name="init"> <path id="lib.classpath"> <fileset dir="${lib.dir}"> - <include name="*.jar" /> + <include name="*.jar"/> </fileset> </path> <path id="build.bootstrap.classpath"> - <pathelement location="${core.classes.build.dir}" /> + <pathelement location="${core.classes.build.dir}"/> </path> <path id="build.ant.classpath"> - <pathelement location="${core.classes.build.dir}" /> - <path refid="lib.classpath" /> + <pathelement location="${core.classes.build.dir}"/> + <path refid="lib.classpath"/> </path> <path id="build.optional.classpath"> - <path refid="build.ant.classpath" /> + <path refid="build.ant.classpath"/> </path> <path id="run.classpath"> - <pathelement location="${core.classes.build.dir}" /> - <pathelement location="${ant.classes.build.dir}" /> - <pathelement location="${optional.classes.build.dir}" /> - <path refid="lib.classpath" /> + <pathelement location="${core.classes.build.dir}"/> + <pathelement location="${ant.classes.build.dir}"/> + <pathelement location="${optional.classes.build.dir}"/> + <path refid="lib.classpath"/> </path> <path id="test.classpath"> - <pathelement location="${coverage.classes.dir}" /> + <pathelement location="${coverage.classes.dir}"/> <fileset dir="${lib.dir}"> - <include name="*.jar" /> - <exclude name="ant.jar" /> - <exclude name="ant-launcher.jar" /> + <include name="*.jar"/> + <exclude name="ant.jar"/> + <exclude name="ant-launcher.jar"/> <exclude name="ant-nodeps.jar"/> <exclude name="ant-trax.jar"/> </fileset> - <pathelement location="${core.classes.build.dir}" /> - <pathelement location="${ant.classes.build.dir}" /> - <pathelement location="${optional.classes.build.dir}" /> - <pathelement path="${test.build.dir}" /> + <pathelement location="${core.classes.build.dir}"/> + <pathelement location="${ant.classes.build.dir}"/> + <pathelement location="${optional.classes.build.dir}"/> + <pathelement path="${test.build.dir}"/> </path> </target> <target name="prepare" depends="init"> - <mkdir dir="${classes.build.dir}" /> - <mkdir dir="${core.classes.build.dir}" /> - <mkdir dir="${bootstrap.classes.build.dir}" /> - <mkdir dir="${ant.classes.build.dir}" /> - <mkdir dir="${optional.classes.build.dir}" /> - <mkdir dir="${all.classes.build.dir}" /> - <mkdir dir="${test.build.dir}" /> - <mkdir dir="${artifacts.build.dir}" /> - <mkdir dir="${test.report.dir}" /> - <mkdir dir="${ivy.report.dir}" /> + <mkdir dir="${classes.build.dir}"/> + <mkdir dir="${core.classes.build.dir}"/> + <mkdir dir="${bootstrap.classes.build.dir}"/> + <mkdir dir="${ant.classes.build.dir}"/> + <mkdir dir="${optional.classes.build.dir}"/> + <mkdir dir="${all.classes.build.dir}"/> + <mkdir dir="${test.build.dir}"/> + <mkdir dir="${artifacts.build.dir}"/> + <mkdir dir="${test.report.dir}"/> + <mkdir dir="${ivy.report.dir}"/> </target> <target name="clean" description="delete all generated files keeping sources only"> - <delete dir="${classes.build.dir}" /> - <delete dir="${test.build.dir}" /> - <delete dir="${artifacts.build.dir}" /> - <delete dir="${test.report.dir}" /> - <delete dir="${javadoc.build.dir}" /> - <delete dir="${doc.build.dir}" /> - <delete dir="${build.dir}" /> + <delete dir="${classes.build.dir}"/> + <delete dir="${test.build.dir}"/> + <delete dir="${artifacts.build.dir}"/> + <delete dir="${test.report.dir}"/> + <delete dir="${javadoc.build.dir}"/> + <delete dir="${doc.build.dir}"/> + <delete dir="${build.dir}"/> </target> <target name="clean-lib"> - <delete dir="${lib.dir}" /> + <delete dir="${lib.dir}"/> </target> <target name="clean-ivy-cache" depends="init-ivy-home"> - <delete dir="${ivy.home}/cache" /> + <delete dir="${ivy.home}/cache"/> </target> <target name="clean-ivy-home" depends="init-ivy-home"> - <delete dir="${ivy.home}" /> + <delete dir="${ivy.home}"/> </target> <target name="clean-examples" description="clean all examples"> <subant target="clean" failonerror="false"> - <fileset dir="${example.dir}" includes="**/build.xml" /> + <fileset dir="${example.dir}" includes="**/build.xml"/> </subant> </target> - <target name="clean-all" depends="clean, clean-lib, clean-examples" /> + <target name="clean-all" depends="clean-examples,clean,clean-lib"/> <target name="/noresolve" description="use to skip dependency resolution"> - <property name="no.resolve" value="true" /> + <property name="no.resolve" value="true"/> </target> <target name="/notest" description="use to skip tests"> - <property name="skip.test" value="true" /> + <property name="skip.test" value="true"/> </target> <target name="/nojavadoc" description="use to skip javadoc"> - <property name="skip.javadoc" value="true" /> + <property name="skip.javadoc" value="true"/> </target> <target name="/localivy" description="use a local ivy home"> - <property name="ivy.use.local.home" value="true" /> + <property name="ivy.use.local.home" value="true"/> </target> <target name="/offline" depends="/noresolve" description="use to indicate no internet connection is available"> - <property name="offline" value="true" /> + <property name="offline" value="true"/> </target> <target name="default-version"> <tstamp> - <format property="pubdate" pattern="yyyyMMddHHmmss" /> + <format property="pubdate" pattern="yyyyMMddHHmmss"/> </tstamp> - <property name="version.prefix" value="${target.ivy.version}-local-" /> - <property name="build.version" value="${version.prefix}${pubdate}" /> - <property name="bundle.version" value="${target.ivy.bundle.version}.${target.ivy.bundle.version.qualifier}${pubdate}" /> + <property name="version.prefix" value="${target.ivy.version}-local-"/> + <property name="build.version" value="${version.prefix}${pubdate}"/> + <property name="bundle.version" value="${target.ivy.bundle.version}.${target.ivy.bundle.version.qualifier}${pubdate}"/> </target> <!-- ================================================================= @@ -192,30 +192,30 @@ target="${ivy.minimum.javaversion}" debug="${debug.mode}" includeantruntime="no"> - <excludesfile name="ant.patterns" /> - <excludesfile name="optional.patterns" /> + <excludesfile name="ant.patterns"/> + <excludesfile name="optional.patterns"/> </javac> <copy todir="${core.classes.build.dir}" includeEmptyDirs="false"> <fileset dir="${src.dir}"> - <exclude name="**/*.java" /> - <excludesfile name="ant.patterns" /> - <excludesfile name="optional.patterns" /> + <exclude name="**/*.java"/> + <excludesfile name="ant.patterns"/> + <excludesfile name="optional.patterns"/> </fileset> </copy> <!-- copy settings files for backward compatibility with ivyconf naming --> <copy file="${core.classes.build.dir}/org/apache/ivy/core/settings/ivysettings-local.xml" - tofile="${core.classes.build.dir}/org/apache/ivy/core/settings/ivyconf-local.xml" /> + tofile="${core.classes.build.dir}/org/apache/ivy/core/settings/ivyconf-local.xml"/> <copy file="${core.classes.build.dir}/org/apache/ivy/core/settings/ivysettings-default-chain.xml" - tofile="${core.classes.build.dir}/org/apache/ivy/core/settings/ivyconf-default-chain.xml" /> + tofile="${core.classes.build.dir}/org/apache/ivy/core/settings/ivyconf-default-chain.xml"/> <copy file="${core.classes.build.dir}/org/apache/ivy/core/settings/ivysettings-main-chain.xml" - tofile="${core.classes.build.dir}/org/apache/ivy/core/settings/ivyconf-main-chain.xml" /> + tofile="${core.classes.build.dir}/org/apache/ivy/core/settings/ivyconf-main-chain.xml"/> <copy file="${core.classes.build.dir}/org/apache/ivy/core/settings/ivysettings-public.xml" - tofile="${core.classes.build.dir}/org/apache/ivy/core/settings/ivyconf-public.xml" /> + tofile="${core.classes.build.dir}/org/apache/ivy/core/settings/ivyconf-public.xml"/> <copy file="${core.classes.build.dir}/org/apache/ivy/core/settings/ivysettings-shared.xml" - tofile="${core.classes.build.dir}/org/apache/ivy/core/settings/ivyconf-shared.xml" /> + tofile="${core.classes.build.dir}/org/apache/ivy/core/settings/ivyconf-shared.xml"/> <copy file="${core.classes.build.dir}/org/apache/ivy/core/settings/ivysettings.xml" - tofile="${core.classes.build.dir}/org/apache/ivy/core/settings/ivyconf.xml" /> + tofile="${core.classes.build.dir}/org/apache/ivy/core/settings/ivyconf.xml"/> </target> <!-- Build the Ant tasks with the current Ant runtime --> @@ -228,18 +228,18 @@ target="${ivy.minimum.javaversion}" debug="${debug.mode}" includeantruntime="yes"> - <includesfile name="ant.patterns" /> + <includesfile name="ant.patterns"/> </javac> <copy todir="${bootstrap.classes.build.dir}" includeEmptyDirs="false"> <fileset dir="${src.dir}"> - <includesfile name="ant.patterns" /> - <exclude name="**/*.java" /> + <includesfile name="ant.patterns"/> + <exclude name="**/*.java"/> </fileset> </copy> </target> <!-- Build the Ant tasks with the minimal Ant runtime --> - <target name="compile-ant" depends="compile-core, resolve"> + <target name="compile-ant" depends="compile-core,resolve"> <javac srcdir="${src.dir}" destdir="${ant.classes.build.dir}" sourcepath="" @@ -248,21 +248,21 @@ target="${ivy.minimum.javaversion}" debug="${debug.mode}" includeantruntime="no"> - <includesfile name="ant.patterns" /> + <includesfile name="ant.patterns"/> </javac> <copy todir="${ant.classes.build.dir}" includeEmptyDirs="false"> <fileset dir="${src.dir}"> - <includesfile name="ant.patterns" /> - <exclude name="**/*.java" /> + <includesfile name="ant.patterns"/> + <exclude name="**/*.java"/> </fileset> </copy> <!-- copy antlib for backward compatibility with fr.jayasoft.ivy package --> <copy file="${ant.classes.build.dir}/org/apache/ivy/ant/antlib.xml" - todir="${ant.classes.build.dir}/fr/jayasoft/ivy/ant" /> + todir="${ant.classes.build.dir}/fr/jayasoft/ivy/ant"/> </target> - <target name="compile-optional" depends="compile-ant, resolve"> + <target name="compile-optional" depends="compile-ant,resolve"> <javac srcdir="${src.dir}" destdir="${optional.classes.build.dir}" sourcepath="" @@ -271,13 +271,13 @@ target="${ivy.minimum.javaversion}" debug="${debug.mode}" includeantruntime="no"> - <includesfile name="optional.patterns" /> - <includesfile name="ant.patterns" /> + <includesfile name="optional.patterns"/> + <includesfile name="ant.patterns"/> </javac> <copy todir="${core.classes.build.dir}" includeEmptyDirs="false"> <fileset dir="${src.dir}"> - <includesfile name="optional.patterns" /> - <exclude name="**/*.java" /> + <includesfile name="optional.patterns"/> + <exclude name="**/*.java"/> </fileset> </copy> </target> @@ -285,10 +285,10 @@ <!-- ================================================================= Create the two jar files (Ivy core and Ivy core + Ant tasks) ================================================================= --> - <target name="jar" depends="compile-optional, default-version" description="Create Jar files"> + <target name="jar" depends="compile-optional,default-version" description="Create Jar files"> <!-- identify compiled ivy version --> - <echo message="version=${build.version}${line.separator}" file="${core.classes.build.dir}/module.properties" append="true" /> - <echo message="date=${pubdate}${line.separator}" file="${core.classes.build.dir}/module.properties" append="true" /> + <echo message="version=${build.version}${line.separator}" file="${core.classes.build.dir}/module.properties" append="true"/> + <echo message="date=${pubdate}${line.separator}" file="${core.classes.build.dir}/module.properties" append="true"/> <mkdir dir="${artifacts.build.dir}/jars/"/> @@ -299,38 +299,38 @@ --> <copy file="${basedir}/META-INF/MANIFEST.MF" tofile="${artifacts.build.dir}/MANIFEST.MF"> <filterchain> - <replaceregex pattern="Bundle-Version:.*" replace="Bundle-Version: ${bundle.version}" byline="true" /> + <replaceregex pattern="Bundle-Version:.*" replace="Bundle-Version: ${bundle.version}" byline="true"/> </filterchain> </copy> <copy todir="${all.classes.build.dir}"> - <fileset dir="${core.classes.build.dir}" /> - <fileset dir="${ant.classes.build.dir}" /> - <fileset dir="${optional.classes.build.dir}" /> + <fileset dir="${core.classes.build.dir}"/> + <fileset dir="${ant.classes.build.dir}"/> + <fileset dir="${optional.classes.build.dir}"/> </copy> <jar destfile="${artifacts.build.dir}/jars/${final.name}" manifest="${artifacts.build.dir}/MANIFEST.MF"> - <metainf dir="${basedir}" includes="LICENSE,NOTICE" /> + <metainf dir="${basedir}" includes="LICENSE,NOTICE"/> <manifest> - <attribute name="Specification-Title" value="Apache Ivy with Ant tasks" /> - <attribute name="Specification-Version" value="${build.version}" /> - <attribute name="Specification-Vendor" value="Apache Software Foundation" /> - <attribute name="Implementation-Title" value="org.apache.ivy" /> - <attribute name="Implementation-Version" value="${build.version}" /> - <attribute name="Implementation-Vendor" value="Apache Software Foundation" /> - <attribute name="Implementation-Vendor-Id" value="org.apache" /> - <attribute name="Extension-name" value="org.apache.ivy" /> - <attribute name="Build-Version" value="${build.version}" /> + <attribute name="Specification-Title" value="Apache Ivy with Ant tasks"/> + <attribute name="Specification-Version" value="${build.version}"/> + <attribute name="Specification-Vendor" value="Apache Software Foundation"/> + <attribute name="Implementation-Title" value="org.apache.ivy"/> + <attribute name="Implementation-Version" value="${build.version}"/> + <attribute name="Implementation-Vendor" value="Apache Software Foundation"/> + <attribute name="Implementation-Vendor-Id" value="org.apache"/> + <attribute name="Extension-name" value="org.apache.ivy"/> + <attribute name="Build-Version" value="${build.version}"/> </manifest> - <fileset dir="${all.classes.build.dir}" /> + <fileset dir="${all.classes.build.dir}"/> </jar> <!-- copy main jar to ease its use as an OSGi bundle --> <copy file="${artifacts.build.dir}/jars/${final.name}" - tofile="${artifacts.build.dir}/org.apache.ivy_${bundle.version}.jar" /> + tofile="${artifacts.build.dir}/org.apache.ivy_${bundle.version}.jar"/> <!-- clean generated module properties file --> - <delete file="${core.classes.build.dir}/module.properties" /> + <delete file="${core.classes.build.dir}/module.properties"/> </target> <!-- ================================================================= @@ -339,75 +339,75 @@ <target name="publish-local" depends="jar,sources" description="publishes Ivy to Ivy local repository"> <ivy:publish resolver="local" pubrevision="${build.version}" artifactsPattern="${artifacts.build.dir}/[type]s/[artifact].[ext]" - forcedeliver="true" /> + forcedeliver="true"/> </target> <!-- ================================================================= TESTS ================================================================= --> <target name="build-custom-resolver-jar" depends="jar"> - <mkdir dir="${build.dir}/custom-classpath" /> + <mkdir dir="${build.dir}/custom-classpath"/> <javac srcdir="${basedir}/test/custom-classpath" destdir="${build.dir}/custom-classpath" classpathref="run.classpath" source="${ivy.minimum.javaversion}" target="${ivy.minimum.javaversion}" debug="${debug.mode}" - includeantruntime="no" /> + includeantruntime="no"/> <jar destfile="${test.dir}/org/apache/ivy/core/settings/custom-resolver.jar" - basedir="${build.dir}/custom-classpath" /> + basedir="${build.dir}/custom-classpath"/> </target> <target name="init-tests-offline" if="offline"> <fileset id="test.fileset" dir="${test.dir}"> - <include name="**/${test.class.pattern}.java" /> - <exclude name="**/Abstract*Test.java" /> - <not><contains text="remote.test" /></not> + <include name="**/${test.class.pattern}.java"/> + <exclude name="**/Abstract*Test.java"/> + <not><contains text="remote.test"/></not> </fileset> </target> <target name="init-tests-online" unless="offline"> <fileset id="test.fileset" dir="${test.dir}"> - <include name="**/${test.class.pattern}.java" /> - <exclude name="**/Abstract*Test.java" /> + <include name="**/${test.class.pattern}.java"/> + <exclude name="**/Abstract*Test.java"/> </fileset> </target> - <target name="init-tests" depends="init-tests-offline, init-tests-online" /> + <target name="init-tests" depends="init-tests-offline,init-tests-online"/> <target name="emma" depends="jar" unless="skip.test"> <ivy:cachepath organisation="emma" module="emma" revision="2.0.5312" inline="true" conf="default" pathid="emma.classpath" - log="download-only" /> + log="download-only"/> <ivy:cachepath organisation="emma" module="emma_ant" revision="2.0.5312" inline="true" conf="default" pathid="emma.ant.classpath" transitive="false" - log="download-only" /> + log="download-only"/> <taskdef resource="emma_ant.properties"> - <classpath refid="emma.classpath" /> - <classpath refid="emma.ant.classpath" /> + <classpath refid="emma.classpath"/> + <classpath refid="emma.ant.classpath"/> </taskdef> - <property name="emma.enabled" value="true" /> - <property name="coverage.dir" value="${build.dir}/coverage" /> - <property name="coverage.classes.dir" value="${coverage.dir}/classes" /> - <mkdir dir="${coverage.dir}" /> - <mkdir dir="${coverage.classes.dir}" /> + <property name="emma.enabled" value="true"/> + <property name="coverage.dir" value="${build.dir}/coverage"/> + <property name="coverage.classes.dir" value="${coverage.dir}/classes"/> + <mkdir dir="${coverage.dir}"/> + <mkdir dir="${coverage.classes.dir}"/> <emma enabled="${emma.enabled}"> <instr mode="copy" destdir="${coverage.dir}/classes" metadatafile="${coverage.dir}/metadata.emma"> <instrpath> - <pathelement location="${core.classes.build.dir}" /> - <pathelement location="${ant.classes.build.dir}" /> - <pathelement location="${optional.classes.build.dir}" /> + <pathelement location="${core.classes.build.dir}"/> + <pathelement location="${ant.classes.build.dir}"/> + <pathelement location="${optional.classes.build.dir}"/> </instrpath> </instr> </emma> - <delete file="${coverage.dir}/coverage.emma" /> + <delete file="${coverage.dir}/coverage.emma"/> <!-- add emma path to test path, because emma jars need to be available when running instrumented classes --> <ivy:addpath topath="test.classpath" first="true"> - <pathelement location="${coverage.dir}/classes" /> - <path refid="emma.classpath" /> + <pathelement location="${coverage.dir}/classes"/> + <path refid="emma.classpath"/> </ivy:addpath> </target> @@ -419,30 +419,30 @@ target="${ivy.minimum.javaversion}" debug="${debug.mode}" encoding="ISO-8859-1" - includeantruntime="no" /> + includeantruntime="no"/> <copy todir="${test.build.dir}"> <fileset dir="${test.dir}"> - <exclude name="**/*.java" /> + <exclude name="**/*.java"/> </fileset> </copy> </target> <target name="prepare-osgi-tests" depends="resolve" unless="skip.test"> - <ant dir="${basedir}/test/test-repo" target="generate-bundles" /> + <ant dir="${basedir}/test/test-repo" target="generate-bundles"/> </target> <target name="prepare-test-jar-repositories" unless="skip.test"> - <mkdir dir="${basedir}/test/jar-repos" /> + <mkdir dir="${basedir}/test/jar-repos"/> <jar destfile="${basedir}/test/jar-repos/jarrepo1.jar" > - <fileset dir="${basedir}/test/repositories/1" /> + <fileset dir="${basedir}/test/repositories/1"/> </jar> <jar destfile="${basedir}/test/jar-repos/jarrepo1_subdir.jar"> - <fileset dir="${basedir}/test/repositories" includes="1/**/*" /> + <fileset dir="${basedir}/test/repositories" includes="1/**/*"/> </jar> </target> - <target name="test-internal" depends="build-test, init-tests, prepare-osgi-tests, prepare-test-jar-repositories" unless="skip.test"> - <mkdir dir="${test.xml.dir}" /> + <target name="test-internal" depends="build-test,init-tests,prepare-osgi-tests,prepare-test-jar-repositories" unless="skip.test"> + <mkdir dir="${test.xml.dir}"/> <junit haltonfailure="off" @@ -455,25 +455,25 @@ dir="${basedir}" fork="true"> <classpath> - <path refid="test.classpath" /> + <path refid="test.classpath"/> <pathelement path="${ant.home}/lib/ant-nodeps.jar"/> <pathelement path="${ant.home}/lib/ant-trax.jar"/> </classpath> <!-- pass the proxy properties to the forked junit process to use correct proxy --> <syspropertyset> - <propertyref prefix="http" /> - </syspropertyset> - <jvmarg value="-Demma.coverage.out.file=${coverage.dir}/coverage.emma" /> - <jvmarg value="-Demma.coverage.out.merge=true" /> + <propertyref prefix="http"/> + </syspropertyset> + <jvmarg value="-Demma.coverage.out.file=${coverage.dir}/coverage.emma"/> + <jvmarg value="-Demma.coverage.out.merge=true"/> <!-- Added this to test IVY-65 --> - <jvmarg value="-Duser.region=TR" /> - <jvmarg value="-Duser.language=tr" /> + <jvmarg value="-Duser.region=TR"/> + <jvmarg value="-Duser.language=tr"/> <formatter type="xml"/> <batchtest todir="${test.xml.dir}"> - <fileset refid="test.fileset" /> + <fileset refid="test.fileset"/> </batchtest> </junit> </target> @@ -481,7 +481,7 @@ <target name="x" depends="init,build-test"> <java classname="org.apache.ivy.plugins.resolver.FileSystemResolverTest"> <classpath> - <path refid="test.classpath" /> + <path refid="test.classpath"/> <pathelement path="${ant.home}/lib/ant-nodeps.jar"/> <pathelement path="${ant.home}/lib/ant-trax.jar"/> </classpath> @@ -490,7 +490,7 @@ <target name="test" depends="test-internal" description="Run the test"> <fail if="test.failed" - message="At least one test has failed. See logs (in ${test.xml.dir}) for details (use the target test-report to run the test with a report)" /> + message="At least one test has failed. See logs (in ${test.xml.dir}) for details (use the target test-report to run the test with a report)"/> </target> <!-- ================================================================= @@ -499,25 +499,25 @@ <target name="test-report" depends="test-internal" unless="skip.test"> <junitreport todir="${test.xml.dir}"> <fileset dir="${test.xml.dir}"> - <include name="TEST-*.xml" /> + <include name="TEST-*.xml"/> </fileset> - <report format="frames" todir="${test.report.dir}" /> + <report format="frames" todir="${test.report.dir}"/> </junitreport> <fail if="test.failed" - message="At least one test has failed. See logs (in ${test.xml.dir}) or report (in ${test.report.dir})" /> + message="At least one test has failed. See logs (in ${test.xml.dir}) or report (in ${test.report.dir})"/> </target> - <target name="coverage-report" depends="emma, test-report" unless="skip.test" + <target name="coverage-report" depends="emma,test-report" unless="skip.test" description="run tests with instrumentation and generate coverage report"> - <mkdir dir="${coverage.report.dir}" /> + <mkdir dir="${coverage.report.dir}"/> <emma> <report sourcepath="${src.dir}"> <fileset dir="${coverage.dir}"> - <include name="*.emma" /> + <include name="*.emma"/> </fileset> - <txt outfile="${coverage.report.dir}/coverage.txt" /> - <html outfile="${coverage.report.dir}/coverage.html" /> + <txt outfile="${coverage.report.dir}/coverage.txt"/> + <html outfile="${coverage.report.dir}/coverage.html"/> </report> </emma> </target> @@ -526,45 +526,51 @@ <ivy:report todir="${ivy.report.dir}"/> </target> - <target name="javadoc" unless="skip.javadoc"> - <javadoc destdir="${javadoc.build.dir}" useexternalfile="true"> - <fileset dir="${src.dir}" includes="**/*.java" /> + <target name="javadoc" depends="init" unless="skip.javadoc"> + <tstamp> + <format pattern="2007-yyyy" property="years"/> + </tstamp> + <property name="copyright" value="Copyright &copy;${years} The Apache Software Foundation, Licensed under <a href="http://www.apache.org/licenses/LICENSE-2.0.txt">Apache License, Version 2.0</a>."/> + <property name="title" value="Apache Ivy&trade; dependency manager ${target.ivy.version} API"/> + <javadoc destdir="${javadoc.build.dir}" + useexternalfile="true" + windowtitle="Apache Ivy&trade;" + doctitle="${title}" + bottom="${copyright}" + classpathref="lib.classpath"> + <fileset dir="${src.dir}" includes="**/*.java"/> + <arg value="-tag"/> + <arg value="pre:a:Precondition:"/> </javadoc> </target> <target name="sources" depends="default-version" description="Create source archive files"> <mkdir dir="${artifacts.build.dir}/sources/"/> <jar destfile="${artifacts.build.dir}/sources/${final.name}"> - <metainf dir="${basedir}" includes="LICENSE,NOTICE" /> + <metainf dir="${basedir}" includes="LICENSE,NOTICE"/> <manifest> - <attribute name="Specification-Title" value="Apache Ivy Sources" /> - <attribute name="Specification-Version" value="${build.version}" /> - <attribute name="Specification-Vendor" value="Apache Software Foundation" /> + <attribute name="Specification-Title" value="Apache Ivy Sources"/> + <attribute name="Specification-Version" value="${build.version}"/> + <attribute name="Specification-Vendor" value="Apache Software Foundation"/> </manifest> - <fileset dir="${src.dir}" /> + <fileset dir="${src.dir}"/> </jar> </target> <target name="fixcrlf"> <property name="eol.native.includes" - value="**/*.html,**/*.json,**/*.java,**/*.xml,**/*.txt,**/*.MF,**/*.properties,**/*.patterns,**/*.pom,**/*.xsl,**/*.css" /> + value="**/*.html,**/*.json,**/*.java,**/*.xml,**/*.txt,**/*.MF,**/*.properties,**/*.patterns,**/*.pom,**/*.xsl,**/*.css"/> <property name="eol.native.excludes" - value="build/**,bin/**,lib/**" /> + value="build/**,bin/**,lib/**"/> <fileset id="eol.native.fileset" dir="${basedir}" includes="${eol.native.includes}" - excludes="${eol.native.excludes}" /> + excludes="${eol.native.excludes}"/> <fixcrlf srcdir="${basedir}" includes="${eol.native.includes}" - excludes="${eol.native.excludes}" /> - <apply executable="svn"> - <fileset refid="eol.native.fileset" /> - <arg value="propset" /> - <arg value="svn:eol-style" /> - <arg value='"native"' /> - </apply> + excludes="${eol.native.excludes}"/> </target> <!-- Checks Ivy codebase according to ${checkstyle.src.dir}/checkstyle-config --> @@ -572,35 +578,35 @@ <ivy:cachepath organisation="checkstyle" module="checkstyle" revision="5.0" inline="true" conf="default" pathid="checkstyle.classpath" transitive="true" log="download-only"/> - <taskdef resource="checkstyletask.properties" classpathref="checkstyle.classpath" /> + <taskdef resource="checkstyletask.properties" classpathref="checkstyle.classpath"/> - <mkdir dir="${checkstyle.report.dir}" /> + <mkdir dir="${checkstyle.report.dir}"/> <checkstyle config="${checkstyle.src.dir}/checkstyle-config" failOnViolation="false" failureProperty="checkstyle.failed"> <classpath> - <path refid="run.classpath" /> + <path refid="run.classpath"/> </classpath> - <formatter type="xml" toFile="${checkstyle.report.dir}/checkstyle.xml" /> + <formatter type="xml" toFile="${checkstyle.report.dir}/checkstyle.xml"/> <fileset dir="${src.dir}"> - <include name="**/*.java" /> + <include name="**/*.java"/> </fileset> <fileset dir="${example.dir}"> - <include name="**/*.java" /> + <include name="**/*.java"/> </fileset> </checkstyle> </target> <target name="checkstyle" depends="checkstyle-internal" description="checks Ivy codebase according to ${checkstyle.src.dir}/checkstyle-config"> <fail if="checkstyle.failed" - message="Checkstyle has errors. See report in ${checkstyle.report.dir}" /> + message="Checkstyle has errors. See report in ${checkstyle.report.dir}"/> </target> <target name="checkstyle-report" depends="checkstyle-internal"> - <property name="checkstyle.basedir" location="${src.dir}" /> + <property name="checkstyle.basedir" location="${src.dir}"/> <xslt in="${checkstyle.report.dir}/checkstyle.xml" style="${checkstyle.src.dir}/checkstyle-frames.xsl" out="${checkstyle.report.dir}/output.txt"> - <param name="basedir" expression="${checkstyle.basedir}" /> + <param name="basedir" expression="${checkstyle.basedir}"/> </xslt> </target> @@ -625,8 +631,7 @@ property="findbugs.home" value="${findbugs.download.to}/${findbugs.download.name}" file="${findbugs.download.to}/${findbugs.download.name}/lib/findbugs.jar" - description="Check if Findbugs is already installed." - /> + description="Check if Findbugs is already installed."/> <!-- Findbugs: Running Findbugs --> <property name="findbugs.reportdir" @@ -655,7 +660,7 @@ </path> <!-- Load the Findbugs AntTasks --> - <taskdef uri="http://findbugs.sourceforge.net/"; resource="edu/umd/cs/findbugs/anttask/tasks.properties" classpathref="findbugs.real.classpath" /> + <taskdef uri="http://findbugs.sourceforge.net/"; resource="edu/umd/cs/findbugs/anttask/tasks.properties" classpathref="findbugs.real.classpath"/> <!-- Start Findbugs --> <mkdir dir="${findbugs.reportdir}"/> @@ -665,8 +670,8 @@ outputFile="${findbugs.reportdir}/${findbugs.raw}" jvmargs="${findbugs.jvmargs}" projectName="${Name} ${project.version}"> - <class location="${core.classes.build.dir}" /> - <sourcePath path="${src.dir}" /> + <class location="${core.classes.build.dir}"/> + <sourcePath path="${src.dir}"/> </fb:findbugs> <!-- Generate (human) readable output --> @@ -680,24 +685,24 @@ <!-- ================================================================= IDE SPECIFIC ================================================================= --> - <available file="${basedir}/.classpath" property="eclipse.classpath.exists" /> + <available file="${basedir}/.classpath" property="eclipse.classpath.exists"/> <target name="check-eclipse-classpath-overwrite" if="eclipse.classpath.exists"> <input message=".classpath file already exists.${line.separator}Are you sure you want to overwrite it and loose your original file?" - validargs="Y,N,y,n" addproperty="eclipse.classpath.confirm" /> + validargs="Y,N,y,n" addproperty="eclipse.classpath.confirm"/> <condition property="eclipse.classpath.abort"> - <equals arg1="${eclipse.classpath.confirm}" arg2="N" casesensitive="false" /> + <equals arg1="${eclipse.classpath.confirm}" arg2="N" casesensitive="false"/> </condition> </target> - <target name="eclipse-default" depends="resolve, check-eclipse-classpath-overwrite" + <target name="eclipse-default" depends="resolve,check-eclipse-classpath-overwrite" unless="eclipse.classpath.abort" description="creates a default .classpath for eclipse, using jars resolved by this ant build"> - <copy file="${basedir}/.classpath.default" tofile="${basedir}/.classpath" overwrite="true" /> + <copy file="${basedir}/.classpath.default" tofile="${basedir}/.classpath" overwrite="true"/> </target> <target name="eclipse-ivyde" depends="check-eclipse-classpath-overwrite" unless="eclipse.classpath.abort" description="creates a .classpath for eclipse using Apache IvyDE version"> - <copy file="${basedir}/.classpath.ivyde" tofile="${basedir}/.classpath" overwrite="true" /> + <copy file="${basedir}/.classpath.ivyde" tofile="${basedir}/.classpath" overwrite="true"/> </target> </project> http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/Ivy.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/Ivy.java b/src/java/org/apache/ivy/Ivy.java index 1a57ce9..8876739 100644 --- a/src/java/org/apache/ivy/Ivy.java +++ b/src/java/org/apache/ivy/Ivy.java @@ -76,6 +76,7 @@ import org.apache.ivy.util.MessageLoggerEngine; * <a href="http://ant.apache.org/ivy/";>Ivy</a> is a free java based dependency manager. * <p> * This class is the main class of Ivy, which acts as a Facade to all services offered by Ivy: + * </p> * <ul> * <li>resolve dependencies</li> * <li>retrieve artifacts to a local location</li> @@ -83,22 +84,21 @@ import org.apache.ivy.util.MessageLoggerEngine; * <li>repository search and listing</li> * </ul> * Here is one typical usage: - * * <pre> * Ivy ivy = Ivy.newInstance(); * ivy.configure(new URL("ivysettings.xml")); * ivy.resolve(new URL("ivy.xml")); * </pre> - * - * </p> * <h2>Using Ivy engines directly</h2> * <p> * If the methods offered by the {@link Ivy} class are not flexible enough and you want to use Ivy * engines directly, you need to call the methods within a single {@link IvyContext} associated to - * the {@link Ivy} instance you use.<br/> + * the {@link Ivy} instance you use. + * </p> + * <p> * To do so, it is recommended to use the {@link #execute(org.apache.ivy.Ivy.IvyCallback)} method * like this: - * + * </p> * <pre> * Ivy ivy = Ivy.newInstance(); * ivy.execute(new IvyCallback() { @@ -111,19 +111,17 @@ import org.apache.ivy.util.MessageLoggerEngine; * } * }); * </pre> - * - * </p> */ public class Ivy { /** * Callback used to execute a set of Ivy related methods within an {@link IvyContext}. - * + * * @see Ivy#execute(org.apache.ivy.Ivy.IvyCallback) */ public static interface IvyCallback { /** * Executes Ivy related job within an {@link IvyContext} - * + * * @param ivy * the {@link Ivy} instance to which this callback is related * @param context @@ -171,7 +169,7 @@ public class Ivy { /** * Returns the current version of Ivy, as displayed on the console when Ivy is initialized. - * + * * @return the current version of Ivy */ public static String getIvyVersion() { @@ -180,9 +178,8 @@ public class Ivy { /** * Returns the date at which this version of Ivy has been built. - * <p> - * May be empty if unknown. - * + * <p>May be empty if unknown.</p> + * * @return the date at which this version of Ivy has been built */ public static String getIvyDate() { @@ -191,7 +188,7 @@ public class Ivy { /** * Returns the URL at which Ivy web site can be found. - * + * * @return the URL at which Ivy web site can be found */ public static String getIvyHomeURL() { @@ -218,7 +215,7 @@ public class Ivy { /** * True if this instance of Ivy has already been bound to its dependencies, false otherwise. - * + * * @see #bind() */ private boolean bound; @@ -344,7 +341,7 @@ public class Ivy { * <p> * Alternatively you can use the {@link #pushContext()} and {@link #popContext()} methods, but * this is not recommended: - * + * </p> * <pre> * Object result = null; * pushContext(); @@ -355,9 +352,7 @@ public class Ivy { * } * doSomethingWithResult(result); * </pre> - * - * </p> - * + * * @param callback IvyCallback * @return Object */ @@ -446,6 +441,9 @@ public class Ivy { /** * Configures Ivy with 1.4 compatible default settings + * + * @throws ParseException if something goes wrong + * @throws IOException if something goes wrong */ public void configureDefault14() throws ParseException, IOException { pushContext(); @@ -594,13 +592,13 @@ public class Ivy { /** * Example of use: deliver(mrid, "1.5", "target/ivy/ivy-[revision].xml", * DeliverOptions.newInstance(settings).setStatus("release").setValidate(false)); - * + * * @param mrid ModuleRevisionId * @param revision String * @param destIvyPattern String * @param options DeliverOptions - * @throws IOException - * @throws ParseException + * @throws IOException if something goes wrong + * @throws ParseException if something goes wrong */ public void deliver(ModuleRevisionId mrid, String revision, String destIvyPattern, DeliverOptions options) throws IOException, ParseException { @@ -633,6 +631,10 @@ public class Ivy { /** * Sorts the collection of IvyNode from the less dependent to the more dependent + * + * @param nodes Collection<IvyNode> + * @param options SortOptions + * @return List<IvyNode> */ public List<IvyNode> sortNodes(Collection<IvyNode> nodes, SortOptions options) { pushContext(); @@ -647,7 +649,7 @@ public class Ivy { * Sorts the given ModuleDescriptors from the less dependent to the more dependent. This sort * ensures that a ModuleDescriptor is always found in the list before all ModuleDescriptors * depending directly on it. - * + * * @param moduleDescriptors * a Collection of ModuleDescriptor to sort * @param options @@ -779,6 +781,8 @@ public class Ivy { /** * Interrupts the current running operation in the given operating thread, no later than * interruptTimeout milliseconds after the call + * + * @param operatingThread Thread */ @SuppressWarnings("deprecation") public void interrupt(Thread operatingThread) { http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/Ivy14.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/Ivy14.java b/src/java/org/apache/ivy/Ivy14.java index 0ae8b7a..28bc4ca 100644 --- a/src/java/org/apache/ivy/Ivy14.java +++ b/src/java/org/apache/ivy/Ivy14.java @@ -61,17 +61,17 @@ import org.apache.ivy.util.filter.FilterHelper; * instance of this class. * <p> * For instance, where you were doing: - * + * * <pre> * Ivy ivy = new Ivy(); * </pre> - * + * * do instead: - * + * * <pre> * Ivy14 ivy = new Ivy14(); * </pre> - * + * * And that should be enough in most cases! */ public class Ivy14 { http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/ant/AntBuildTrigger.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/ant/AntBuildTrigger.java b/src/java/org/apache/ivy/ant/AntBuildTrigger.java index 96f3813..1950333 100644 --- a/src/java/org/apache/ivy/ant/AntBuildTrigger.java +++ b/src/java/org/apache/ivy/ant/AntBuildTrigger.java @@ -38,14 +38,14 @@ import org.apache.tools.ant.taskdefs.Property; * Triggers an ant build on an event occurrence. * <p> * Example of use: - * + * </p> * <pre> - * <ant-build-trigger event="pre-resolve-dependency" + * <ant-build-trigger event="pre-resolve-dependency" * filter="revision=latest.integration" - * antfile="/path/to/[module]/build.xml" + * antfile="/path/to/[module]/build.xml" * target="compile"/> * </pre> - * + * <p> * Triggers an ant build for any dependency in asked in latest.integration, just before resolving * the dependency. * </p> @@ -53,7 +53,7 @@ import org.apache.tools.ant.taskdefs.Property; * The onlyonce property is used to tell if the ant build should be triggered only once, or several * times in the same build. * </p> - * + * * @see AntCallTrigger * @since 1.4 */ http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/ant/IvyAntSettings.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/ant/IvyAntSettings.java b/src/java/org/apache/ivy/ant/IvyAntSettings.java index 64efc9e..9f169d6 100644 --- a/src/java/org/apache/ivy/ant/IvyAntSettings.java +++ b/src/java/org/apache/ivy/ant/IvyAntSettings.java @@ -107,7 +107,7 @@ public class IvyAntSettings extends DataType { /** * Returns the default ivy settings of this classloader. If it doesn't exist yet, a new one is * created using the given project to back the VariableContainer. - * + * * @param task * TODO add text. * @return An IvySetting instance. @@ -241,7 +241,8 @@ public class IvyAntSettings extends DataType { /** * Return the configured Ivy instance. - * + * + * @param task ProjectComponent * @return Returns the configured Ivy instance. */ public Ivy getConfiguredIvyInstance(ProjectComponent task) { @@ -336,7 +337,7 @@ public class IvyAntSettings extends DataType { /** * Set file or url to its default value - * + * * @param variableContainer IvyVariableContainer */ private void defineDefaultSettingFile(IvyVariableContainer variableContainer, http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/ant/IvyBuildList.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/ant/IvyBuildList.java b/src/java/org/apache/ivy/ant/IvyBuildList.java index 55cbe74..bdc9ab9 100644 --- a/src/java/org/apache/ivy/ant/IvyBuildList.java +++ b/src/java/org/apache/ivy/ant/IvyBuildList.java @@ -352,7 +352,7 @@ public class IvyBuildList extends IvyTask { /** * Returns a collection of ModuleDescriptors that are contained in the input collection of * ModuleDescriptors and upon which the root module depends - * + * * @param mds * input collection of ModuleDescriptors * @param rootmds @@ -393,7 +393,7 @@ public class IvyBuildList extends IvyTask { * Adds the current node to the toKeep collection and then processes the each of the direct * dependencies of this node that appear in the moduleIdMap (indicating that the dependency is * part of this BuildList) - * + * * @param node * the node to be processed * @param toKeep @@ -423,7 +423,7 @@ public class IvyBuildList extends IvyTask { /** * Returns a collection of ModuleDescriptors that are contained in the input collection of * ModuleDescriptors which depends on the leaf module - * + * * @param mds * input collection of ModuleDescriptors * @param leafmds @@ -461,7 +461,7 @@ public class IvyBuildList extends IvyTask { /** * Search in the moduleIdMap modules depending on node, add them to the toKeep set and process * them recursively. - * + * * @param node * the node to be processed * @param toKeep @@ -520,6 +520,7 @@ public class IvyBuildList extends IvyTask { } /** + * @return boolean * @deprecated use {@link #getOnMissingDescriptor()} instead. */ @Deprecated @@ -528,6 +529,7 @@ public class IvyBuildList extends IvyTask { } /** + * @param skipBuildFilesWithoutIvy boolean * @deprecated use {@link #setOnMissingDescriptor(String)} instead. */ @Deprecated http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/ant/IvyPublish.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/ant/IvyPublish.java b/src/java/org/apache/ivy/ant/IvyPublish.java index 1c2921b..9795231 100644 --- a/src/java/org/apache/ivy/ant/IvyPublish.java +++ b/src/java/org/apache/ivy/ant/IvyPublish.java @@ -98,6 +98,7 @@ public class IvyPublish extends IvyTask { } /** + * @return String * @deprecated use {@link #getSrcivypattern()} instead. */ @Deprecated @@ -106,6 +107,7 @@ public class IvyPublish extends IvyTask { } /** + * @param destivypattern String * @deprecated use {@link #setSrcivypattern(String)} instead. */ @Deprecated http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/ant/IvyResolve.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/ant/IvyResolve.java b/src/java/org/apache/ivy/ant/IvyResolve.java index 5a30ab5..8e42f71 100644 --- a/src/java/org/apache/ivy/ant/IvyResolve.java +++ b/src/java/org/apache/ivy/ant/IvyResolve.java @@ -193,6 +193,7 @@ public class IvyResolve extends IvyTask { } /** + * @param failureProperty String * @deprecated Use {@link #setFailureProperty(String)} instead */ @Deprecated http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/ant/IvyRetrieve.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/ant/IvyRetrieve.java b/src/java/org/apache/ivy/ant/IvyRetrieve.java index 20695d9..c783827 100644 --- a/src/java/org/apache/ivy/ant/IvyRetrieve.java +++ b/src/java/org/apache/ivy/ant/IvyRetrieve.java @@ -159,6 +159,8 @@ public class IvyRetrieve extends IvyPostResolveTask { /** * Option to create symlinks instead of copying. + * + * @param symlink boolean */ public void setSymlink(boolean symlink) { this.symlink = symlink; @@ -166,6 +168,8 @@ public class IvyRetrieve extends IvyPostResolveTask { /** * Option to create symlinks in one mass action, instead of separately. + * + * @param symlinkmass boolean */ public void setSymlinkmass(boolean symlinkmass) { this.symlinkmass = symlinkmass; @@ -185,9 +189,9 @@ public class IvyRetrieve extends IvyPostResolveTask { /** * Add a mapper to convert the file names. - * + * * @param mapper - * a <code>Mapper</code> value. + * a Mapper value. */ public void addMapper(Mapper mapper) { if (this.mapper != null) { @@ -198,7 +202,7 @@ public class IvyRetrieve extends IvyPostResolveTask { /** * Add a nested filenamemapper. - * + * * @param fileNameMapper * the mapper to add. */ @@ -210,7 +214,7 @@ public class IvyRetrieve extends IvyPostResolveTask { /** * Returns the path of the file relative to the given base directory. - * + * * @param base * the parent directory to which the file must be evaluated. * @param file http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/ant/IvyTask.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/ant/IvyTask.java b/src/java/org/apache/ivy/ant/IvyTask.java index 42997d9..a421447 100644 --- a/src/java/org/apache/ivy/ant/IvyTask.java +++ b/src/java/org/apache/ivy/ant/IvyTask.java @@ -278,8 +278,8 @@ public abstract class IvyTask extends Task { /** * The real logic of task execution after project has been set in the context. MUST be * implemented by subclasses - * - * @throws BuildException + * + * @throws BuildException if something goes wrong */ public abstract void doExecute() throws BuildException; http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/IvyContext.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/IvyContext.java b/src/java/org/apache/ivy/core/IvyContext.java index 4ff0f3b..ab73511 100644 --- a/src/java/org/apache/ivy/core/IvyContext.java +++ b/src/java/org/apache/ivy/core/IvyContext.java @@ -36,7 +36,7 @@ import org.apache.ivy.util.MessageLogger; /** * This class represents an execution context of an Ivy action. It contains several getters to * retrieve information, like the used Ivy instance, the cache location... - * + * * @see IvyThread */ public class IvyContext { @@ -90,7 +90,7 @@ public class IvyContext { * {@link #popContext()} should usually be called when the job for which this context has been * pushed is finished. * </p> - * + * * @return the newly pushed context */ public static IvyContext pushNewContext() { @@ -104,7 +104,7 @@ public class IvyContext { * {@link #popContext()} should usually be called when the job for which this context has been * pushed is finished. * </p> - * + * * @return the newly pushed context */ public static IvyContext pushNewCopyContext() { @@ -115,7 +115,7 @@ public class IvyContext { * Changes the context associated with this thread. This is especially useful when launching a * new thread, to associate it with the same context as the initial one. Do not forget to call * {@link #popContext()} when done. - * + * * @param context * the new context to use in this thread. * @return the pushed context @@ -129,7 +129,7 @@ public class IvyContext { * Pops one context used with this thread. This is usually called after having finished a task * for which a call to {@link #pushNewContext()} or {@link #pushContext(IvyContext)} was done * prior to beginning the task. - * + * * @return the popped context */ public static IvyContext popContext() { @@ -144,7 +144,7 @@ public class IvyContext { * This methods does a similar job to {@link #peek(String)}, except that it considers the whole * context stack and not only one instance. * </p> - * + * * @param key * context key for the string * @return top object from the list (index 0) of the first context in the stack containing this @@ -172,7 +172,7 @@ public class IvyContext { * Then, or if no ivy method has been called, a default ivy instance is returned by this method, * so that it never returns <code>null</code>. * </p> - * + * * @return the current ivy instance */ public Ivy getIvy() { @@ -187,7 +187,7 @@ public class IvyContext { * If you want get a default Ivy instance in case no instance if currently associated, use * {@link #getIvy()}. * </p> - * + * * @return the current ivy instance, or <code>null</code> if there is no current ivy instance. */ public Ivy peekIvy() { @@ -233,7 +233,7 @@ public class IvyContext { /** * Reads the first object from the list saved under given key in the context. If value under key * represents non List object then a RuntimeException is thrown. - * + * * @param key * context key for the string * @return top object from the list (index 0) or null if no key or list empty @@ -259,7 +259,7 @@ public class IvyContext { /** * Removes and returns first object from the list saved under given key in the context. If value * under key represents non List object then a RuntimeException is thrown. - * + * * @param key * context key for the string * @return top object from the list (index 0) or null if no key or list empty @@ -286,9 +286,11 @@ public class IvyContext { * Removes and returns first object from the list saved under given key in the context but only * if it equals the given expectedValue - if not a false value is returned. If value under key * represents non List object then a RuntimeException is thrown. - * + * * @param key * context key for the string + * @param expectedValue + * expected value of the key * @return true if the r */ public boolean pop(String key, Object expectedValue) { @@ -318,7 +320,7 @@ public class IvyContext { * under key represents non List object then a RuntimeException is thrown. If no list exists * under given key a new LinkedList is created. This is kept without WeakReference in opposite * to the put() results. - * + * * @param key * key context key for the string * @param value http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/RelativeUrlResolver.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/RelativeUrlResolver.java b/src/java/org/apache/ivy/core/RelativeUrlResolver.java index abf6f01..701c4c5 100644 --- a/src/java/org/apache/ivy/core/RelativeUrlResolver.java +++ b/src/java/org/apache/ivy/core/RelativeUrlResolver.java @@ -28,19 +28,20 @@ public abstract class RelativeUrlResolver { /** * Resolve the url in the context of context. - * + * * @param context * The URL of the resource containing the reference url * @param url * a relative or absolution url string - * @throws MalformedURLException + * @return URL + * @throws MalformedURLException if url is wrong */ public abstract URL getURL(URL context, String url) throws MalformedURLException; /** * Resolve file or url path relatively to a context. file is considered first. If file is not * defined, url will be considered. - * + * * @param context * The URL of the resource containing the reference file or url * @param file @@ -48,7 +49,7 @@ public abstract class RelativeUrlResolver { * @param url * a relative or absolution url string * @return the resulting url or null if failed and url are null. - * @throws MalformedURLException + * @throws MalformedURLException if url is wrong */ public URL getURL(URL context, String file, String url) throws MalformedURLException { if (file != null) { http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/cache/ArtifactOrigin.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/cache/ArtifactOrigin.java b/src/java/org/apache/ivy/core/cache/ArtifactOrigin.java index 66dc5f5..7e397af 100644 --- a/src/java/org/apache/ivy/core/cache/ArtifactOrigin.java +++ b/src/java/org/apache/ivy/core/cache/ArtifactOrigin.java @@ -22,7 +22,7 @@ import org.apache.ivy.util.Checks; /** * This class contains information about the origin of an artifact. - * + * * @see org.apache.ivy.plugins.resolver.BasicResolver * @see org.apache.ivy.plugins.resolver.util.ResolvedResource */ @@ -31,6 +31,9 @@ public class ArtifactOrigin { /** * ArtifactOrigin instance used when the origin is unknown. + * + * @param artifact ditto + * @return ArtifactOrigin */ public static final ArtifactOrigin unknown(Artifact artifact) { return new ArtifactOrigin(artifact, false, UNKNOWN); @@ -58,7 +61,7 @@ public class ArtifactOrigin { /** * Create a new instance - * + * * @param artifact * the artifact pointed by this location. Must not be <code>null</code>. * @param isLocal @@ -77,7 +80,7 @@ public class ArtifactOrigin { /** * Is this resource local to this host, i.e. is it on the file system? - * + * * @return <code>boolean</code> value indicating if the resource is local. */ public boolean isLocal() { @@ -86,7 +89,7 @@ public class ArtifactOrigin { /** * Return the location of the resource (normally a url) - * + * * @return the location of the resource */ public String getLocation() { @@ -99,7 +102,7 @@ public class ArtifactOrigin { /** * Return the artifact that this location is pointing at. - * + * * @return the artifact that this location is pointing at. */ public Artifact getArtifact() { @@ -109,7 +112,7 @@ public class ArtifactOrigin { /** * The last time the resource was checked to be up to date. Maybe <code>null</code> if this * information is not actually used by in some case. - * + * * @return Long timestamp */ public Long getLastChecked() { http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/cache/DefaultRepositoryCacheManager.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/cache/DefaultRepositoryCacheManager.java b/src/java/org/apache/ivy/core/cache/DefaultRepositoryCacheManager.java index f659d87..ea01797 100644 --- a/src/java/org/apache/ivy/core/cache/DefaultRepositoryCacheManager.java +++ b/src/java/org/apache/ivy/core/cache/DefaultRepositoryCacheManager.java @@ -306,7 +306,7 @@ public class DefaultRepositoryCacheManager implements RepositoryCacheManager, Iv /** * True if this cache should check lastmodified date to know if ivy files are up to date. - * + * * @return boolean */ public boolean isCheckmodified() { @@ -324,6 +324,8 @@ public class DefaultRepositoryCacheManager implements RepositoryCacheManager, Iv /** * True if this cache should use artifacts original location when possible, false if they should * be copied to cache. + * + * @return boolean */ public boolean isUseOrigin() { if (useOrigin == null) { @@ -340,6 +342,9 @@ public class DefaultRepositoryCacheManager implements RepositoryCacheManager, Iv * Returns a File object pointing to where the artifact can be found on the local file system. * This is usually in the cache, but it can be directly in the repository if it is local and if * the resolve has been done with useOrigin = true + * + * @param artifact Artifact + * @return File */ public File getArchiveFileInCache(Artifact artifact) { ArtifactOrigin origin = getSavedArtifactOrigin(artifact); @@ -350,6 +355,10 @@ public class DefaultRepositoryCacheManager implements RepositoryCacheManager, Iv * Returns a File object pointing to where the artifact can be found on the local file system. * This is usually in the cache, but it can be directly in the repository if it is local and if * the resolve has been done with useOrigin = true + * + * @param artifact Artifact + * @param origin ArtifactOrigin + * @return File */ public File getArchiveFileInCache(Artifact artifact, ArtifactOrigin origin) { File archive = new File(getRepositoryCacheRoot(), getArchivePathInCache(artifact, origin)); @@ -368,6 +377,11 @@ public class DefaultRepositoryCacheManager implements RepositoryCacheManager, Iv * using or not the original location depending on the availability of origin information * provided as parameter and the setting of useOrigin. If useOrigin is false, this method will * always return the file in the cache. + * + * @param artifact Artifact + * @param origin ArtifactOrigin + * @param useOrigin boolean + * @return File */ private File getArchiveFileInCache(Artifact artifact, ArtifactOrigin origin, boolean useOrigin) { if (useOrigin && !ArtifactOrigin.isUnknown(origin) && origin.isLocal()) { @@ -390,7 +404,7 @@ public class DefaultRepositoryCacheManager implements RepositoryCacheManager, Iv /** * Saves the information of which resolver was used to resolve a md, so that this info can be * retrieve later (even after a jvm restart) by getSavedResolverName(ModuleDescriptor md) - * + * * @param md * the module descriptor resolved * @param name @@ -406,7 +420,7 @@ public class DefaultRepositoryCacheManager implements RepositoryCacheManager, Iv /** * Saves the information of which resolver was used to resolve a md, so that this info can be * retrieve later (even after a jvm restart) by getSavedArtResolverName(ModuleDescriptor md) - * + * * @param md * the module descriptor resolved * @param metadataResolverName @@ -573,7 +587,7 @@ public class DefaultRepositoryCacheManager implements RepositoryCacheManager, Iv /** * Creates the unique prefix key that will reference the artifact within the properties. - * + * * @param artifact * the artifact to create the unique key from. Cannot be null. * @return the unique prefix key as a string. @@ -588,7 +602,7 @@ public class DefaultRepositoryCacheManager implements RepositoryCacheManager, Iv /** * Returns the key used to identify the location of the artifact. - * + * * @param artifact * the artifact to generate the key from. Cannot be null. * @return the key to be used to reference the artifact location. @@ -600,7 +614,7 @@ public class DefaultRepositoryCacheManager implements RepositoryCacheManager, Iv /** * Returns the key used to identify if the artifact is local. - * + * * @param artifact * the artifact to generate the key from. Cannot be null. * @return the key to be used to reference the artifact locality. @@ -612,7 +626,7 @@ public class DefaultRepositoryCacheManager implements RepositoryCacheManager, Iv /** * Returns the key used to identify the last time the artifact was checked to be up to date. - * + * * @param artifact * the artifact to generate the key from. Cannot be null. * @return the key to be used to reference the artifact's last check date. @@ -624,7 +638,7 @@ public class DefaultRepositoryCacheManager implements RepositoryCacheManager, Iv /** * Returns the key used to identify the existence of the remote artifact. - * + * * @param artifact * the artifact to generate the key from. Cannot be null. * @return the key to be used to reference the existence of the artifact. @@ -636,7 +650,7 @@ public class DefaultRepositoryCacheManager implements RepositoryCacheManager, Iv /** * Returns the key used to identify the original artifact. - * + * * @param artifact * the artifact to generate the key from. Cannot be null. * @return the key to be used to reference the original artifact. @@ -786,7 +800,7 @@ public class DefaultRepositoryCacheManager implements RepositoryCacheManager, Iv /** * Choose write module descriptor parser for a given moduleDescriptor - * + * * @param moduleDescriptorFile * a given module descriptor * @return ModuleDescriptorParser @@ -1153,7 +1167,7 @@ public class DefaultRepositoryCacheManager implements RepositoryCacheManager, Iv /** * Compute a SHA1 of the resource name, encoded in base64, so we can use it as a file name. - * + * * @param resource * the resource which name will be hashed * @return the hash @@ -1169,7 +1183,7 @@ public class DefaultRepositoryCacheManager implements RepositoryCacheManager, Iv /** * Check that a cached file can be considered up to date and thus not downloaded - * + * * @param archiveFile * the file in the cache * @param resource http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/check/CheckEngine.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/check/CheckEngine.java b/src/java/org/apache/ivy/core/check/CheckEngine.java index 34d6323..8f85f4b 100644 --- a/src/java/org/apache/ivy/core/check/CheckEngine.java +++ b/src/java/org/apache/ivy/core/check/CheckEngine.java @@ -52,6 +52,10 @@ public class CheckEngine { * are available in the corresponding resolver. Note that the check is not performed * recursively, i.e. if a dependency has itself dependencies badly described or not available, * this check will not discover it. + * + * @param ivyFile URL + * @param resolvername String + * @return boolean */ public boolean check(URL ivyFile, String resolvername) { try { http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/deliver/DeliverEngine.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/deliver/DeliverEngine.java b/src/java/org/apache/ivy/core/deliver/DeliverEngine.java index 05ac1c7..11a843a 100644 --- a/src/java/org/apache/ivy/core/deliver/DeliverEngine.java +++ b/src/java/org/apache/ivy/core/deliver/DeliverEngine.java @@ -53,13 +53,15 @@ public class DeliverEngine { * Delivers a resolved ivy file based upon last resolve call status. If resolve report file * cannot be found in cache, then it throws an IllegalStateException (maybe resolve has not been * called before ?). - * + * * @param revision * the revision to which the module should be delivered * @param destIvyPattern * the pattern to which the delivered ivy file should be written * @param options * the options with which deliver should be done + * @throws IOException if something goes wrong + * @throws ParseException if something goes wrong */ public void deliver(String revision, String destIvyPattern, DeliverOptions options) throws IOException, ParseException { @@ -86,7 +88,7 @@ public class DeliverEngine { * Delivers a resolved ivy file based upon last resolve call status. If resolve report file * cannot be found in cache, then it throws an IllegalStateException (maybe resolve has not been * called before ?). - * + * * @param mrid * the module revision id of the module to deliver * @param revision @@ -95,6 +97,8 @@ public class DeliverEngine { * the pattern to which the delivered ivy file should be written * @param options * the options with which deliver should be done + * @throws IOException if something goes wrong + * @throws ParseException if something goes wrong */ public void deliver(ModuleRevisionId mrid, String revision, String destIvyPattern, DeliverOptions options) throws IOException, ParseException { http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/deliver/DeliverOptions.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/deliver/DeliverOptions.java b/src/java/org/apache/ivy/core/deliver/DeliverOptions.java index 6577b7a..05b70d5 100644 --- a/src/java/org/apache/ivy/core/deliver/DeliverOptions.java +++ b/src/java/org/apache/ivy/core/deliver/DeliverOptions.java @@ -55,7 +55,7 @@ public class DeliverOptions { /** * Returns an instance of DeliverOptions with options corresponding to default values taken from * the given settings. - * + * * @param settings * The settings to use to get default option values * @return a DeliverOptions instance ready to be used or customized @@ -74,6 +74,12 @@ public class DeliverOptions { /** * Creates an instance of DeliverOptions with all options explicitly set. + * @param status String + * @param pubDate Date + * @param pdrResolver PublishingDependencyRevisionResolver + * @param validate boolean + * @param resolveDynamicRevisions boolean + * @param confs String[] */ public DeliverOptions(String status, Date pubDate, PublishingDependencyRevisionResolver pdrResolver, boolean validate, @@ -93,7 +99,7 @@ public class DeliverOptions { * PublishingDependencyRevisionResolver can then do the delivering work for the dependency and * return the new (delivered) dependency info (with the delivered revision). Note that * PublishingDependencyRevisionResolver is only called for each <b>direct</b> dependency. - * + * * @return the pdrResolver that will be used during deliver */ public PublishingDependencyRevisionResolver getPdrResolver() { @@ -107,7 +113,8 @@ public class DeliverOptions { * PublishingDependencyRevisionResolver can then do the delivering work for the dependency and * return the new (delivered) dependency info (with the delivered revision). Note that * PublishingDependencyRevisionResolver is only called for each <b>direct</b> dependency. - * + * + * @param pdrResolver PublishingDependencyRevisionResolver * @return the instance of DeliverOptions on which the method has been called, for easy method * chaining */ @@ -155,7 +162,7 @@ public class DeliverOptions { /** * Returns the status to which the module should be delivered, or null if the current status * should be kept. - * + * * @return the status to which the module should be delivered */ public String getStatus() { @@ -165,7 +172,8 @@ public class DeliverOptions { /** * Sets the status to which the module should be delivered, use null if the current status * should be kept. - * + * + * @param status String * @return the instance of DeliverOptions on which the method has been called, for easy method * chaining */ @@ -176,7 +184,7 @@ public class DeliverOptions { /** * Returns the id of a previous resolve to use for delivering. - * + * * @return the id of a previous resolve */ public String getResolveId() { @@ -185,7 +193,7 @@ public class DeliverOptions { /** * Sets the id of a previous resolve to use for delivering. - * + * * @param resolveId * the id of a previous resolve * @return the instance of DeliverOptions on which the method has been called, for easy method @@ -199,7 +207,7 @@ public class DeliverOptions { /** * Return the configurations which must be delivered. Returns <tt>null</tt> if all configurations * has to be delivered. Attention: the returned array can contain wildcards! - * + * * @return the configurations to deliver */ public String[] getConfs() { @@ -208,7 +216,7 @@ public class DeliverOptions { /** * Sets the configurations to deliver. - * + * * @param confs * the configurations to deliver * @return the instance of DeliverOptions on which the method has been called, for easy method @@ -222,7 +230,7 @@ public class DeliverOptions { /** * Returns the branch with which the Ivy file should be delivered, or <code>null</code> if * branch info shouldn't be changed. - * + * * @return the branch with which the Ivy file should be delivered */ public String getPubBranch() { @@ -231,7 +239,7 @@ public class DeliverOptions { /** * Sets the branch with which the Ivy file should be delivered. - * + * * @param pubBranch * the branch with which the Ivy file should be delivered * @return the instance of DeliverOptions on which the method has been called, for easy method @@ -264,7 +272,6 @@ public class DeliverOptions { return "status=" + status + " pubdate=" + pubdate + " validate=" + validate + " resolveDynamicRevisions=" + resolveDynamicRevisions + " merge=" + merge + " resolveId=" + resolveId + " pubBranch=" + pubBranch; - } } http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/baf03a91/src/java/org/apache/ivy/core/event/IvyEvent.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/ivy/core/event/IvyEvent.java b/src/java/org/apache/ivy/core/event/IvyEvent.java index 18697a0..02ab78e 100644 --- a/src/java/org/apache/ivy/core/event/IvyEvent.java +++ b/src/java/org/apache/ivy/core/event/IvyEvent.java @@ -27,15 +27,19 @@ import org.apache.ivy.core.module.id.ModuleRevisionId; import org.apache.ivy.util.StringUtils; /** + * <p> * The root of all ivy events Any ivy event knows which ivy instance triggered the event (the * source) and also has a name and a map of attributes. The name of the event represents the event * type, usually there is a one - one mapping between event names and IvyEvent subclass, even if - * this is not mandatory. Example: pre-resolve pre-resolve-dependency post-download The map of - * attributes is a Map from String keys to String values. It is especially useful to filter events, - * and to get some of their essential data in some context where access to Java types is not easy - * (in an ant build file, for example), Example: pre-resolve (organisation=foo, module=bar, - * revision=1.0, conf=default) post-download (organisation=foo, module=bar, revision=1.0, - * artifact=foo-test, type=jar, ext=jar) + * this is not mandatory. Example: <code>pre-resolve pre-resolve-dependency post-download</code> + * </p> + * <p> + * The map of attributes is a Map from String keys to String values. It is especially useful to + * filter events, and to get some of their essential data in some context where access to Java types + * is not easy (in an Ant build file, for example), Example: <code>pre-resolve (organisation=foo, + * module=bar, revision=1.0, conf=default) post-download (organisation=foo, module=bar, + * revision=1.0, artifact=foo-test, type=jar, ext=jar)</code> + * </p> */ public class IvyEvent { private EventManager source; @@ -51,7 +55,7 @@ public class IvyEvent { /** * Should only be called during event object construction, since events should be immutable - * + * * @param key ditto * @param value ditto */ @@ -93,9 +97,9 @@ public class IvyEvent { } /** - * Returns the attributes of this event, as a Map(String->String) - * - * @return the attributes of this event, as a Map(String->String) + * Returns the attributes of this event, as a Map(String,String) + * + * @return the attributes of this event, as a Map(String,String) */ public Map getAttributes() { return new HashMap(attributes);
