Add SafeUri overloads for setting properties used for navigation

Change-Id: I8ab7a472b0c0c4470f00f7178de216f7c7e4e415

Author: mdempsky

tools/api-checker/config/gwt25_26userApi.conf

@@ -154,3 +154,15 @@ com.google.gwt.benchmarks.client MISSING
 # Split BaseListenerWrapper
 com.google.gwt.user.client.BaseListenerWrapper::getSource(Lcom/google/gwt/event/shared/GwtEvent;) MISSING
 com.google.gwt.user.client.BaseListenerWrapper::setSource(Lcom/google/gwt/user/client/ui/Widget;) MISSING
+
+# Add SafeUri variants of some existing String methods that
+# are used for navigation purposes.
+com.google.gwt.dom.client.AnchorElement::setHref(Ljava/lang/String;) OVERLOADED_METHOD_CALL
+com.google.gwt.dom.client.FormElement::setAction(Ljava/lang/String;) OVERLOADED_METHOD_CALL
+com.google.gwt.dom.client.FrameElement::setLongDesc(Ljava/lang/String;) OVERLOADED_METHOD_CALL
+com.google.gwt.dom.client.FrameElement::setSrc(Ljava/lang/String;) OVERLOADED_METHOD_CALL
+com.google.gwt.dom.client.IFrameElement::setSrc(Ljava/lang/String;) OVERLOADED_METHOD_CALL
+com.google.gwt.dom.client.ModElement::setCite(Ljava/lang/String;) OVERLOADED_METHOD_CALL
+com.google.gwt.dom.client.ObjectElement::setData(Ljava/lang/String;) OVERLOADED_METHOD_CALL
+com.google.gwt.dom.client.QuoteElement::setCite(Ljava/lang/String;) OVERLOADED_METHOD_CALL
+com.google.gwt.user.client.ui.Anchor::setHref(Ljava/lang/String;) OVERLOADED_METHOD_CALL

user/src/com/google/gwt/dom/builder/client/DomAnchorBuilder.java

@@ -17,6 +17,7 @@
 
 import com.google.gwt.dom.builder.shared.AnchorBuilder;
 import com.google.gwt.dom.client.AnchorElement;
