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/11/06 01:32:43 UTC

svn commit: r1637018 - in /sling/trunk/testing/mocks: resourceresolver-mock/src/main/java/org/apache/sling/testing/resourceresolver/ sling-mock/src/main/java/org/apache/sling/testing/mock/sling/context/ sling-mock/src/main/java/org/apache/sling/testing...

Author: sseifert
Date: Thu Nov  6 00:32:42 2014
New Revision: 1637018

URL: http://svn.apache.org/r1637018
Log:
fix some javadoc errors and warnings

Modified:
    sling/trunk/testing/mocks/resourceresolver-mock/src/main/java/org/apache/sling/testing/resourceresolver/MockResourceResolverFactory.java
    sling/trunk/testing/mocks/resourceresolver-mock/src/main/java/org/apache/sling/testing/resourceresolver/MockValueMap.java
    sling/trunk/testing/mocks/sling-mock/src/main/java/org/apache/sling/testing/mock/sling/context/SlingContextImpl.java
    sling/trunk/testing/mocks/sling-mock/src/main/java/org/apache/sling/testing/mock/sling/junit/SlingContext.java
    sling/trunk/testing/mocks/sling-mock/src/main/java/org/apache/sling/testing/mock/sling/junit/SlingContextCallback.java
    sling/trunk/testing/mocks/sling-mock/src/main/java/org/apache/sling/testing/mock/sling/servlet/MockSlingHttpServletRequest.java

Modified: sling/trunk/testing/mocks/resourceresolver-mock/src/main/java/org/apache/sling/testing/resourceresolver/MockResourceResolverFactory.java
URL: http://svn.apache.org/viewvc/sling/trunk/testing/mocks/resourceresolver-mock/src/main/java/org/apache/sling/testing/resourceresolver/MockResourceResolverFactory.java?rev=1637018&r1=1637017&r2=1637018&view=diff
==============================================================================
--- sling/trunk/testing/mocks/resourceresolver-mock/src/main/java/org/apache/sling/testing/resourceresolver/MockResourceResolverFactory.java (original)
+++ sling/trunk/testing/mocks/resourceresolver-mock/src/main/java/org/apache/sling/testing/resourceresolver/MockResourceResolverFactory.java Thu Nov  6 00:32:42 2014
@@ -98,9 +98,6 @@ public class MockResourceResolverFactory
      */
     private ThreadLocal<Stack<ResourceResolver>> resolverStackHolder = new ThreadLocal<Stack<ResourceResolver>>();
 
