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 2011/12/28 13:48:38 UTC

git commit: DELTASPIKE-21 add JavaDoc info about how to register custom ProjectStageHoldes

Updated Branches:
  refs/heads/master f8fe2fac7 -> 70d3cf1ed


DELTASPIKE-21 add JavaDoc info about how to register custom ProjectStageHoldes


Project: http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/commit/70d3cf1e
Tree: http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/tree/70d3cf1e
Diff: http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/diff/70d3cf1e

Branch: refs/heads/master
Commit: 70d3cf1ed00ee4a72ee6829ceabb777d2de0903a
Parents: f8fe2fa
Author: Mark Struberg <st...@apache.org>
Authored: Wed Dec 28 13:46:39 2011 +0100
Committer: Mark Struberg <st...@apache.org>
Committed: Wed Dec 28 13:46:39 2011 +0100

----------------------------------------------------------------------
 .../core/api/projectstage/ProjectStageHolder.java  |   12 ++++++++++--
 .../test/api/projectstage/TestProjectStages.java   |    6 ++++++
 2 files changed, 16 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/70d3cf1e/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/projectstage/ProjectStageHolder.java
----------------------------------------------------------------------
diff --git a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/projectstage/ProjectStageHolder.java b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/projectstage/ProjectStageHolder.java
index 9435acf..4510d6b 100644
--- a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/projectstage/ProjectStageHolder.java
+++ b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/api/projectstage/ProjectStageHolder.java
@@ -19,9 +19,17 @@
 package org.apache.deltaspike.core.api.projectstage;
 
 /**
- * This is a marker interface for custom project
+ * <p>This is a marker interface for custom project
  * stage holders. A project stage holder is a class which
- * contains 1 or many {@link ProjectStage}s.
+ * contains 1 or many {@link ProjectStage}s.</p>
+ *
+ * <p>Any custom ProjectStageHolder must get registered via the
+ * {@link java.util.ServiceLoader} mechanism. Simply create a file
+ * <pre>
+ *     META-INF/services/org.apache.deltaspike.core.api.projectstage.ProjectStageHolder
+ * </pre>
+ * and write the fully qualified class name of your ProjectStageHolder into it.
+ * </p>
  */
 public interface ProjectStageHolder 
 {

http://git-wip-us.apache.org/repos/asf/incubator-deltaspike/blob/70d3cf1e/deltaspike/core/impl/src/test/java/org/apache/deltaspike/core/test/api/projectstage/TestProjectStages.java
----------------------------------------------------------------------
diff --git a/deltaspike/core/impl/src/test/java/org/apache/deltaspike/core/test/api/projectstage/TestProjectStages.java b/deltaspike/core/impl/src/test/java/org/apache/deltaspike/core/test/api/projectstage/TestProjectStages.java
index 4c0327c..8d7d743 100644
--- a/deltaspike/core/impl/src/test/java/org/apache/deltaspike/core/test/api/projectstage/TestProjectStages.java
+++ b/deltaspike/core/impl/src/test/java/org/apache/deltaspike/core/test/api/projectstage/TestProjectStages.java
@@ -23,6 +23,12 @@ import org.apache.deltaspike.core.api.projectstage.ProjectStage;
 import org.apache.deltaspike.core.api.projectstage.ProjectStageHolder;
 
 /**
+ * This is a test ProjectStage. It demonstrates how to add custom ProjectStages.
+ * This TestProjectStage must get registered via the {@link java.util.ServiceLoader}
+ * mechanism. Please see the file
+ * <pre>
+ *     META-INF/services/org.apache.deltaspike.core.api.projectstage.ProjectStageHolder
+ * </pre>
  */
 public class TestProjectStages implements ProjectStageHolder
 {