+import com.google.gwt.safehtml.shared.SafeUri;
 
 /**
  * DOM-based implementation of {@link AnchorBuilder}.
@@ -34,6 +35,12 @@ public AnchorBuilder accessKey(String accessKey) {
     return this;
   }
 
+  @Override
+  public AnchorBuilder href(SafeUri href) {
+    assertCanAddAttribute().setHref(href);
+    return this;
+  }
+
   @Override
   public AnchorBuilder href(String href) {
     assertCanAddAttribute().setHref(href);

user/src/com/google/gwt/dom/builder/client/DomFormBuilder.java

@@ -17,6 +17,7 @@
 
 import com.google.gwt.dom.builder.shared.FormBuilder;
 import com.google.gwt.dom.client.FormElement;
+import com.google.gwt.safehtml.shared.SafeUri;
 
 /**
  * DOM-based implementation of {@link FormBuilder}.
@@ -34,6 +35,12 @@ public FormBuilder acceptCharset(String acceptCharset) {
     return this;
   }
 
+  @Override
+  public FormBuilder action(SafeUri action) {
+    assertCanAddAttribute().setAction(action);
+    return this;
+  }
+
   @Override
   public FormBuilder action(String action) {
     assertCanAddAttribute().setAction(action);

user/src/com/google/gwt/dom/builder/client/DomFrameBuilder.java

@@ -17,6 +17,7 @@
 
 import com.google.gwt.dom.builder.shared.FrameBuilder;
 import com.google.gwt.dom.client.FrameElement;
+import com.google.gwt.safehtml.shared.SafeUri;
 
 /**
  * DOM-based implementation of {@link FrameBuilder}.
@@ -34,6 +35,12 @@ public FrameBuilder frameBorder(int frameBorder) {
     return this;
   }
 
+  @Override
+  public FrameBuilder longDesc(SafeUri longDesc) {
+    assertCanAddAttribute().setLongDesc(longDesc);
+    return this;
+  }
+
   @Override
   public FrameBuilder longDesc(String longDesc) {
     assertCanAddAttribute().setLongDesc(longDesc);
@@ -70,6 +77,12 @@ public FrameBuilder scrolling(String scrolling) {
     return this;
   }
 
+  @Override
+  public FrameBuilder src(SafeUri src) {
+    assertCanAddAttribute().setSrc(src);
+    return this;
+  }
+
   @Override
   public FrameBuilder src(String src) {
     assertCanAddAttribute().setSrc(src);

user/src/com/google/gwt/dom/builder/client/DomIFrameBuilder.java

@@ -19,6 +19,7 @@
 import com.google.gwt.dom.builder.shared.IFrameBuilder;
 import com.google.gwt.dom.client.IFrameElement;
 import com.google.gwt.safehtml.shared.SafeHtml;
+import com.google.gwt.safehtml.shared.SafeUri;
 
 /**
  * DOM-based implementation of {@link IFrameBuilder}.
@@ -76,6 +77,12 @@ public IFrameBuilder scrolling(String scrolling) {
     return this;
   }
 
+  @Override
+  public IFrameBuilder src(SafeUri src) {
+    assertCanAddAttribute().setSrc(src);
+    return this;
+  }
+
   @Override
   public IFrameBuilder src(String src) {
     assertCanAddAttribute().setSrc(src);

user/src/com/google/gwt/dom/builder/client/DomModBuilder.java

@@ -17,6 +17,7 @@
 
 import com.google.gwt.dom.builder.shared.ModBuilder;
 import com.google.gwt.dom.client.ModElement;
+import com.google.gwt.safehtml.shared.SafeUri;
 
 /**
  * DOM-based implementation of {@link ModBuilder}.
@@ -27,6 +28,12 @@ public class DomModBuilder extends DomElementBuilderBase<ModBuilder, ModElement>
     super(delegate);
   }
 
+  @Override
+  public ModBuilder cite(SafeUri cite) {
+    assertCanAddAttribute().setCite(cite);
+    return this;
+  }
+
   @Override
   public ModBuilder cite(String cite) {
     assertCanAddAttribute().setCite(cite);

user/src/com/google/gwt/dom/builder/client/DomQuoteBuilder.java

@@ -17,6 +17,7 @@
 
 import com.google.gwt.dom.builder.shared.QuoteBuilder;
 import com.google.gwt.dom.client.QuoteElement;
+import com.google.gwt.safehtml.shared.SafeUri;
 
 /**
  * DOM-based implementation of {@link QuoteBuilder}.
@@ -28,6 +29,12 @@ public class DomQuoteBuilder extends DomElementBuilderBase<QuoteBuilder, QuoteEl
     super(delegate);
   }
 
+  @Override
+  public QuoteBuilder cite(SafeUri cite) {
+    assertCanAddAttribute().setCite(cite);
+    return this;
+  }
+
   @Override
   public QuoteBuilder cite(String cite) {
     assertCanAddAttribute().setCite(cite);

user/src/com/google/gwt/dom/builder/shared/AnchorBuilder.java

@@ -15,6 +15,8 @@
  */
 package com.google.gwt.dom.builder.shared;
 
+import com.google.gwt.safehtml.shared.SafeUri;
+
 /**
  * Builds an anchor element.
  */
