Package opennlp.tools.tokenize.uax29

# Record Class WordToken

java.lang.Object
java.lang.Record
opennlp.tools.tokenize.uax29.WordToken

Record Components:
  `span` - The character offsets of the token in the source text.
  `type` - The token category.

public record WordToken(opennlp.tools.util.Span span, WordType type) extends Record
A word token produced by `WordTokenizer`: the character `Span` into the source text together with its `WordType`.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `WordToken(opennlp.tools.util.Span span, WordType type)`
  Creates an instance of a `WordToken` record class.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `final boolean`
  `equals(Object o)`
  Indicates whether some other object is "equal to" this one.
  `final int`
  `hashCode()`
  Returns a hash code value for this object.
  `opennlp.tools.util.Span`
  `span()`
  Returns the value of the `span` record component.
  `CharSequence`
  `text(CharSequence source)`
  Returns the covered text of this token.
  `final String`
  `toString()`
  Returns a string representation of this record class.
  `WordType`
  `type()`
  Returns the value of the `type` record component.

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

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

- ## Constructor Details

  - ### WordToken

    public WordToken(opennlp.tools.util.Span span, WordType type)
    Creates an instance of a `WordToken` record class.
    Parameters:
      `span` - the value for the `span` record component
      `type` - the value for the `type` record component

- ## Method Details

  - ### text

    public CharSequence text(CharSequence source)
    Returns the covered text of this token.
    Parameters:
      `source` - The text this token was produced from.
    Returns:
      The covered text.

  - ### toString

    public final String toString()
    Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
    Specified by:
      `toString` in class `Record`
    Returns:
      a string representation of this object

  - ### hashCode

    public final int hashCode()
    Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
    Specified by:
      `hashCode` in class `Record`
    Returns:
      a hash code value for this object

  - ### equals

    public final boolean equals(Object o)
    Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with `Objects::equals(Object,Object)`.
    Specified by:
      `equals` in class `Record`
    Parameters:
      `o` - the object with which to compare
    Returns:
      `true` if this object is the same as the `o` argument; `false` otherwise.

  - ### span

    public opennlp.tools.util.Span span()
    Returns the value of the `span` record component.
    Returns:
      the value of the `span` record component

  - ### type

    public WordType type()
    Returns the value of the `type` record component.
    Returns:
      the value of the `type` record component