[sling-org-apache-sling-models-api] 10/34: move detailed JavaDoc description of SlingObject injector support to annotation, because this is what's usually only included as dependency in the projects

[ro...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

rombert pushed a commit to annotated tag org.apache.sling.models.api-1.2.0
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-models-api.git

commit 727a0e8ade179845b6165f3e4ff3e0009ba55aa1
Author: Stefan Seifert <ss...@apache.org>
AuthorDate: Tue Oct 21 15:32:35 2014 +0000

    move detailed JavaDoc description of SlingObject injector support to annotation, because this is what's usually only included as dependency in the projects
    
    git-svn-id: https://svn.apache.org/repos/asf/sling/trunk/bundles/extensions/models/api@1633399 13f79535-47bb-0310-9956-ffa450edef68
---
 .../annotations/injectorspecific/SlingObject.java  | 51 +++++++++++++++++++++-
 1 file changed, 49 insertions(+), 2 deletions(-)

diff --git a/src/main/java/org/apache/sling/models/annotations/injectorspecific/SlingObject.java b/src/main/java/org/apache/sling/models/annotations/injectorspecific/SlingObject.java
index 40e0968..07a7c7c 100644
--- a/src/main/java/org/apache/sling/models/annotations/injectorspecific/SlingObject.java
+++ b/src/main/java/org/apache/sling/models/annotations/injectorspecific/SlingObject.java
@@ -28,8 +28,55 @@ import org.apache.sling.models.annotations.Source;
 import org.apache.sling.models.spi.injectorspecific.InjectAnnotation;
 
 /**
- * Annotation to be used on either methods, fields or constructor parameters to let Sling Models inject a
- * Sling-related context object.
+ * Injects common Sling objects that can be derived from either a SlingHttpServletRequest, a ResourceResolver or a
+ * Resource.
+ * The injection is class-based.
+ * <p>
+ * Supports the following objects:
+ * <table>
+ * <tr>
+ * <th style="text-align:left">Class</th>
+ * <th style="text-align:left">Description</th>
+ * <th style="text-align:center">Request</th>
+ * <th style="text-align:center">ResourceResolver</th>
+ * <th style="text-align:center">Resource</th>
+ * </tr>
+ * <tr style="background-color:#eee">
+ * <td>{@link ResourceResolver}</td>
+ * <td>Resource resolver</td>
+ * <td style="text-align:center">X</td>
+ * <td style="text-align:center">X</td>
+ * <td style="text-align:center">X</td>
+ * </tr>
+ * <tr>
+ * <td>{@link Resource}</td>
+ * <td>Resource</td>
+ * <td style="text-align:center">X</td>
+ * <td></td>
+ * <td style="text-align:center">X</td>
+ * </tr>
+ * <tr style="background-color:#eee">
+ * <td>{@link SlingHttpServletRequest}</td>
+ * <td>Sling request</td>
+ * <td style="text-align:center">X</td>
+ * <td></td>
+ * <td></td>
+ * </tr>
+ * <tr>
+ * <td>{@link SlingHttpServletResponse}</td>
+ * <td>Sling response</td>
+ * <td style="text-align:center">X</td>
+ * <td></td>
+ * <td></td>
+ * </tr>
+ * <tr style="background-color:#eee">
+ * <td>{@link SlingScriptHelper}</td>
+ * <td>Sling script helper</td>
+ * <td style="text-align:center">X</td>
+ * <td></td>
+ * <td></td>
+ * </tr>
+ * </table>
  */
 @Target({ METHOD, FIELD, PARAMETER })
 @Retention(RUNTIME)

-- 
To stop receiving notification emails like this one, please contact
"commits@sling.apache.org" <co...@sling.apache.org>.