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 2016/09/14 21:02:39 UTC

svn commit: r1760755 - in /sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit: ./ impl/ impl/servlet/

Author: sseifert
Date: Wed Sep 14 21:02:38 2016
New Revision: 1760755

URL: http://svn.apache.org/viewvc?rev=1760755&view=rev
Log:
fix javadoc errors

Modified:
    sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/Renderer.java
    sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/RequestParser.java
    sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/BundleTestsProvider.java
    sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/TestsManagerImpl.java
    sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/HtmlRenderer.java
    sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/JUnitResultRenderer.java
    sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/JsonRenderer.java
    sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/PlainTextRenderer.java
    sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/XmlRenderer.java

Modified: sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/Renderer.java
URL: http://svn.apache.org/viewvc/sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/Renderer.java?rev=1760755&r1=1760754&r2=1760755&view=diff
==============================================================================
--- sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/Renderer.java (original)
+++ sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/Renderer.java Wed Sep 14 21:02:38 2016
@@ -26,7 +26,7 @@ import org.junit.runner.notification.Run
 
 /** Renderer for our servlet output. Should not be used directly for
  *  rendering as it leads to non-reentrant renderers. Use only via
- *  {@link RendererFactory} as {@link RendererSelectorImpl} does 
+ *  {@link RendererFactory} as {@link org.apache.sling.junit.impl.RendererSelectorImpl} does 
  */
  public interface Renderer {
     /** True if this renderer applies to supplied request */
@@ -39,12 +39,12 @@ import org.junit.runner.notification.Run
     void cleanup();
     
     /** Render a list of things 
-     * @param describes the role of the list, must be a valid CSS class value
+     * @param role describes the role of the list, must be a valid CSS class value
      */
     void list(String role, Collection<String> data);
     
     /** Render general information 
-     * @param describes the role of the list, must be a valid CSS class value
+     * @param role describes the role of the list, must be a valid CSS class value
      */
     void info(String role, String info);
     

Modified: sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/RequestParser.java
URL: http://svn.apache.org/viewvc/sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/RequestParser.java?rev=1760755&r1=1760754&r2=1760755&view=diff
==============================================================================
--- sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/RequestParser.java (original)
+++ sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/RequestParser.java Wed Sep 14 21:02:38 2016
@@ -93,7 +93,6 @@ public class RequestParser implements Te
         return selectedMethodName;
     }
     
-    /** @inheritDoc */
     public boolean acceptTestName(String testName) {
         if(testNameSelector.length() == 0) {
             return true;
@@ -102,7 +101,6 @@ public class RequestParser implements Te
         }
     }
 
-    /** @inheritDoc */
     public String getSelectedTestMethodName() {
         return selectedMethodName;
     }

Modified: sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/BundleTestsProvider.java
URL: http://svn.apache.org/viewvc/sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/BundleTestsProvider.java?rev=1760755&r1=1760754&r2=1760755&view=diff
==============================================================================
--- sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/BundleTestsProvider.java (original)
+++ sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/BundleTestsProvider.java Wed Sep 14 21:02:38 2016
@@ -196,7 +196,6 @@ public class BundleTestsProvider impleme
         return null;
     }
     
-    /** @inheritDoc */
     public Class<?> createTestClass(String testName) throws ClassNotFoundException {
         // Find the bundle to which the class belongs
         Bundle b = null;
@@ -213,17 +212,14 @@ public class BundleTestsProvider impleme
         return b.loadClass(testName);
     }
 
-    /** @inheritDoc */
     public long lastModified() {
         return lastModified;
     }
 
-    /** @inheritDoc */
     public String getServicePid() {
         return pid;
     }
 
