com.io7m.jstructural.core

## Class SID

- java.lang.Object
- - com.io7m.jstructural.core.SID

-     @Immutable
      public final class SID
      extends Object

  An ID attribute, unique over a document.

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `equals(Object obj)`
    `String` | `getActual()`
    `int` | `hashCode()`
    `static SID` | `newID(String actual)` Construct a new ID.
    `String` | `toString()`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### Method Detail

    - #### newID

          @Nonnull
          public static SID newID(@Nonnull
                          String actual)
                           throws com.io7m.jaux.Constraints.ConstraintError

      Construct a new ID.
      Parameters:
        `actual` - The ID text
      Returns:
        A new ID
      Throws:
        `com.io7m.jaux.Constraints.ConstraintError` - If any parameter is `null`

    - #### equals

          public boolean equals(Object obj)

      Overrides:
        `equals` in class `Object`

    - #### getActual

          @Nonnull
          public String getActual()

      Returns:
        The ID text

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `Object`

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

Copyright © 2014 <code@io7m.com> http://io7m.com