-    /**
-     * @see org.apache.sling.api.resource.ResourceResolverFactory#getThreadResourceResolver()
-     */
     // part of Resource API 2.8.0
     public ResourceResolver getThreadResourceResolver() {
         ResourceResolver result = null;

Modified: sling/trunk/testing/mocks/resourceresolver-mock/src/main/java/org/apache/sling/testing/resourceresolver/MockValueMap.java
URL: http://svn.apache.org/viewvc/sling/trunk/testing/mocks/resourceresolver-mock/src/main/java/org/apache/sling/testing/resourceresolver/MockValueMap.java?rev=1637018&r1=1637017&r2=1637018&view=diff
==============================================================================
--- sling/trunk/testing/mocks/resourceresolver-mock/src/main/java/org/apache/sling/testing/resourceresolver/MockValueMap.java (original)
+++ sling/trunk/testing/mocks/resourceresolver-mock/src/main/java/org/apache/sling/testing/resourceresolver/MockValueMap.java Thu Nov  6 00:32:42 2014
@@ -36,7 +36,7 @@ import org.apache.sling.api.wrappers.Val
  * <ul>
  * <li>Converts all Date values to Calendar objects internally and vice versa.</li>
  * <li>Converts InputStream to byte array and vice versa.</li>
- * <ul>
+ * </ul>
  */
 public class MockValueMap extends ValueMapDecorator {
     

Modified: sling/trunk/testing/mocks/sling-mock/src/main/java/org/apache/sling/testing/mock/sling/context/SlingContextImpl.java
URL: http://svn.apache.org/viewvc/sling/trunk/testing/mocks/sling-mock/src/main/java/org/apache/sling/testing/mock/sling/context/SlingContextImpl.java?rev=1637018&r1=1637017&r2=1637018&view=diff
==============================================================================
--- sling/trunk/testing/mocks/sling-mock/src/main/java/org/apache/sling/testing/mock/sling/context/SlingContextImpl.java (original)
+++ sling/trunk/testing/mocks/sling-mock/src/main/java/org/apache/sling/testing/mock/sling/context/SlingContextImpl.java Thu Nov  6 00:32:42 2014
@@ -104,6 +104,7 @@ public class SlingContextImpl {
     
     /**
      * Initialize mocked resource resolver factory.
+     * @return Resource resolver factory
      */
     protected ResourceResolverFactory newResourceResolverFactory() {
         return ContextResourceResolverFactory.get(this.resourceResolverType);
@@ -277,6 +278,7 @@ public class SlingContextImpl {
 
     /**
      * Registers a service in the mocked OSGi environment.
+     * @param <T> Service type
      * @param service Service instance
      * @return Registered service instance
      */
@@ -286,6 +288,7 @@ public class SlingContextImpl {
 
     /**
      * Registers a service in the mocked OSGi environment.
+     * @param <T> Service type
      * @param serviceClass Service class
      * @param service Service instance
      * @return Registered service instance
@@ -296,6 +299,7 @@ public class SlingContextImpl {
 
     /**
      * Registers a service in the mocked OSGi environment.
+     * @param <T> Service type
      * @param serviceClass Service class
      * @param service Service instance
      * @param properties Service properties (optional)
@@ -314,6 +318,7 @@ public class SlingContextImpl {
     /**
      * Injects dependencies, activates and registers a service in the mocked
      * OSGi environment.
+     * @param <T> Service type
      * @param service Service instance
      * @return Registered service instance
      */
@@ -324,6 +329,7 @@ public class SlingContextImpl {
     /**
      * Injects dependencies, activates and registers a service in the mocked
      * OSGi environment.
+     * @param <T> Service type
      * @param service Service instance
      * @param properties Service properties (optional)
      * @return Registered service instance
@@ -337,6 +343,7 @@ public class SlingContextImpl {
 
     /**
      * Lookup a single service
+     * @param <ServiceType> Service type
      * @param serviceType The type (interface) of the service.
      * @return The service instance, or null if the service is not available.
      */
@@ -346,10 +353,11 @@ public class SlingContextImpl {
 
     /**
      * Lookup one or several services
+     * @param <ServiceType> Service type
      * @param serviceType The type (interface) of the service.
      * @param filter An optional filter (LDAP-like, see OSGi spec)
      * @return The services object or null.
-     * @throws InvalidServiceFilterSyntaxException If the <code>filter</code>
+     * @throws org.apache.sling.api.scripting.InvalidServiceFilterSyntaxException If the <code>filter</code>
      *             string is not a valid OSGi service filter string.
      */
     public final <ServiceType> ServiceType[] getServices(final Class<ServiceType> serviceType, final String filter) {

Modified: sling/trunk/testing/mocks/sling-mock/src/main/java/org/apache/sling/testing/mock/sling/junit/SlingContext.java
URL: http://svn.apache.org/viewvc/sling/trunk/testing/mocks/sling-mock/src/main/java/org/apache/sling/testing/mock/sling/junit/SlingContext.java?rev=1637018&r1=1637017&r2=1637018&view=diff
==============================================================================
--- sling/trunk/testing/mocks/sling-mock/src/main/java/org/apache/sling/testing/mock/sling/junit/SlingContext.java (original)
+++ sling/trunk/testing/mocks/sling-mock/src/main/java/org/apache/sling/testing/mock/sling/junit/SlingContext.java Thu Nov  6 00:32:42 2014
@@ -37,34 +37,15 @@ public final class SlingContext extends 
     private final TestRule delegate;
 
     /**
-     * Initialize Sling context.
-     * <p>
-     * If context is initialized with:
-     * </p>
-     * <ul>
-     * <li>No resource resolver type - default is used
-     * {@link MockSling#DEFAULT_RESOURCERESOLVER_TYPE}.</li>
-     * <li>One resource resolver type - exactly this is used.</li>
-     * <li>More than one: all unit test methods are executed for all resource
-     * resolver types using {@link ListGenerator}.</li>
-     * </ul>
+     * Initialize Sling context with default resource resolver type:
+     * {@link org.apache.sling.testing.mock.sling.MockSling#DEFAULT_RESOURCERESOLVER_TYPE}.
      */
     public SlingContext() {
         this(null, null, null);
     }
 
     /**
-     * Initialize Sling context.
-     * <p>
-     * If context is initialized with:
-     * </p>
-     * <ul>
-     * <li>No resource resolver type - default is used
-     * {@link MockSling#DEFAULT_RESOURCERESOLVER_TYPE}.</li>
-     * <li>One resource resolver type - exactly this is used.</li>
-     * <li>More than one: all unit test methods are executed for all resource
-     * resolver types using {@link ListGenerator}.</li>
-     * </ul>
+     * Initialize Sling context with resource resolver type.
      * @param resourceResolverType Resource resolver type.
      */
     public SlingContext(final ResourceResolverType resourceResolverType) {
@@ -72,17 +53,8 @@ public final class SlingContext extends 
     }
 
     /**
-     * Initialize Sling context.
-     * <p>
-     * If context is initialized with:
-     * </p>
-     * <ul>
-     * <li>No resource resolver type - default is used
-     * {@link MockSling#DEFAULT_RESOURCERESOLVER_TYPE}.</li>
-     * <li>One resource resolver type - exactly this is used.</li>
-     * <li>More than one: all unit test methods are executed for all resource
-     * resolver types using {@link ListGenerator}.</li>
-     * </ul>
+     * Initialize Sling context with default resource resolver type:
+     * {@link org.apache.sling.testing.mock.sling.MockSling#DEFAULT_RESOURCERESOLVER_TYPE}.
      * @param setUpCallback Allows the application to register an own callback
      *            function that is called after the built-in setup rules are
      *            executed.
@@ -92,17 +64,7 @@ public final class SlingContext extends 
     }
 
     /**
-     * Initialize Sling context.
-     * <p>
-     * If context is initialized with:
-     * </p>
-     * <ul>
-     * <li>No resource resolver type - default is used
-     * {@link MockSling#DEFAULT_RESOURCERESOLVER_TYPE}.</li>
-     * <li>One resource resolver type - exactly this is used.</li>
-     * <li>More than one: all unit test methods are executed for all resource
-     * resolver types using {@link ListGenerator}.</li>
-     * </ul>
+     * Initialize Sling context with resource resolver type.
      * @param setUpCallback Allows the application to register an own callback
      *            function that is called after the built-in setup rules are
      *            executed.
@@ -113,17 +75,8 @@ public final class SlingContext extends 
     }
 
     /**
-     * Initialize Sling context.
-     * <p>
-     * If context is initialized with:
-     * </p>
-     * <ul>
-     * <li>No resource resolver type - default is used
-     * {@link MockSling#DEFAULT_RESOURCERESOLVER_TYPE}.</li>
-     * <li>One resource resolver type - exactly this is used.</li>
-     * <li>More than one: all unit test methods are executed for all resource
-     * resolver types using {@link ListGenerator}.</li>
-     * </ul>
+     * Initialize Sling context with default resource resolver type:
+     * {@link org.apache.sling.testing.mock.sling.MockSling#DEFAULT_RESOURCERESOLVER_TYPE}.
      * @param setUpCallback Allows the application to register an own callback
      *            function that is called after the built-in setup rules are
      *            executed.
@@ -136,17 +89,7 @@ public final class SlingContext extends 
     }
     
     /**
-     * Initialize Sling context.
-     * <p>
-     * If context is initialized with:
-     * </p>
-     * <ul>
-     * <li>No resource resolver type - default is used
-     * {@link MockSling#DEFAULT_RESOURCERESOLVER_TYPE}.</li>
-     * <li>One resource resolver type - exactly this is used.</li>
-     * <li>More than one: all unit test methods are executed for all resource
-     * resolver types using {@link ListGenerator}.</li>
-     * </ul>
+     * Initialize Sling context with resource resolver type.
      * @param setUpCallback Allows the application to register an own callback
      *            function that is called after the built-in setup rules are
      *            executed.

Modified: sling/trunk/testing/mocks/sling-mock/src/main/java/org/apache/sling/testing/mock/sling/junit/SlingContextCallback.java
URL: http://svn.apache.org/viewvc/sling/trunk/testing/mocks/sling-mock/src/main/java/org/apache/sling/testing/mock/sling/junit/SlingContextCallback.java?rev=1637018&r1=1637017&r2=1637018&view=diff
==============================================================================
--- sling/trunk/testing/mocks/sling-mock/src/main/java/org/apache/sling/testing/mock/sling/junit/SlingContextCallback.java (original)
+++ sling/trunk/testing/mocks/sling-mock/src/main/java/org/apache/sling/testing/mock/sling/junit/SlingContextCallback.java Thu Nov  6 00:32:42 2014
@@ -24,13 +24,15 @@ import org.apache.sling.api.resource.Per
 
 /**
  * Callback-interface for application-specific setup and teardown operations to
- * customize the {@link AemContext} JUnit rule.
+ * customize the {@link SlingContext} JUnit rule.
  */
 public interface SlingContextCallback {
 
     /**
      * Execute callback action
      * @param context Sling context
+     * @throws IOException
+     * @throws PersistenceException
      */
     void execute(SlingContext context) throws IOException, PersistenceException;
 

Modified: sling/trunk/testing/mocks/sling-mock/src/main/java/org/apache/sling/testing/mock/sling/servlet/MockSlingHttpServletRequest.java
URL: http://svn.apache.org/viewvc/sling/trunk/testing/mocks/sling-mock/src/main/java/org/apache/sling/testing/mock/sling/servlet/MockSlingHttpServletRequest.java?rev=1637018&r1=1637017&r2=1637018&view=diff
==============================================================================
--- sling/trunk/testing/mocks/sling-mock/src/main/java/org/apache/sling/testing/mock/sling/servlet/MockSlingHttpServletRequest.java (original)
+++ sling/trunk/testing/mocks/sling-mock/src/main/java/org/apache/sling/testing/mock/sling/servlet/MockSlingHttpServletRequest.java Thu Nov  6 00:32:42 2014
@@ -110,6 +110,7 @@ public class MockSlingHttpServletRequest
 
     /**
      * @param resourceResolver Resource resolver
+     * @param bundleContext Bundle context
      */
     public MockSlingHttpServletRequest(ResourceResolver resourceResolver, BundleContext bundleContext) {
         this.resourceResolver = resourceResolver;