OnlyToBeUsedInGeneratedCodeStringBlessedAsSafeHtml (GWT Javadoc)

Overview | Package | Class | Use | Deprecated | Help
| GWT 2.7.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.google.gwt.safehtml.shared
Class OnlyToBeUsedInGeneratedCodeStringBlessedAsSafeHtml

    java.lang.Object
      com.google.gwt.safehtml.shared.OnlyToBeUsedInGeneratedCodeStringBlessedAsSafeHtml

All Implemented Interfaces:
  SafeHtml, java.io.Serializable

    public class OnlyToBeUsedInGeneratedCodeStringBlessedAsSafeHtml

extends java.lang.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:
  Serialized Form

Constructor Summary
`OnlyToBeUsedInGeneratedCodeStringBlessedAsSafeHtml(java.lang.String html)` Constructs an instance from a given HTML String.

Method Summary
`java.lang.String` | `asString()` Returns this object's contained HTML as a string.
`boolean` | `equals(java.lang.Object obj)` Compares this string to the specified object.
`int` | `hashCode()` Returns a hash code for this string.

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### OnlyToBeUsedInGeneratedCodeStringBlessedAsSafeHtml

    public OnlyToBeUsedInGeneratedCodeStringBlessedAsSafeHtml(java.lang.String html)

  Constructs an instance from a given HTML String.

  Parameters:
    `html` - an HTML String that is assumed to be safe

Method Detail

### asString

    public java.lang.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(java.lang.Object obj)

  Compares this string to the specified object.

  Specified by:
    `equals` in interface `SafeHtml`
  Overrides:
    `equals` in class `java.lang.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 `java.lang.Object`

Overview | Package | Class | Use | Deprecated | Help
| GWT 2.7.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD