IDE warning cleanup

Author: mikesamuel

src/main/java/org/owasp/html/AttributePolicy.java

@@ -40,7 +40,7 @@
  * A policy that can be applied to an HTML attribute to decide whether or not to
  * allow it in the output, possibly after transforming its value.
  *
- * @author Mike Samuel <mikesamuel@gmail.com>
+ * @author Mike Samuel (mikesamuel@gmail.com)
  * @see HtmlPolicyBuilder.AttributeBuilder#matching(AttributePolicy)
  */
 @TCB public interface AttributePolicy {
@@ -88,7 +88,7 @@ public static final AttributePolicy join(AttributePolicy... policies) {
     }
   }
 
-
+  /** An attribute policy that returns the value unchanged. */
   public static final AttributePolicy IDENTITY_ATTRIBUTE_POLICY
       = new AttributePolicy() {
         public String apply(
@@ -97,6 +97,7 @@ public String apply(
         }
       };
 
+  /** An attribute policy that rejects all values. */
   public static final AttributePolicy REJECT_ALL_ATTRIBUTE_POLICY
       = new AttributePolicy() {
         public @Nullable String apply(
@@ -116,7 +117,8 @@ final class JoinedAttributePolicy implements AttributePolicy {
   }
 
   public @Nullable String apply(
-      String elementName, String attributeName, @Nullable String value) {
+      String elementName, String attributeName, @Nullable String rawValue) {
+    String value = rawValue;
     for (AttributePolicy p : policies) {
       if (value == null) { break; }
       value = p.apply(elementName, attributeName, value);

src/main/java/org/owasp/html/CssGrammar.java

@@ -180,6 +180,7 @@ static String cssContent(String token) {
         try {
           codepoint = Integer.parseInt(token.substring(esc + 1, end), 16);
         } catch (RuntimeException ex) {
+          ignore(ex);
           codepoint = 0xfffd;  // Unknown codepoint.
         }
         if (end < n) {
@@ -215,4 +216,8 @@ interface PropertyHandler {
     void endProperty();
   }
 
+  /** @param o ignored */
+  private static void ignore(Object o) {
+    // Do nothing
+  }
 }

src/main/java/org/owasp/html/CssSchema.java

@@ -53,7 +53,7 @@ static final class Property {
      */
     final ImmutableMap<String, String> fnKeys;
 
-    private Property(
+    Property(
         int bits, ImmutableSet<String> literals,
         ImmutableMap<String, String> fnKeys) {
       this.bits = bits;
@@ -126,13 +126,13 @@ public Set<String> allowedProperties() {
 
   /** The schema for the named property or function key. */
   Property forKey(String propertyName) {
-    propertyName = Strings.toLowerCase(propertyName);
-    Property property = properties.get(propertyName);
+    String propertyNameCanon = Strings.toLowerCase(propertyName);
+    Property property = properties.get(propertyNameCanon);
     if (property != null) { return property; }
-    int n = propertyName.length();
-    if (n != 0 && propertyName.charAt(0) == '-') {
-      String barePropertyName = stripVendorPrefix(propertyName);
-      property = properties.get(barePropertyName);
+    int n = propertyNameCanon.length();
+    if (n != 0 && propertyNameCanon.charAt(0) == '-') {
+      String barePropertyNameCanon = stripVendorPrefix(propertyNameCanon);
+      property = properties.get(barePropertyNameCanon);
       if (property != null) { return property; }
     }
     return DISALLOWED;

src/main/java/org/owasp/html/CssTokens.java

@@ -89,6 +89,7 @@ public static CssTokens lex(String css) {
   }
 
   /** A cursor into a list of tokens. */
+  @SuppressWarnings("synthetic-access")
   public final class TokenIterator implements Iterator<String> {
     private int tokenIndex = 0;
     private final int limit;
@@ -152,8 +153,8 @@ public TokenType type() {
       return tokenTypes[tokenIndex];
     }
 
-    public void seek(int tokenIndex) {
-      this.tokenIndex = tokenIndex;
+    public void seek(int newTokenIndex) {
+      this.tokenIndex = newTokenIndex;
     }
 
     public void advance() {
@@ -249,7 +250,7 @@ static final class Brackets {
      */
     private final int[] brackets;
 
-    private Brackets(int[] brackets) {
+    Brackets(int[] brackets) {
       this.brackets = brackets;
     }
 
@@ -290,6 +291,7 @@ int bracketIndexForToken(int target) {
   /**
    * Tokenizes according to section 4 of http://dev.w3.org/csswg/css-syntax/
    */
+  @SuppressWarnings("synthetic-access")
   private static final class Lexer {
     private final String css;
     private final StringBuilder sb;
@@ -427,7 +429,9 @@ void lex() {
 
       tokenTypes = new ArrayList<TokenType>();
 
+      @SuppressWarnings("hiding")  // final
       String css = this.css;
+      @SuppressWarnings("hiding")  // final
       int cssLimit = this.cssLimit;
       while (pos < cssLimit) {
         assert this.tokenBreaksLimit == this.tokenTypes.size()
@@ -687,7 +691,9 @@ private void consumeDelim(char ch) {
     }
 
     private boolean consumeIgnorable() {
+      @SuppressWarnings("hiding")  // final
       String css = this.css;
+      @SuppressWarnings("hiding")  // final
       int cssLimit = this.cssLimit;
       int posBefore = pos;
       while (pos < cssLimit) {
@@ -772,6 +778,7 @@ private void consumeMatch(char ch) {
     }
 
     private void consumeIdent(boolean allowFirstDigit) {
+      @SuppressWarnings("hiding")  // final
       int cssLimit = this.cssLimit;
       int last = -1, nCodepoints = 0;
       int sbAtStart = sb.length();
@@ -824,7 +831,9 @@ private boolean consumeAtKeyword() {
 
 
     private int consumeAndDecodeEscapeSequence() {
+      @SuppressWarnings("hiding")  // final
       String css = this.css;
+      @SuppressWarnings("hiding")  // final
       int cssLimit = this.cssLimit;
       assert css.charAt(pos) == '\\';
       if (pos + 1 >= cssLimit) { return -1; }
@@ -907,7 +916,9 @@ private void encodeCharOntoOutput(int codepoint, int last) {
     }
 
     private TokenType consumeNumberOrPercentageOrDimension() {
+      @SuppressWarnings("hiding")  // final
       String css = this.css;
+      @SuppressWarnings("hiding")  // final
       int cssLimit = this.cssLimit;
       boolean isZero = true;
       int intStart = pos;
@@ -1057,7 +1068,9 @@ private TokenType consumeNumberOrPercentageOrDimension() {
     }
 
     private TokenType consumeString() {
+      @SuppressWarnings("hiding")  // final
       String css = this.css;
+      @SuppressWarnings("hiding")  // final
       int cssLimit = this.cssLimit;
 
       char delim = css.charAt(pos);
@@ -1129,7 +1142,9 @@ private TokenType consumeString() {
     }
 
     private boolean consumeUnicodeRange() {
+      @SuppressWarnings("hiding")  // final
       final String css = this.css;
+      @SuppressWarnings("hiding")  // final
       final int cssLimit = this.cssLimit;
 
       assert pos < cssLimit && (css.charAt(pos) | 32) == 'u';
@@ -1246,7 +1261,9 @@ private boolean consumeUnicodeRange() {
     }
 
     private boolean consumeUrlValue() {
+      @SuppressWarnings("hiding")  // final
       String css = this.css;
+      @SuppressWarnings("hiding")  // final
       int cssLimit = this.cssLimit;
       if (pos == cssLimit || css.charAt(pos) != '(') { return false; }
       ++pos;
@@ -1355,6 +1372,7 @@ private boolean consumeUrlValue() {
      * unit.
      */
     private int readCodepoint() {
+      @SuppressWarnings("hiding")  // final
       String css = this.css;
       char ch = css.charAt(pos);
       if (Character.isHighSurrogate(ch) && pos + 1 < cssLimit) {

src/main/java/org/owasp/html/ElementAndAttributePolicies.java

@@ -35,7 +35,7 @@
 
 /**
  * Encapsulates all the information needed by the
- * {@link ElementAndAttributePolicyBasedSanitizerPolicy} to sanitize one kind
+ * {@link ElementAndAttributePolicySanitizerPolicy} to sanitize one kind
  * of element.
  */
 @Immutable

src/main/java/org/owasp/html/ElementPolicy.java

@@ -41,7 +41,7 @@
  * {@link AttributePolicy attribute policies} so
  * they can be used to add extra attributes.
  *
- * @author Mike Samuel <mikesamuel@gmail.com>
+ * @author Mike Samuel (mikesamuel@gmail.com)
  * @see HtmlPolicyBuilder#allowElements(ElementPolicy, String...)
  */
 @TCB public interface ElementPolicy {
@@ -100,13 +100,15 @@ void join(ElementPolicy p) {
 
   }
 
+  /** An element policy that returns the element unchanged. */
   public static final ElementPolicy IDENTITY_ELEMENT_POLICY
       = new ElementPolicy() {
     public String apply(String elementName, List<String> attrs) {
       return elementName;
     }
   };
 
+  /** An element policy that rejects all elements. */
   public static final ElementPolicy REJECT_ALL_ELEMENT_POLICY
       = new ElementPolicy() {
     public @Nullable String apply(String elementName, List<String> attrs) {
@@ -126,7 +128,9 @@ final class JoinedElementPolicy implements ElementPolicy {
   }
 
   public @Nullable String apply(String elementName, List<String> attrs) {
-    elementName = first.apply(elementName, attrs);
-    return elementName != null ? second.apply(elementName, attrs) : null;
+    String filteredElementName = first.apply(elementName, attrs);
+    return filteredElementName != null
+        ? second.apply(filteredElementName, attrs)
+        : null;
   }
 }

src/main/java/org/owasp/html/FilterUrlByProtocolAttributePolicy.java

@@ -52,12 +52,15 @@
  * do not look like they contain an authority portion.
  * </p>
  *
- * @author Mike Samuel <mikesamuel@gmail.com>
+ * @author Mike Samuel (mikesamuel@gmail.com)
  */
 @TCB
 public class FilterUrlByProtocolAttributePolicy implements AttributePolicy {
   private final ImmutableSet<String> protocols;
 
+  /**
+   * @param protocols lower-case protocol names without any trailing colon (":")
+   */
   public FilterUrlByProtocolAttributePolicy(
       Iterable<? extends String> protocols) {
     this.protocols = ImmutableSet.copyOf(protocols);

src/main/java/org/owasp/html/Handler.java

@@ -33,10 +33,15 @@
 /**
  * Receives notification of problems.
  *
- * @author Mike Samuel <mikesamuel@gmail.com>
+ * @param <T> the type of the problem.
+ * @author Mike Samuel (mikesamuel@gmail.com)
  */
 public interface Handler<T> {
 
+  /**
+   * Called to handle x.
+   * @param x the problem.
+   */
   void handle(T x);
 
   /** A handler that does nothing given any input. */

src/main/java/org/owasp/html/HtmlChangeReporter.java

@@ -55,6 +55,9 @@ public final class HtmlChangeReporter<T> {
   private final OutputChannel output;
   private final InputChannel<T> input;
 
+  /**
+   * @param context forwarded to listener along with any reports.
+   */
   public HtmlChangeReporter(
       HtmlStreamEventReceiver renderer,
       HtmlChangeListener<? super T> listener, @Nullable T context) {
@@ -70,8 +73,14 @@ public void setPolicy(HtmlSanitizer.Policy policy) {
     this.input.policy = policy;
   }
 
+  /**
+   * The underlying renderer.
+   */
   public HtmlStreamEventReceiver getWrappedRenderer() { return output; }
 
+  /**
+   * The underlying policy.
+   */
   public HtmlSanitizer.Policy getWrappedPolicy() { return input; }
 
   private static final class InputChannel<T> implements HtmlSanitizer.Policy {
@@ -133,6 +142,8 @@ public void closeTag(String elementName) {
     public void text(String textChunk) {
       policy.text(textChunk);
     }
+
+    private static final String[] ZERO_STRINGS = new String[0];
   }
 
   private static final class OutputChannel implements HtmlStreamEventReceiver {
@@ -170,6 +181,4 @@ public void text(String text) {
       renderer.text(text);
     }
   }
-
-  private static final String[] ZERO_STRINGS = new String[0];
 }

src/main/java/org/owasp/html/HtmlLexer.java

@@ -40,7 +40,7 @@
  * A flexible lexer for HTML.
  * This is hairy code, but it is outside the TCB for the HTML sanitizer.
  *
- * @author Mike Samuel <mikesamuel@gmail.com>
+ * @author Mike Samuel (mikesamuel@gmail.com)
  */
 @NotThreadSafe
 final class HtmlLexer extends AbstractTokenStream {
@@ -440,7 +440,7 @@ private HtmlToken parseToken() {
           } else if ('"' == ch || '\'' == ch) {
             if (end + 1 < limit) {
               char ch2 = input.charAt(end + 1);
-              if (ch2 >= 0 && Character.isWhitespace(ch2)
+              if (Character.isWhitespace(ch2)
                   || ch2 == '>' || ch2 == '/') {
                 ++end;
                 break;
@@ -710,7 +710,7 @@ static HtmlToken reclassify(HtmlToken token, HtmlTokenType type) {
 /**
  * A TokenStream that lazily fetches one token at a time.
  *
- * @author Mike Samuel <mikesamuel@gmail.com>
+ * @author Mike Samuel (mikesamuel@gmail.com)
  */
 abstract class AbstractTokenStream implements TokenStream {
   private HtmlToken tok;