com.io7m.jpra.model.names

## Class FieldName

- java.lang.Object
- - com.io7m.jpra.model.names.FieldName

- All Implemented Interfaces:
    ModelElementType

      @Immutable
      public final class FieldName
      extends Object
      implements ModelElementType

  The type of field names.

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static Pattern` | `PATTERN` The pattern that defines a valid field name.

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `FieldName(Optional<com.io7m.jlexing.core.LexicalPosition<Path>> in_lex, String in_value)` Construct a field name.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `equals(Object o)`
    `Optional<com.io7m.jlexing.core.LexicalPosition<Path>>` | `getLexicalInformation()` Fetch the lexical information for the element.
    `String` | `getValue()`
    `int` | `hashCode()`
    `String` | `toString()`

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

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

- - ### Field Detail

    - #### PATTERN

          public static final Pattern PATTERN

      The pattern that defines a valid field name.

  - ### Constructor Detail

    - #### FieldName

          public FieldName(Optional<com.io7m.jlexing.core.LexicalPosition<Path>> in_lex,
                           String in_value)

      Construct a field name.
      Parameters:
        `in_lex` - The lexical information for the name
        `in_value` - The raw string value

  - ### Method Detail

    - #### equals

          public boolean equals(Object o)

      Overrides:
        `equals` in class `Object`

    - #### getValue

          public String getValue()

      Returns:
        The raw string value

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `Object`

    - #### getLexicalInformation

          public Optional<com.io7m.jlexing.core.LexicalPosition<Path>> getLexicalInformation()

      Description copied from interface: `ModelElementType`
      Fetch the lexical information for the element. This is used to localize error messages to a position in a file when referring to specific elements.
      Specified by:
        `getLexicalInformation` in interface `ModelElementType`
      Returns:
        The original lexical information, if any

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