Repository: deltaspike Updated Branches: refs/heads/master f92fcf3dc -> 16ea5af24
DELTASPIKE-811 - Little improvment on Project Stage documentation Project: http://git-wip-us.apache.org/repos/asf/deltaspike/repo Commit: http://git-wip-us.apache.org/repos/asf/deltaspike/commit/fe4dd3ac Tree: http://git-wip-us.apache.org/repos/asf/deltaspike/tree/fe4dd3ac Diff: http://git-wip-us.apache.org/repos/asf/deltaspike/diff/fe4dd3ac Branch: refs/heads/master Commit: fe4dd3ac4094a895b3b1403449fa9e4a24e92059 Parents: f92fcf3 Author: Rafael Benevides <[email protected]> Authored: Tue Feb 3 15:57:00 2015 -0500 Committer: Rafael Benevides <[email protected]> Committed: Tue Feb 3 15:57:00 2015 -0500 ---------------------------------------------------------------------- documentation/src/main/asciidoc/core.adoc | 6 ++-- .../src/main/asciidoc/projectstage.adoc | 29 ++++++++++---------- 2 files changed, 18 insertions(+), 17 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/deltaspike/blob/fe4dd3ac/documentation/src/main/asciidoc/core.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/core.adoc b/documentation/src/main/asciidoc/core.adoc index e9816e4..950dcae 100644 --- a/documentation/src/main/asciidoc/core.adoc +++ b/documentation/src/main/asciidoc/core.adoc @@ -155,9 +155,9 @@ the lookup strategy you used before, you can deactivate the delegation to the co ==== Type-safe ProjectStage -The DeltaSpike <<projectstage.adoc#,ProjectStage>> mechanism allows to -use configuration and implementations depending on the server -environment you currently run on. +The DeltaSpike <<projectstage.adoc#,ProjectStage>> mechanism allows to use configuration and implementations depending on the server environment you currently run on. + +DeltaSpike provides some pre-defined <<projectstage.adoc#_introduction,ProjectStages>> but it's also possible to create your own <<projectstage.adoc#_custom_project_stages,Custom Project Stage>>, Please, check the <<projectstage.adoc#,DeltaSpike ProjectStage>> page for more details. ==== @Exclude http://git-wip-us.apache.org/repos/asf/deltaspike/blob/fe4dd3ac/documentation/src/main/asciidoc/projectstage.adoc ---------------------------------------------------------------------- diff --git a/documentation/src/main/asciidoc/projectstage.adoc b/documentation/src/main/asciidoc/projectstage.adoc index 3045d85..2ab9b1a 100644 --- a/documentation/src/main/asciidoc/projectstage.adoc +++ b/documentation/src/main/asciidoc/projectstage.adoc @@ -42,7 +42,7 @@ boolean isDevProjectStage = ProjectStage.Development.equals(this.projectStage); ------------------------------------------------------------------------------- -=== Custom Project Stages +== Custom Project Stages It is possible to provide custom project stage implementations. Therefore, you have to provide an implementation of the @@ -69,7 +69,8 @@ public class CustomProjectStageHolder implements ProjectStageHolder Configure your custom `ProjectStageHolder` in `META-INF/services/org.apache.deltaspike.core.api.projectstage.ProjectStageHolder`. -The file has to provide the _fully qualified_ class name of the custom + +NOTE: The file has to provide the _fully qualified_ class name of the custom implementation of the `ProjectStageHolder` interface. Usage of a custom project stage: @@ -85,7 +86,18 @@ customProjectStage = CustomProjectStageHolder.CustomProjectStage; ---------------------------------------------------------------------------- -=== ProjectStageProducer (for Third-party Portable Extensions) +== Setting the active ProjectStage + +For setting the ProjectStage which shall get used in your application +you can specify it in a few ways. The underlying mechanism used to +determine the string is the ConfigResolver. + +.Example +------------------------------------------------ +-Dorg.apache.deltaspike.ProjectStage=Development +------------------------------------------------ + +== ProjectStageProducer (for Third-party Portable Extensions) `ProjectStageProducer` provides the producer method which allows to inject the current ProjectStage. However, in some cases it is needed to @@ -96,14 +108,3 @@ current ProjectStage. This helper also contains helpers for unit-tests - e.g. `#setProjectStage`. However, those methods shouldis not be needed for users (we just need them for testing different ProjectStage scenarios). - -==== Setting the Active ProjectStage - -For setting the ProjectStage which shall get used in your application -you can specify it in a few ways. The underlying mechanism used to -determine the string is the ConfigResolver. - -.Example ------------------------------------------------- --Dorg.apache.deltaspike.ProjectStage=Development -------------------------------------------------
