Class OnlyToBeUsedInGeneratedCodeStringBlessedAsSafeHtml

java.lang.Object
com.google.gwt.safehtml.shared.OnlyToBeUsedInGeneratedCodeStringBlessedAsSafeHtml
All Implemented Interfaces:
SafeHtml, Serializable

public class OnlyToBeUsedInGeneratedCodeStringBlessedAsSafeHtml extends Object implements SafeHtml
A string wrapped as an object of type SafeHtml.

This class is intended only for use in generated code where the code generator guarantees that instances of this type will adhere to the SafeHtml contract (hence the purposely unwieldy class name).

See Also:
  • Constructor Details

    • OnlyToBeUsedInGeneratedCodeStringBlessedAsSafeHtml

      public OnlyToBeUsedInGeneratedCodeStringBlessedAsSafeHtml(String html)
      Constructs an instance from a given HTML String.
      Parameters:
      html - an HTML String that is assumed to be safe
  • Method Details

    • asString

      public String asString()
      Returns this object's contained HTML as a string.

      Based on this class' contract, the returned value will be non-null and a string that is safe to use in an HTML context.

      Specified by:
      asString in interface SafeHtml
      Returns:
      the contents as a String
    • equals

      public boolean equals(Object obj)
      Compares this string to the specified object.
      Specified by:
      equals in interface SafeHtml
      Overrides:
      equals in class Object
      Parameters:
      obj - the object to compare to
    • hashCode

      public int hashCode()
      Returns a hash code for this string.
      Specified by:
      hashCode in interface SafeHtml
      Overrides:
      hashCode in class Object