You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ss...@apache.org on 2014/10/21 17:32:35 UTC
svn commit: r1633399 - in /sling/trunk/bundles/extensions/models:
api/src/main/java/org/apache/sling/models/annotations/injectorspecific/SlingObject.java
impl/src/main/java/org/apache/sling/models/impl/injectors/SlingObjectInjector.java
Author: sseifert
Date: Tue Oct 21 15:32:35 2014
New Revision: 1633399
URL: http://svn.apache.org/r1633399
Log:
move detailed JavaDoc description of SlingObject injector support to annotation, because this is what's usually only included as dependency in the projects
Modified:
sling/trunk/bundles/extensions/models/api/src/main/java/org/apache/sling/models/annotations/injectorspecific/SlingObject.java
sling/trunk/bundles/extensions/models/impl/src/main/java/org/apache/sling/models/impl/injectors/SlingObjectInjector.java
Modified: sling/trunk/bundles/extensions/models/api/src/main/java/org/apache/sling/models/annotations/injectorspecific/SlingObject.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/models/api/src/main/java/org/apache/sling/models/annotations/injectorspecific/SlingObject.java?rev=1633399&r1=1633398&r2=1633399&view=diff
==============================================================================
--- sling/trunk/bundles/extensions/models/api/src/main/java/org/apache/sling/models/annotations/injectorspecific/SlingObject.java (original)
+++ sling/trunk/bundles/extensions/models/api/src/main/java/org/apache/sling/models/annotations/injectorspecific/SlingObject.java Tue Oct 21 15:32:35 2014
@@ -28,8 +28,55 @@ import org.apache.sling.models.annotatio
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)
Modified: sling/trunk/bundles/extensions/models/impl/src/main/java/org/apache/sling/models/impl/injectors/SlingObjectInjector.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/models/impl/src/main/java/org/apache/sling/models/impl/injectors/SlingObjectInjector.java?rev=1633399&r1=1633398&r2=1633399&view=diff
==============================================================================
--- sling/trunk/bundles/extensions/models/impl/src/main/java/org/apache/sling/models/impl/injectors/SlingObjectInjector.java (original)
+++ sling/trunk/bundles/extensions/models/impl/src/main/java/org/apache/sling/models/impl/injectors/SlingObjectInjector.java Tue Oct 21 15:32:35 2014
@@ -43,53 +43,7 @@ import org.osgi.framework.Constants;
/**
* 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>
+ * Documentation see {@link SlingObject}.
*/
@Component
@Service