-    /** @inheritDoc */
     public List<String> getTestNames() {
         maybeUpdateTestClasses();
         final List<String> result = new ArrayList<String>();

Modified: sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/TestsManagerImpl.java
URL: http://svn.apache.org/viewvc/sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/TestsManagerImpl.java?rev=1760755&r1=1760754&r2=1760755&view=diff
==============================================================================
--- sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/TestsManagerImpl.java (original)
+++ sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/TestsManagerImpl.java Wed Sep 14 21:02:38 2016
@@ -27,7 +27,6 @@ import java.util.concurrent.ConcurrentHa
 import org.apache.felix.scr.annotations.Component;
 import org.apache.felix.scr.annotations.Service;
 import org.apache.sling.junit.Renderer;
-import org.apache.sling.junit.SlingTestContext;
 import org.apache.sling.junit.SlingTestContextProvider;
 import org.apache.sling.junit.TestSelector;
 import org.apache.sling.junit.TestsManager;
@@ -72,14 +71,12 @@ public class TestsManagerImpl implements
         bundleContext = null;
     }
     
-    /** @inheritDoc */
     public void clearCaches() {
         log.debug("Clearing internal caches");
         lastModified.clear();
         lastTrackingCount = -1;
     }
     
-    /** @inheritDoc */
     public Class<?> getTestClass(String testName) throws ClassNotFoundException {
         maybeUpdateProviders();
 
@@ -104,7 +101,6 @@ public class TestsManagerImpl implements
         return provider.createTestClass(testName);
     }
 
-    /** inheritDoc */
     public Collection<String> getTestNames(TestSelector selector) {
         maybeUpdateProviders();
         
@@ -172,7 +168,6 @@ public class TestsManagerImpl implements
         lastTrackingCount = tracker.getTrackingCount();
     }
 
-    /** @inheritDoc */
     public void executeTests(Collection<String> testNames, Renderer renderer, TestSelector selector) throws Exception {
         renderer.title(2, "Running tests");
         final JUnitCore junit = new JUnitCore();
@@ -209,7 +204,6 @@ public class TestsManagerImpl implements
         }
     }
 
