SpecialTokens.Token (linguistics 7.509.14 API)

java.lang.Object
- com.yahoo.language.process.SpecialTokens.Token

All Implemented Interfaces:

Comparable<SpecialTokens.Token>

Enclosing class:

SpecialTokens
```
public static final class SpecialTokens.Token
extends Object
implements Comparable<SpecialTokens.Token>
```
An immutable special token

Constructor Summary

Constructors
Constructor	Description
`Token(String token)`	Creates a special token
`Token(String token, String replacement)`	Creates a special token which will be represented by the given replacement token

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(SpecialTokens.Token other)`
`boolean`	`equals(Object other)`
`int`	`hashCode()`
`String`	`replacement()`	Returns the token to replace occurrences of this by, which equals token() unless this has a replacement.
`String`	`token()`	Returns the special token
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Token
```
public Token(String token)
```
    Creates a special token
  - Token
```
public Token(String token,
             String replacement)
```
    Creates a special token which will be represented by the given replacement token
- Method Detail
  - token
```
public String token()
```
    Returns the special token
  - replacement
```
public String replacement()
```
    Returns the token to replace occurrences of this by, which equals token() unless this has a replacement.
  - compareTo
```
public int compareTo(SpecialTokens.Token other)
```
    Specified by:
    
    compareTo in interface Comparable<SpecialTokens.Token>
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object