Repository: maven Updated Branches: refs/heads/master 347ec7b6e -> b0eb12b66
[MNG-5713] improved Toolchains API description Project: http://git-wip-us.apache.org/repos/asf/maven/repo Commit: http://git-wip-us.apache.org/repos/asf/maven/commit/b0eb12b6 Tree: http://git-wip-us.apache.org/repos/asf/maven/tree/b0eb12b6 Diff: http://git-wip-us.apache.org/repos/asf/maven/diff/b0eb12b6 Branch: refs/heads/master Commit: b0eb12b662eddefc72cc4904d51a7f514de77e8d Parents: 347ec7b Author: Hervé Boutemy <hbout...@apache.org> Authored: Fri Oct 31 16:51:23 2014 +0100 Committer: Hervé Boutemy <hbout...@apache.org> Committed: Fri Oct 31 16:51:23 2014 +0100 ---------------------------------------------------------------------- .../apache/maven/toolchain/DefaultToolchain.java | 1 + .../org/apache/maven/toolchain/Toolchain.java | 1 + .../apache/maven/toolchain/ToolchainFactory.java | 1 + .../apache/maven/toolchain/ToolchainManager.java | 1 + .../maven/toolchain/ToolchainManagerPrivate.java | 8 +++++++- .../toolchain/java/DefaultJavaToolChain.java | 1 + .../java/DefaultJavaToolchainFactory.java | 1 + .../maven/toolchain/java/JavaToolChain.java | 1 + maven-core/src/site/apt/index.apt | 19 ++++++++++++++++--- 9 files changed, 30 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/maven/blob/b0eb12b6/maven-core/src/main/java/org/apache/maven/toolchain/DefaultToolchain.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/toolchain/DefaultToolchain.java b/maven-core/src/main/java/org/apache/maven/toolchain/DefaultToolchain.java index 74f6e4a..11ad722 100644 --- a/maven-core/src/main/java/org/apache/maven/toolchain/DefaultToolchain.java +++ b/maven-core/src/main/java/org/apache/maven/toolchain/DefaultToolchain.java @@ -28,6 +28,7 @@ import org.codehaus.plexus.logging.Logger; /** * * @author mkleint + * @since 2.0.9 */ public abstract class DefaultToolchain implements Toolchain, ToolchainPrivate http://git-wip-us.apache.org/repos/asf/maven/blob/b0eb12b6/maven-core/src/main/java/org/apache/maven/toolchain/Toolchain.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/toolchain/Toolchain.java b/maven-core/src/main/java/org/apache/maven/toolchain/Toolchain.java index adcae3a..5e99b0a 100644 --- a/maven-core/src/main/java/org/apache/maven/toolchain/Toolchain.java +++ b/maven-core/src/main/java/org/apache/maven/toolchain/Toolchain.java @@ -22,6 +22,7 @@ package org.apache.maven.toolchain; /** * @author Milos Kleint * @author Jason van Zyl + * @since 2.0.9 */ public interface Toolchain { http://git-wip-us.apache.org/repos/asf/maven/blob/b0eb12b6/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainFactory.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainFactory.java b/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainFactory.java index 3436883..a187f96 100644 --- a/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainFactory.java +++ b/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainFactory.java @@ -24,6 +24,7 @@ import org.apache.maven.toolchain.model.ToolchainModel; /** * * @author mkleint + * @since 2.0.9 */ public interface ToolchainFactory { http://git-wip-us.apache.org/repos/asf/maven/blob/b0eb12b6/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainManager.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainManager.java b/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainManager.java index 1265e5e..6b8acf5 100644 --- a/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainManager.java +++ b/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainManager.java @@ -25,6 +25,7 @@ import org.apache.maven.execution.MavenSession; /** * * @author mkleint + * @since 2.0.9 */ public interface ToolchainManager { http://git-wip-us.apache.org/repos/asf/maven/blob/b0eb12b6/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainManagerPrivate.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainManagerPrivate.java b/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainManagerPrivate.java index 81f54a1..a877772 100644 --- a/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainManagerPrivate.java +++ b/maven-core/src/main/java/org/apache/maven/toolchain/ToolchainManagerPrivate.java @@ -23,20 +23,26 @@ import org.apache.maven.execution.MavenSession; /** - * Component for use by the maven-toolchains-plugin only. + * Component for use by the <code>maven-toolchains-plugin</code> only. + * * @author mkleint + * @since 2.0.9 */ public interface ToolchainManagerPrivate { /** * Retrieves the toolchains of given type from the user settings. + * + * @since 3.0 (addition of the <code>MavenSession</code> parameter) */ ToolchainPrivate[] getToolchainsForType( String type, MavenSession context ) throws MisconfiguredToolchainException; /** * Stores the toolchain into build context. + * + * @since 2.0.9 */ void storeToolchainToBuildContext( ToolchainPrivate toolchain, MavenSession context ); http://git-wip-us.apache.org/repos/asf/maven/blob/b0eb12b6/maven-core/src/main/java/org/apache/maven/toolchain/java/DefaultJavaToolChain.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/toolchain/java/DefaultJavaToolChain.java b/maven-core/src/main/java/org/apache/maven/toolchain/java/DefaultJavaToolChain.java index 200caff..9dc92f8 100644 --- a/maven-core/src/main/java/org/apache/maven/toolchain/java/DefaultJavaToolChain.java +++ b/maven-core/src/main/java/org/apache/maven/toolchain/java/DefaultJavaToolChain.java @@ -30,6 +30,7 @@ import org.codehaus.plexus.util.Os; /** * @author Milos Kleint + * @since 2.0.9 */ @Component( role = JavaToolChain.class ) public class DefaultJavaToolChain http://git-wip-us.apache.org/repos/asf/maven/blob/b0eb12b6/maven-core/src/main/java/org/apache/maven/toolchain/java/DefaultJavaToolchainFactory.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/toolchain/java/DefaultJavaToolchainFactory.java b/maven-core/src/main/java/org/apache/maven/toolchain/java/DefaultJavaToolchainFactory.java index 6a8e7f6..aec72d0 100644 --- a/maven-core/src/main/java/org/apache/maven/toolchain/java/DefaultJavaToolchainFactory.java +++ b/maven-core/src/main/java/org/apache/maven/toolchain/java/DefaultJavaToolchainFactory.java @@ -35,6 +35,7 @@ import org.codehaus.plexus.util.xml.Xpp3Dom; /** * * @author mkleint + * @since 2.0.9 */ @Component( role = ToolchainFactory.class, hint = "jdk" ) public class DefaultJavaToolchainFactory http://git-wip-us.apache.org/repos/asf/maven/blob/b0eb12b6/maven-core/src/main/java/org/apache/maven/toolchain/java/JavaToolChain.java ---------------------------------------------------------------------- diff --git a/maven-core/src/main/java/org/apache/maven/toolchain/java/JavaToolChain.java b/maven-core/src/main/java/org/apache/maven/toolchain/java/JavaToolChain.java index 80c7509..a9c5bbf 100644 --- a/maven-core/src/main/java/org/apache/maven/toolchain/java/JavaToolChain.java +++ b/maven-core/src/main/java/org/apache/maven/toolchain/java/JavaToolChain.java @@ -24,6 +24,7 @@ import org.apache.maven.toolchain.Toolchain; /** * @author Jason van Zyl * @author Milos Kleint + * @since 2.0.9 */ public interface JavaToolChain extends Toolchain http://git-wip-us.apache.org/repos/asf/maven/blob/b0eb12b6/maven-core/src/site/apt/index.apt ---------------------------------------------------------------------- diff --git a/maven-core/src/site/apt/index.apt b/maven-core/src/site/apt/index.apt index f66e577..40eca84 100644 --- a/maven-core/src/site/apt/index.apt +++ b/maven-core/src/site/apt/index.apt @@ -33,8 +33,6 @@ Maven Core * {{{./artifact-handlers.html}default artifact handlers}}, - * {{{./toolchains.html}Toolchains descriptor reference}}, - * <<<Maven>>> component ({{{./apidocs/org/apache/maven/Maven.html}javadoc}}), with its <<<DefaultMaven>>> implementation ({{{./xref/org/apache/maven/DefaultMaven.html}source}}), @@ -58,4 +56,19 @@ Maven Core * <<<ExceptionHandler>>> component ({{{./apidocs/org/apache/maven/exception/ExceptionHandler.html}javadoc}}), with its <<<DefaultExceptionHandler>>> implementation ({{{./xref/org/apache/maven/exception/DefaultExceptionHandler.html}source}}), use to transform exception into useful end-user messages. - \ No newline at end of file + +* Toolchains + + * {{{./toolchains.html}Toolchains descriptor reference}}, + + * <<<ToolchainManager>>> component ({{{./apidocs/org/apache/maven/toolchain/ToolchainManager.html}javadoc}})) + with its <<<DefaultToolchainManager>>> implementation ({{{./xref/org/apache/maven/toolchain/DefaultToolchainManager.html}source}}), + to get selected <<<Toolchain>>> ({{{./apidocs/org/apache/maven/toolchain/Toolchain.html}javadoc}}) instance, + + * internal <<<ToolchainManagerPrivate>>> component ({{{./apidocs/org/apache/maven/toolchain/ToolchainManagerPrivate.html}javadoc}})) + with its <<<DefaultToolchainManagerPrivate>>> implementation ({{{./xref/org/apache/maven/toolchain/DefaultToolchainManagerPrivate.html}source}}), + to manage toolchain selection, + + * <<<JavaToolchain>>> component ({{{./apidocs/org/apache/maven/toolchain/java/JavaToolchain.html}javadoc}}), + with its <<<DefaultJavaToolchain>>> implementation + ({{{./xref/org/apache/maven/toolchain/java/DefaultJavaToolchain.html}source}}).