@@ -31,7 +33,16 @@ public interface AnchorBuilder extends ElementBuilderBase<AnchorBuilder> {
 
   /**
    * The absolute URI of the linked resource.
-   * 
+   *
+   * @see <a
+   *      href="http://www.w3.org/TR/1999/REC-html401-19991224/struct/links.html#adef-href">W3C
+   *      HTML Specification</a>
+   */
+  AnchorBuilder href(SafeUri href);
+
+  /**
+   * The absolute URI of the linked resource.
+   *
    * @see <a
    *      href="http://www.w3.org/TR/1999/REC-html401-19991224/struct/links.html#adef-href">W3C
    *      HTML Specification</a>

user/src/com/google/gwt/dom/builder/shared/FormBuilder.java

@@ -15,6 +15,8 @@
  */
 package com.google.gwt.dom.builder.shared;
 
+import com.google.gwt.safehtml.shared.SafeUri;
+
 /**
  * Builds an form element.
  */
@@ -31,7 +33,16 @@ public interface FormBuilder extends ElementBuilderBase<FormBuilder> {
 
   /**
    * Server-side form handler.
-   * 
+   *
+   * @see <a
+   *      href="http://www.w3.org/TR/1999/REC-html401-19991224/interact/forms.html#adef-action">W3C
+   *      HTML Specification</a>
+   */
+  FormBuilder action(SafeUri action);
+
+  /**
+   * Server-side form handler.
+   *
    * @see <a
    *      href="http://www.w3.org/TR/1999/REC-html401-19991224/interact/forms.html#adef-action">W3C
    *      HTML Specification</a>

user/src/com/google/gwt/dom/builder/shared/FrameBuilder.java

@@ -15,6 +15,8 @@
  */
 package com.google.gwt.dom.builder.shared;
 
+import com.google.gwt.safehtml.shared.SafeUri;
+
 /**
  * Builds an frame element.
  */
@@ -31,7 +33,16 @@ public interface FrameBuilder extends ElementBuilderBase<FrameBuilder> {
 
   /**
    * URI designating a long description of this image or frame.
-   * 
+   *
+   * @see <a
+   *      href="http://www.w3.org/TR/1999/REC-html401-19991224/present/frames.html#adef-longdesc-FRAME">W3C
+   *      HTML Specification</a>
+   */
+  FrameBuilder longDesc(SafeUri longDesc);
+
+  /**
+   * URI designating a long description of this image or frame.
+   *
    * @see <a
    *      href="http://www.w3.org/TR/1999/REC-html401-19991224/present/frames.html#adef-longdesc-FRAME">W3C
    *      HTML Specification</a>
@@ -85,7 +96,16 @@ public interface FrameBuilder extends ElementBuilderBase<FrameBuilder> {
 
   /**
    * A URI designating the initial frame contents.
-   * 
+   *
+   * @see <a
+   *      href="http://www.w3.org/TR/1999/REC-html401-19991224/present/frames.html#adef-src-FRAME">W3C
+   *      HTML Specification</a>
+   */
+  FrameBuilder src(SafeUri src);
+
+  /**
+   * A URI designating the initial frame contents.
+   *
    * @see <a
    *      href="http://www.w3.org/TR/1999/REC-html401-19991224/present/frames.html#adef-src-FRAME">W3C
    *      HTML Specification</a>

user/src/com/google/gwt/dom/builder/shared/HtmlAnchorBuilder.java

@@ -15,6 +15,8 @@
  */
 package com.google.gwt.dom.builder.shared;
 
+import com.google.gwt.safehtml.shared.SafeUri;
+
 /**
  * HTML-based implementation of {@link AnchorBuilder}.
  */
@@ -30,6 +32,11 @@ public AnchorBuilder accessKey(String accessKey) {
     return trustedAttribute("accessKey", accessKey);
   }
 
+  @Override
+  public AnchorBuilder href(SafeUri href) {
+    return href(href.asString());
+  }
+
   @Override
   public AnchorBuilder href(String href) {
     return trustedAttribute("href", href);

user/src/com/google/gwt/dom/builder/shared/HtmlFormBuilder.java

@@ -15,6 +15,8 @@
  */
 package com.google.gwt.dom.builder.shared;
 
+import com.google.gwt.safehtml.shared.SafeUri;
+
 /**
  * HTML-based implementation of {@link FormBuilder}.
  */
@@ -29,6 +31,11 @@ public FormBuilder acceptCharset(String acceptCharset) {
     return trustedAttribute("acceptCharset", acceptCharset);
   }
 
+  @Override
+  public FormBuilder action(SafeUri action) {
+    return action(action.asString());
+  }
+
   @Override
   public FormBuilder action(String action) {
     return trustedAttribute("action", action);

user/src/com/google/gwt/dom/builder/shared/HtmlFrameBuilder.java

@@ -15,6 +15,8 @@
  */
 package com.google.gwt.dom.builder.shared;
 
+import com.google.gwt.safehtml.shared.SafeUri;
+
 /**
  * HTML-based implementation of {@link FrameBuilder}.
  */
@@ -29,6 +31,11 @@ public FrameBuilder frameBorder(int frameBorder) {
     return trustedAttribute("frameBorder", frameBorder);
   }
 
+  @Override
+  public FrameBuilder longDesc(SafeUri longDesc) {
+    return longDesc(longDesc.asString());
+  }
+
   @Override
   public FrameBuilder longDesc(String longDesc) {
     return trustedAttribute("longDesc", longDesc);
@@ -59,6 +66,11 @@ public FrameBuilder scrolling(String scrolling) {
     return trustedAttribute("scrolling", scrolling);
   }
 
+  @Override
+  public FrameBuilder src(SafeUri src) {
+    return src(src.asString());
+  }
+
   @Override
   public FrameBuilder src(String src) {
     return trustedAttribute("src", src);

user/src/com/google/gwt/dom/builder/shared/HtmlIFrameBuilder.java

@@ -16,6 +16,7 @@
 package com.google.gwt.dom.builder.shared;
 
 import com.google.gwt.safehtml.shared.SafeHtml;
+import com.google.gwt.safehtml.shared.SafeUri;
 
 /**
  * HTML-based implementation of {@link IFrameBuilder}.
@@ -67,6 +68,11 @@ public IFrameBuilder scrolling(String scrolling) {
     return trustedAttribute("scrolling", scrolling);
   }
 
+  @Override
+  public IFrameBuilder src(SafeUri src) {
+    return src(src.asString());
+  }
+
   @Override
   public IFrameBuilder src(String src) {
     return trustedAttribute("src", src);

user/src/com/google/gwt/dom/builder/shared/HtmlQuoteBuilder.java

@@ -15,6 +15,8 @@
  */
 package com.google.gwt.dom.builder.shared;
 
+import com.google.gwt.safehtml.shared.SafeUri;
+
 /**
  * HTML-based implementation of {@link QuoteBuilder}.
  */
@@ -24,6 +26,11 @@ public class HtmlQuoteBuilder extends HtmlElementBuilderBase<QuoteBuilder> imple
     super(delegate);
   }
 
+  @Override
+  public QuoteBuilder cite(SafeUri cite) {
+    return cite(cite.asString());
+  }
+
   @Override
   public QuoteBuilder cite(String cite) {
     return trustedAttribute("cite", cite);

user/src/com/google/gwt/dom/builder/shared/IFrameBuilder.java

@@ -16,6 +16,7 @@
 package com.google.gwt.dom.builder.shared;
 
 import com.google.gwt.safehtml.shared.SafeHtml;
+import com.google.gwt.safehtml.shared.SafeUri;
 
 /**
  * Builds an iframe element.
@@ -92,7 +93,16 @@ public interface IFrameBuilder extends ElementBuilderBase<IFrameBuilder> {
 
   /**
    * A URI designating the initial frame contents.
-   * 
+   *
+   * @see <a
+   *      href="http://www.w3.org/TR/1999/REC-html401-19991224/present/frames.html#adef-src-FRAME">W3C
+   *      HTML Specification</a>
+   */
+  IFrameBuilder src(SafeUri src);
+
+  /**
+   * A URI designating the initial frame contents.
+   *
    * @see <a
    *      href="http://www.w3.org/TR/1999/REC-html401-19991224/present/frames.html#adef-src-FRAME">W3C
    *      HTML Specification</a>