You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@deltaspike.apache.org by st...@apache.org on 2012/06/12 19:02:24 UTC
git commit: improve JavaDoc for CdiContainerLoader
Updated Branches:
refs/heads/master a0336670e -> 6d7f4c936
improve JavaDoc for CdiContainerLoader
Project: http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/commit/6d7f4c93
Tree: http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/tree/6d7f4c93
Diff: http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/diff/6d7f4c93
Branch: refs/heads/master
Commit: 6d7f4c93634c49da917ad9c75e1622eaba3dcc79
Parents: a033667
Author: Mark Struberg <st...@apache.org>
Authored: Tue Jun 12 19:01:50 2012 +0200
Committer: Mark Struberg <st...@apache.org>
Committed: Tue Jun 12 19:01:50 2012 +0200
----------------------------------------------------------------------
.../deltaspike/cdise/api/CdiContainerLoader.java | 17 ++++++++++++++-
1 files changed, 16 insertions(+), 1 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/6d7f4c93/deltaspike/cdictrl/api/src/main/java/org/apache/deltaspike/cdise/api/CdiContainerLoader.java
----------------------------------------------------------------------
diff --git a/deltaspike/cdictrl/api/src/main/java/org/apache/deltaspike/cdise/api/CdiContainerLoader.java b/deltaspike/cdictrl/api/src/main/java/org/apache/deltaspike/cdise/api/CdiContainerLoader.java
index 743a1a1..8a2962a 100644
--- a/deltaspike/cdictrl/api/src/main/java/org/apache/deltaspike/cdise/api/CdiContainerLoader.java
+++ b/deltaspike/cdictrl/api/src/main/java/org/apache/deltaspike/cdise/api/CdiContainerLoader.java
@@ -25,6 +25,16 @@ import java.util.ServiceLoader;
* <p>This class provides access to the ContainerControl.</p>
* <p>It uses the {@code java.util.ServiceLoader} mechanism to
* automatically pickup the container providers from the classpath.</p>
+ * <p>Usage:
+ * <pre>
+ * CdiContainer container = CdiContainerLoader.getCdiContainer();
+ * container.boot();
+ * ...
+ * </pre>
+ * </p>
+ * <p>CdiContainerLoader internally uses the {@link java.util.ServiceLoader}
+ * to automatically detect the container implementation which should be used.
+ * </p>
*/
public final class CdiContainerLoader
{
@@ -33,7 +43,12 @@ public final class CdiContainerLoader
// private ct to prevent instantiation
}
-
+
+ /**
+ * @return the {@link CdiContainer} implementation available on the classpath
+ * @throws IllegalStateException if none or multiple CdiContainer implementations
+ * are found on the classpath.
+ */
public static CdiContainer getCdiContainer()
{
CdiContainer testContainer;