You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@deltaspike.apache.org by gp...@apache.org on 2018/03/29 21:46:43 UTC

[7/7] deltaspike git commit: DELTASPIKE-1334 added javadoc for ConfigPreProcessor#beforeAddToConfig

DELTASPIKE-1334 added javadoc for ConfigPreProcessor#beforeAddToConfig


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

Branch: refs/heads/deltaspike-1.8.x
Commit: 1785e0ff44d3f58c64cda0b257bdf0c23d7f40b0
Parents: 45dba46
Author: gpetracek <gp...@apache.org>
Authored: Thu Mar 29 23:19:38 2018 +0200
Committer: gpetracek <gp...@apache.org>
Committed: Thu Mar 29 23:38:24 2018 +0200

----------------------------------------------------------------------
 .../core/spi/config/view/ConfigPreProcessor.java        | 12 ++++++++++++
 1 file changed, 12 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/deltaspike/blob/1785e0ff/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/spi/config/view/ConfigPreProcessor.java
----------------------------------------------------------------------
diff --git a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/spi/config/view/ConfigPreProcessor.java b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/spi/config/view/ConfigPreProcessor.java
index 1cce3a4..3d9f4b6 100644
--- a/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/spi/config/view/ConfigPreProcessor.java
+++ b/deltaspike/core/api/src/main/java/org/apache/deltaspike/core/spi/config/view/ConfigPreProcessor.java
@@ -30,5 +30,17 @@ import java.lang.annotation.Annotation;
  */
 public interface ConfigPreProcessor<T extends Annotation>
 {
+    /**
+     * @param metaData The annotation-instance which was found or the inherited instance.
+     *                 Since it's possible to override annotation-attributes alongside the inheritance-path,
+     *                 it can be a merged representation.
+     *                 To get rid of meta-data which is only inherited,
+     *                 it's required to check the presence of the physical annotation e.g. via
+     *                 ViewConfigNode#getSource#isAnnotationPresent
+     *                 and return a synthetic literal-instance (as a marker/placeholder),
+     *                 because 'null' isn't supported as return-value.
+     * @param viewConfigNode Instance which represents the current node
+     * @return The annotation-instance which should be used for the final meta-data
+     */
     T beforeAddToConfig(T metaData, ViewConfigNode viewConfigNode);
 }