IDE warning cleanup

Author: mikesamuel

src/test/java/org/owasp/html/AntiSamyTest.java

@@ -41,8 +41,16 @@
 
 import nu.validator.htmlparser.dom.HtmlDocumentBuilder;
 
+/**
+ * An executable that benchmarks the sanitizer against an alternative.
+ */
 public class Benchmark {
 
+  /**
+   * By default times all alternatives.
+   * If there is an input of the form {@code /[hsp]+/} then each letter
+   * specifies a benchmark to run and unspecified ones are not run.
+   */
   public static void main(String[] args) throws Exception {
     String html = Files.toString(new File(args[0]), Charsets.UTF_8);
 
@@ -129,7 +137,7 @@ private static int parseUsingLibhtmlparser(String html) throws Exception {
     return System.identityHashCode(node) >> 24;
   }
 
-  private static String sanitize(String html) throws Exception {
+  private static String sanitize(String html) {
     StringBuilder sb = new StringBuilder(html.length());
 
     final HtmlStreamRenderer renderer = HtmlStreamRenderer.create(
@@ -181,8 +189,7 @@ public void closeTag(String elementName) {
 
   private static HtmlPolicyBuilder policyBuilder;
 
-  private static String sanitizeUsingPolicyBuilder(String html)
-      throws Exception {
+  private static String sanitizeUsingPolicyBuilder(String html) {
     if (policyBuilder == null) {
       policyBuilder = new HtmlPolicyBuilder()
           .allowStandardUrlProtocols()

src/test/java/org/owasp/html/Benchmark.java

@@ -38,6 +38,7 @@
 
 import com.google.common.collect.Maps;
 
+@SuppressWarnings("javadoc")
 public class CssFuzzerTest extends FuzzyTestCase {
 
   private static final String[] TOKEN_PARTS = new String[] {
@@ -65,9 +66,7 @@ public void run() {
         try {
           while (true) {
             this.wait(1000 /* ms = 1s */);
-            String input = this.input;
             if (input == null) { break; }  // Done
-            long started = this.started;
             long now = System.nanoTime();
             if (now - started >= 1000000000L /* ns = 1s */) {
               System.err.println(
@@ -76,6 +75,7 @@ public void run() {
           }
         } catch (InterruptedException ex) {
           // Done
+          ignore(ex);
         }
       }
     }
@@ -303,4 +303,9 @@ static String fixDigitSpaceUnit(CssTokens tokens) {
     }
     return sb.toString();
   }
+
+  /** @param o ignored */
+  static void ignore(Object o) {
+    // Do nothing.
+  }
 }

src/test/java/org/owasp/html/CssFuzzerTest.java

@@ -37,9 +37,10 @@
 
 import junit.framework.TestCase;
 
+@SuppressWarnings("javadoc")
 public class CssGrammarTest extends TestCase {
   @Test
-  public static final void testLex() throws Exception {
+  public static final void testLex() {
     CssTokens tokens = CssTokens.lex(Joiner.on('\n').join(
         "/* A comment */",
         "words with-dashes #hashes .dots. -and-leading-dashes",

src/test/java/org/owasp/html/CssGrammarTest.java

@@ -34,6 +34,7 @@
 
 import junit.framework.TestCase;
 
+@SuppressWarnings("javadoc")
 public final class CssSchemaTest extends TestCase {
 
   @Test

src/test/java/org/owasp/html/CssSchemaTest.java

@@ -40,6 +40,7 @@
 
 import static org.owasp.html.CssTokens.TokenType.*;
 
+@SuppressWarnings({ "javadoc" })
 public class CssTokensTest extends TestCase {
 
   private static CssTokens lex(String s) {
@@ -81,15 +82,15 @@ public static final void testBracketIndices() {
   }
 
   @Test
-  public static final void testStringEscaping() throws Exception {
+  public static final void testStringEscaping() {
     // input                         golden
     String[] tests = {
         "''",                          "''",
         "\"\"",                        "''",
         "\"\\a\"",                     "'\\a'",
         "\"\\0d\\0a\"",                "'\\d\\a'",
         "'\\000000d'",                 "'\\0 d'",   // too many hex digits
-        "'\\1fffff'",                  "'\ufffd'",  // exceeeds max codepoint
+        "'\\1fffff'",                  "'\ufffd'",  // exceeds max codepoint
         "\"'\"",                       "'\\27'",
         "\"\\\"\"",                    "'\\22'",
         "'\\\\'",                      "'\\\\'",
@@ -128,7 +129,7 @@ public static final void testStringEscaping() throws Exception {
   }
 
   @Test
-  public static final void testComments() throws Exception {
+  public static final void testComments() {
     assertEquals(
         "a b c d e f g h",
         lex(
@@ -137,12 +138,12 @@ public static final void testComments() throws Exception {
   }
 
   @Test
-  public static final void testNonCommentSlash() throws Exception {
+  public static final void testNonCommentSlash() {
     assertEquals("foo/ bar/", lex("foo/bar/").normalizedCss);
   }
 
   @Test
-  public static final void testCdoCdc() throws Exception {
+  public static final void testCdoCdc() {
     assertEquals(
         "|| and are ignorable||",
         lex("||<!-- and --> are ignorable||").normalizedCss);
@@ -152,7 +153,7 @@ public static final void testCdoCdc() throws Exception {
   }
 
   @Test
-  public static final void testIdentReencoding() throws Exception {
+  public static final void testIdentReencoding() {
     // input                         golden
     String[] tests = {
         "\\",                        null,
@@ -222,12 +223,12 @@ public static final void testIdentReencoding() throws Exception {
   }
 
   @Test
-  public static final void testOrphanedCloseBrackets() throws Exception {
+  public static final void testOrphanedCloseBrackets() {
     assertEquals("{foo bar}", lex("{foo]bar").normalizedCss);
   }
 
   @Test
-  public static final void testAtDirectives() throws Exception {
+  public static final void testAtDirectives() {
     assertTokens(
         "@import \"foo/bar\"; @ at, @34",
         "@import:AT", " ", "'foo/bar':STRING", ";:SEMICOLON",
@@ -236,7 +237,7 @@ public static final void testAtDirectives() throws Exception {
   }
 
   @Test
-  public static final void testHash() throws Exception {
+  public static final void testHash() {
     assertTokens(
         "#fff #foo #-moz-foo #abcd #abcdef #012f34 #888 #42foo # #",
         "#fff:HASH_UNRESTRICTED", " ",
@@ -251,7 +252,7 @@ public static final void testHash() throws Exception {
   }
 
   @Test
-  public static final void testSignsAndDots() throws Exception {
+  public static final void testSignsAndDots() {
     assertTokens(
         "- . + +1 + 1 (1 + 1)--> .5 -.5 +.5 ++.5 .foo -",
         "-:IDENT", " ", ".:DELIM", " ", "+:DELIM", " ", "1:NUMBER", " ",
@@ -262,7 +263,7 @@ public static final void testSignsAndDots() throws Exception {
     // TODO: is a single "-" an IDENT or a DELIM?  "--"?  "---"?
   }
 
-  public static final void testMultiCharPunctuation() throws Exception {
+  public static final void testMultiCharPunctuation() {
     assertTokens(
         "|| ~= === |= =^= $= *= = : % & ~",
         "||:COLUMN", " ", "~=:MATCH", " ", "=:DELIM", "=:DELIM", "=:DELIM", " ",
@@ -272,13 +273,13 @@ public static final void testMultiCharPunctuation() throws Exception {
   }
 
   @Test
-  public static final void testNul() throws Exception {
+  public static final void testNul() {
     assertTokens("\u0000");
     assertTokens("\u0000x\u0000", "x:IDENT");
   }
 
   @Test
-  public static final void testNumbers() throws Exception {
+  public static final void testNumbers() {
     assertTokens(
         "0 -0 +0 0.0 -0.0 -.0 0e12 0e-12 0e+12",
         "0:NUMBER", " ",
@@ -314,7 +315,7 @@ public static final void testNumbers() throws Exception {
   }
 
   @Test
-  public static final void testUrls() throws Exception {
+  public static final void testUrls() {
     assertTokens(
         "url() url('..')url( \"foo\" ) URL( f\"/(bar'\\\\baz ) url('foo \\a b')"
         + "Url( \u0080\u1234\ud801\udc02\\110000)",
@@ -328,7 +329,7 @@ public static final void testUrls() throws Exception {
   }
 
   @Test
-  public static final void testFunctions() throws Exception {
+  public static final void testFunctions() {
     assertTokens("( rgb(0,0,0) rgba(0,50%,0,100%)",
         "(:LEFT_PAREN",
         " ",

src/test/java/org/owasp/html/CssTokensTest.java

@@ -16,6 +16,7 @@
 import static org.owasp.html.ElementPolicy.IDENTITY_ELEMENT_POLICY;
 import static org.owasp.html.ElementPolicy.Util.join;
 
+@SuppressWarnings("javadoc")
 public final class ElementPolicyTest extends TestCase {
 
   static class HasCharElementPolicy implements ElementPolicy {

src/test/java/org/owasp/html/ElementPolicyTest.java

@@ -32,7 +32,8 @@
 
 import junit.framework.TestCase;
 
-public class EncodingTest extends TestCase {
+@SuppressWarnings("javadoc")
+public final class EncodingTest extends TestCase {
 
   @Test
   public static final void testDecodeHtml() {

src/test/java/org/owasp/html/EncodingTest.java

@@ -41,6 +41,7 @@
 
 import junit.framework.TestCase;
 
+@SuppressWarnings("javadoc")
 public class ExamplesTest extends TestCase {
   @Test
   public static final void testExamplesRun() throws Exception {

src/test/java/org/owasp/html/ExamplesTest.java

@@ -38,7 +38,7 @@
  * If you see a failure, please report it along with the seed from the output.
  * If you want to repeat a failure, set the system property "junit.seed".
  *
- * @author Mike Samuel <[email protected]>
+ * @author Mike Samuel ([email protected])
  */
 abstract class FuzzyTestCase extends TestCase {