-    /** @inheritDoc */
     public void listTests(Collection<String> testNames, Renderer renderer) throws Exception {
         renderer.title(2, "Test classes");
         final String note = "The test set can be restricted using partial test names"

Modified: sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/HtmlRenderer.java
URL: http://svn.apache.org/viewvc/sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/HtmlRenderer.java?rev=1760755&r1=1760754&r2=1760755&view=diff
==============================================================================
--- sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/HtmlRenderer.java (original)
+++ sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/HtmlRenderer.java Wed Sep 14 21:02:38 2016
@@ -41,31 +41,26 @@ public class HtmlRenderer extends RunLis
     public static final String EXTENSION = "html";
     private PrintWriter output;
 
-    /** @inheritDoc */
     public Renderer createRenderer() {
         return new HtmlRenderer();
     }
 
-    /** @inheritDoc */
     public boolean appliesTo(TestSelector s) {
         // This is our default renderer, applies to the empty
         // extension as well
         return EXTENSION.equals(s.getExtension()) || "".equals(s.getExtension());
     }
 
-    /** @inheritDoc */
     public String getExtension() {
         return EXTENSION;
     }
 
-    /** @inheritDoc */
     public void info(String cssClass, String str) {
         output.println("<p class='" + cssClass + "'>");
         HtmlFilter.escape(output, str);
         output.println("</p>");
     }
 
-    /** @inheritDoc */
     public void list(String cssClass, Collection<String> data) {
         output.println("<ul class='testNames'>");
         for(String str : data) {
@@ -76,14 +71,12 @@ public class HtmlRenderer extends RunLis
         output.println("</ul>");
     }
 
-    /** @inheritDoc */
     public void title(int level, String title) {
         output.print("<h" + level + ">");
         HtmlFilter.escape(output, title);
         output.print("</h" + level + ">");
     }
 
-    /** @inheritDoc */
     public void link(String info, String url, String method) {
         output.println("<div class='link'>");
 
@@ -106,7 +99,6 @@ public class HtmlRenderer extends RunLis
         output.println("</div>");
     }
 
-    /** @inheritDoc */
     public void setup(HttpServletResponse response, String pageTitle) throws IOException, UnsupportedEncodingException {
         if(output != null) {
             throw new IllegalStateException("Output Writer already set");
@@ -124,14 +116,12 @@ public class HtmlRenderer extends RunLis
         output.println("</h1>");
     }
 
-    /** @inheritDoc */
     public void cleanup() {
         output.println("</body>");
         output.println("</html>");
         output = null;
     }
 
-    /** @inheritDoc */
     public RunListener getRunListener() {
         return this;
     }

Modified: sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/JUnitResultRenderer.java
URL: http://svn.apache.org/viewvc/sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/JUnitResultRenderer.java?rev=1760755&r1=1760754&r2=1760755&view=diff
==============================================================================
--- sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/JUnitResultRenderer.java (original)
+++ sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/JUnitResultRenderer.java Wed Sep 14 21:02:38 2016
@@ -44,29 +44,24 @@ public class JUnitResultRenderer extends
     private ObjectOutputStream outputStream;
     private final Logger log = LoggerFactory.getLogger(getClass());
 
-    /** @inheritDoc */
     public Renderer createRenderer() { 
         return new JUnitResultRenderer();
     }
     
-    /** @inheritDoc */
     public boolean appliesTo(TestSelector s) {
         return EXTENSION.equals(s.getExtension());
     }
     
-    /** @inheritDoc */
     public String getExtension() {
         return EXTENSION;
     }
 
-    /** @inheritDoc */
     public void setup(HttpServletResponse response, String pageTitle) 
     throws IOException, UnsupportedEncodingException {
         response.setContentType("application/x-java-serialized-object");
         outputStream = new ObjectOutputStream(response.getOutputStream());
     }
     
-    /** @inheritDoc */
     public void cleanup() {
         try {
             outputStream.flush();
@@ -77,24 +72,19 @@ public class JUnitResultRenderer extends
         outputStream = null;
     }
 
-    /** @inheritDoc */
     public RunListener getRunListener() {
         return this;
     }
 
-    /** @inheritDoc */
     public void info(String role, String info) {
     }
 
-    /** @inheritDoc */
     public void link(String info, String url, String method) {
     }
 
-    /** @inheritDoc */
     public void list(String role, Collection<String> data) {
     }
 
-    /** @inheritDoc */
     public void title(int level, String title) {
     }
     

Modified: sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/JsonRenderer.java
URL: http://svn.apache.org/viewvc/sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/JsonRenderer.java?rev=1760755&r1=1760754&r2=1760755&view=diff
==============================================================================
--- sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/JsonRenderer.java (original)
+++ sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/JsonRenderer.java Wed Sep 14 21:02:38 2016
@@ -50,22 +50,18 @@ public class JsonRenderer extends RunLis
     private final Logger log = LoggerFactory.getLogger(getClass());
     private JSONWriter writer;
     
-    /** @inheritDoc */
     public Renderer createRenderer() { 
         return new JsonRenderer();
     }
 
-    /** @inheritDoc */
     public boolean appliesTo(TestSelector selector) {
         return EXTENSION.equals(selector.getExtension());
     }
 
-    /** @inheritDoc */
     public String getExtension() {
         return EXTENSION;
     }
 
-    /** @inheritDoc */
     public void setup(HttpServletResponse response, String pageTitle) throws IOException, UnsupportedEncodingException {
         if(writer != null) {
             throw new IllegalStateException("Output Writer already set");
@@ -81,7 +77,6 @@ public class JsonRenderer extends RunLis
         }
     }
 
-    /** @inheritDoc */
     public void cleanup() {
         if(writer != null) {
             try {
@@ -93,7 +88,6 @@ public class JsonRenderer extends RunLis
         writer = null;
     }
 
-    /** @inheritDoc */
     public void info(String cssClass, String info) {
         try {
             startItem("info");
@@ -105,7 +99,6 @@ public class JsonRenderer extends RunLis
         }
     }
 
-    /** @inheritDoc */
     public void list(String cssClass, Collection<String> data) {
         try {
             startItem("list");
@@ -122,12 +115,10 @@ public class JsonRenderer extends RunLis
         }
     }
 
-    /** @inheritDoc */
     public void title(int level, String title) {
         // Titles are not needed in JSON
     }
     
-    /** @inheritDoc */
     public void link(String info, String url, String method) {
         try {
             startItem("link");
@@ -140,7 +131,6 @@ public class JsonRenderer extends RunLis
         }
     }
 
-    /** @inheritDoc */
     public RunListener getRunListener() {
         return this;
     }

Modified: sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/PlainTextRenderer.java
URL: http://svn.apache.org/viewvc/sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/PlainTextRenderer.java?rev=1760755&r1=1760754&r2=1760755&view=diff
==============================================================================
--- sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/PlainTextRenderer.java (original)
+++ sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/PlainTextRenderer.java Wed Sep 14 21:02:38 2016
@@ -40,23 +40,18 @@ public class PlainTextRenderer extends R
     public static final String EXTENSION = "txt";
     private PrintWriter output;
     
-    /** @inheritDoc */
     public Renderer createRenderer() { 
         return new PlainTextRenderer();
     }
 
-    /** @inheritDoc */
     public boolean appliesTo(TestSelector selector) {
         return EXTENSION.equals(selector.getExtension());
     }
 
-    
-    /** @inheritDoc */
     public String getExtension() {
         return EXTENSION;
     }
 
-    /** @inheritDoc */
     public void setup(HttpServletResponse response, String pageTitle) throws IOException, UnsupportedEncodingException {
         if(output != null) {
             throw new IllegalStateException("Output Writer already set");
@@ -67,30 +62,25 @@ public class PlainTextRenderer extends R
         title(1, pageTitle);
     }
     
-    /** @inheritDoc */
     public void cleanup() {
         output = null;
     }
 
-    /** @inheritDoc */
     public void info(String cssClass, String str) {
         output.println(str);
     }
     
-    /** @inheritDoc */
     public void list(String cssClass, Collection<String> data) {
         for(String str : data) {
             output.println(str);
         }
     }
     
-    /** @inheritDoc */
     public void title(int level, String title) {
         output.print(title);
         output.println(" ****");
     }
     
-    /** @inheritDoc */
     public void link(String info, String url, String method) {
         output.print("LINK: ");
         output.print(info);
@@ -100,7 +90,6 @@ public class PlainTextRenderer extends R
         output.println(method);
     }
 
-    /** @inheritDoc */
     public RunListener getRunListener() {
         return this;
     }

Modified: sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/XmlRenderer.java
URL: http://svn.apache.org/viewvc/sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/XmlRenderer.java?rev=1760755&r1=1760754&r2=1760755&view=diff
==============================================================================
--- sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/XmlRenderer.java (original)
+++ sling/trunk/testing/junit/core/src/main/java/org/apache/sling/junit/impl/servlet/XmlRenderer.java Wed Sep 14 21:02:38 2016
@@ -111,22 +111,18 @@ public class XmlRenderer extends RunList
 	 */
 	private int testSuiteCount = 0;
 
-    /** @inheritDoc */
     public Renderer createRenderer() { 
         return new XmlRenderer();
     }
 
-    /** @inheritDoc */
     public boolean appliesTo(TestSelector selector) {
         return EXTENSION.equals(selector.getExtension());
     }
 
-    /** @inheritDoc */
     public String getExtension() {
         return EXTENSION;
     }
 
-    /** @inheritDoc */
 	public void setup(HttpServletResponse response, String pageTitle) throws IOException, UnsupportedEncodingException {
         if(output != null) {
             throw new IllegalStateException("Output Writer already set");
@@ -143,25 +139,20 @@ public class XmlRenderer extends RunList
 
 	}   
 
-    /** @inheritDoc */
 	public void info(String cssClass, String str) {
 	}
 
-    /** @inheritDoc */
 	public void list(String cssClass, Collection<String> data) {
 	}
 
-    /** @inheritDoc */
 	public void title(int level, String title) {
 		if (level == 3)
 			name = title;
 	}
 	
-    /** @inheritDoc */
     public void link(String info, String url, String method) {
     }
 
-    /** @inheritDoc */
 	public void cleanup() {
 		if (testSuiteCount > 1) {
 			output.println(getStringFromElement(suitesElement));
@@ -171,7 +162,6 @@ public class XmlRenderer extends RunList
 		output = null;
 	}
 	
-    /** @inheritDoc */
     public RunListener getRunListener() {
         return this;
     }