Package opennlp.tools.util.normalizer

# Record Class UnicodeWhitespace.RelatedCharacter

java.lang.Object
java.lang.Record
opennlp.tools.util.normalizer.UnicodeWhitespace.RelatedCharacter

Record Components:
  `codePoint` - The Unicode code point.
  `name` - The Unicode character name, lower cased as in the reference table.
  `abbreviation` - The common abbreviation (for example `BOM`), or `""` if none.
  `note` - A short description of what the character actually does.

Enclosing class:
  `UnicodeWhitespace`

public static record UnicodeWhitespace.RelatedCharacter(int codePoint, String name, String abbreviation, String note) extends Record
One related code point that is commonly confused with whitespace but is not (`White_Space=no`). These are format characters and must not be treated as, or normalized like, whitespace.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `RelatedCharacter(int codePoint, String name, String abbreviation, String note)`
  Creates an instance of a `RelatedCharacter` record class.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `abbreviation()`
  Returns the value of the `abbreviation` record component.
  `int`
  `codePoint()`
  Returns the value of the `codePoint` record component.
  `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.
  `String`
  `name()`
  Returns the value of the `name` record component.
  `String`
  `note()`
  Returns the value of the `note` record component.
  `final String`
  `toString()`
  Returns a string representation of this record class.
  `String`
  `toUnicodeNotation()`
  Returns the `U+XXXX` notation for this code point.

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

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

- ## Constructor Details

  - ### RelatedCharacter

    public RelatedCharacter(int codePoint, String name, String abbreviation, String note)
    Creates an instance of a `RelatedCharacter` record class.
    Parameters:
      `codePoint` - the value for the `codePoint` record component
      `name` - the value for the `name` record component
      `abbreviation` - the value for the `abbreviation` record component
      `note` - the value for the `note` record component

- ## Method Details

  - ### toUnicodeNotation

    public String toUnicodeNotation()
    Returns the `U+XXXX` notation for this code point.
    Returns:
      the `U+XXXX` notation for this code point

  - ### 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. Reference components are compared with `Objects::equals(Object,Object)`; primitive components are compared with '=='.
    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.

  - ### codePoint

    public int codePoint()
    Returns the value of the `codePoint` record component.
    Returns:
      the value of the `codePoint` record component

  - ### name

    public String name()
    Returns the value of the `name` record component.
    Returns:
      the value of the `name` record component

  - ### abbreviation

    public String abbreviation()
    Returns the value of the `abbreviation` record component.
    Returns:
      the value of the `abbreviation` record component

  - ### note

    public String note()
    Returns the value of the `note` record component.
    Returns:
      the value of the `note` record component