Symbol (API documentation of hlt.language packages)
Date: 2013-01-30

hlt.language.syntax

## Class Symbol

- java.lang.Object
- - hlt.language.util.Indexed
  - - hlt.language.util.AbstractListIndexed
    - - hlt.language.syntax.Symbol

- All Implemented Interfaces:
    Comparable, Named
  Direct Known Subclasses:
    GrammarSymbol, OperatorSymbol

      public class Symbol
      extends AbstractListIndexed
      implements Named, Comparable

  This class is a representation of symbols used at parser construction time.
  Version:
    Last modified on Fri Apr 13 20:13:11 2012 by hak
  Author:
    Hassan Aït-Kaci
  See Also:
    `GrammarSymbol`, `OperatorSymbol`
  Copyright:
    © by the author

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `lessThan(Comparable other)` Symbols other than operators are ordered by their names, ignoring all leading non-letter characters.
    `java.lang.String` | `name()`
    `java.lang.String` | `toString()`

    - ### Methods inherited from class hlt.language.util.AbstractListIndexed

      `add, equals`

    - ### Methods inherited from class hlt.language.util.Indexed

      `hashCode, index`

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

      `getClass, notify, notifyAll, wait, wait, wait`

- - ### Method Detail

    - #### name

          public java.lang.String name()

      Specified by:
        `name` in interface `Named`

    - #### lessThan

          public boolean lessThan(Comparable other)

      Symbols other than operators are ordered by their names, ignoring all leading non-letter characters. Operators are ordered by their precedences in their category - i.e., this method is overridden in the subclass `Operator`.
      Specified by:
        `lessThan` in interface `Comparable`

    - #### toString

          public java.lang.String toString()

      Overrides:
        `toString` in class `Indexed`