java.lang.Object
- java.lang.Enum<Letter>
- - com.uddernetworks.newocr.recognition.similarity.Letter

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Letter>, java.lang.constant.Constable
```
public enum Letter
extends java.lang.Enum<Letter>
```
An enum containing every possible character piece that can be detected. Each one of these are recognised as a separate character and will be trained as such.

Since:

April 25, 2019

Nested Class Summary
- Nested classes/interfaces inherited from class java.lang.Enum
  java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

Enum Constant Summary

Enum Constants
Enum Constant	Description
`a`
`A`
`AMPERSAND`
`APOSTROPHE`
`ASTERISK`
`AT`
`b`
`B`
`BACKSLASH`
`c`
`C`
`CARROT`
`COLON_BOTTOM`
`COLON_TOP`
`COMMA`
`d`
`D`
`DOLLAR`
`e`
`E`
`EIGHT`
`EQUALS_BOTTOM`
`EQUALS_TOP`
`EXCLAMATION`
`EXCLAMATION_DOT`
`f`
`F`
`FIVE`
`FORWARD_SLASH`
`FOUR`
`g`
`G`
`GRAVE`
`GREATER_THAN`
`h`
`H`
`HASHTAG`
`i`
`I`
`i_DOT`
`j`
`J`
`j_DOT`
`k`
`K`
`l`
`L`
`LEFT_CURLY_BRACKET`
`LEFT_PARENTHESE`
`LEFT_SQUARE_BRACKET`
`LESS_THAN`
`m`
`M`
`MINUS`
`n`
`N`
`NINE`
`o`
`O`
`ONE`
`p`
`P`
`PERCENT_BASE`
`PERCENT_LDOT`
`PERCENT_RDOT`
`PERIOD`
`PIPE`
`PLUS`
`q`
`Q`
`QUESTION_MARK_BOTTOM`
`QUESTION_MARK_TOP`
`QUOTE_LEFT`
`QUOTE_RIGHT`
`r`
`R`
`RIGHT_CURLY_BRACKET`
`RIGHT_PARENTHESE`
`RIGHT_SQUARE_BRACKET`
`s`
`S`
`SEMICOLON_BOTTOM`
`SEMICOLON_TOP`
`SEVEN`
`SIX`
`SPACE`
`t`
`T`
`THREE`
`TILDE`
`TWO`
`u`
`U`
`UNDERSCORE`
`v`
`V`
`w`
`W`
`x`
`X`
`y`
`Y`
`z`
`Z`
`ZERO`

Method Summary

Modifier and Type	Method	Description
`char`	`getLetter()`
`static Letter`	`getLetter(char character, int mod)`
`static Letter`	`getLetter(ImageLetter imageLetter)`
`int`	`getMod()`
`boolean`	`matches(char letter, int mod)`
`boolean`	`matches(ImageLetter imageLetter)`
`java.lang.String`	`toString()`
`static Letter`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static Letter[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

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

Enum Constant Detail

EXCLAMATION
```
public static final Letter EXCLAMATION
```

EXCLAMATION_DOT

public static final Letter EXCLAMATION_DOT

QUOTE_LEFT
```
public static final Letter QUOTE_LEFT
```

QUOTE_RIGHT
```
public static final Letter QUOTE_RIGHT
```

HASHTAG
```
public static final Letter HASHTAG
```

DOLLAR
```
public static final Letter DOLLAR
```

PERCENT_BASE

public static final Letter PERCENT_BASE

PERCENT_LDOT

public static final Letter PERCENT_LDOT

PERCENT_RDOT

public static final Letter PERCENT_RDOT

AMPERSAND
```
public static final Letter AMPERSAND
```

APOSTROPHE
```
public static final Letter APOSTROPHE
```

LEFT_PARENTHESE

public static final Letter LEFT_PARENTHESE

RIGHT_PARENTHESE

public static final Letter RIGHT_PARENTHESE

ASTERISK
```
public static final Letter ASTERISK
```

PLUS
```
public static final Letter PLUS
```

COMMA
```
public static final Letter COMMA
```

MINUS
```
public static final Letter MINUS
```

PERIOD
```
public static final Letter PERIOD
```

FORWARD_SLASH

public static final Letter FORWARD_SLASH

ZERO
```
public static final Letter ZERO
```

ONE
```
public static final Letter ONE
```

TWO
```
public static final Letter TWO
```

THREE
```
public static final Letter THREE
```

FOUR
```
public static final Letter FOUR
```

FIVE
```
public static final Letter FIVE
```

SIX
```
public static final Letter SIX
```

SEVEN
```
public static final Letter SEVEN
```

EIGHT
```
public static final Letter EIGHT
```

NINE
```
public static final Letter NINE
```

COLON_TOP
```
public static final Letter COLON_TOP
```

COLON_BOTTOM

public static final Letter COLON_BOTTOM

SEMICOLON_TOP

public static final Letter SEMICOLON_TOP

SEMICOLON_BOTTOM

public static final Letter SEMICOLON_BOTTOM

LESS_THAN
```
public static final Letter LESS_THAN
```

EQUALS_TOP
```
public static final Letter EQUALS_TOP
```

EQUALS_BOTTOM

public static final Letter EQUALS_BOTTOM

GREATER_THAN

public static final Letter GREATER_THAN

QUESTION_MARK_TOP

public static final Letter QUESTION_MARK_TOP

QUESTION_MARK_BOTTOM

public static final Letter QUESTION_MARK_BOTTOM

AT
```
public static final Letter AT
```

A
```
public static final Letter A
```

B
```
public static final Letter B
```

C
```
public static final Letter C
```

D
```
public static final Letter D
```

E
```
public static final Letter E
```

F
```
public static final Letter F
```

G
```
public static final Letter G
```

H
```
public static final Letter H
```

I
```
public static final Letter I
```

J
```
public static final Letter J
```

K
```
public static final Letter K
```

L
```
public static final Letter L
```

M
```
public static final Letter M
```

N
```
public static final Letter N
```

O
```
public static final Letter O
```

P
```
public static final Letter P
```

Q
```
public static final Letter Q
```

R
```
public static final Letter R
```

S
```
public static final Letter S
```

T
```
public static final Letter T
```

U
```
public static final Letter U
```

V
```
public static final Letter V
```

W
```
public static final Letter W
```

X
```
public static final Letter X
```

Y
```
public static final Letter Y
```

Z
```
public static final Letter Z
```

LEFT_SQUARE_BRACKET

public static final Letter LEFT_SQUARE_BRACKET

BACKSLASH
```
public static final Letter BACKSLASH
```

RIGHT_SQUARE_BRACKET

public static final Letter RIGHT_SQUARE_BRACKET

CARROT
```
public static final Letter CARROT
```

UNDERSCORE
```
public static final Letter UNDERSCORE
```

GRAVE
```
public static final Letter GRAVE
```

a
```
public static final Letter a
```

b
```
public static final Letter b
```

c
```
public static final Letter c
```

d
```
public static final Letter d
```

e
```
public static final Letter e
```

f
```
public static final Letter f
```

g
```
public static final Letter g
```

h
```
public static final Letter h
```

i_DOT
```
public static final Letter i_DOT
```

i
```
public static final Letter i
```

j_DOT
```
public static final Letter j_DOT
```

j
```
public static final Letter j
```

k
```
public static final Letter k
```

l
```
public static final Letter l
```

m
```
public static final Letter m
```

n
```
public static final Letter n
```

o
```
public static final Letter o
```

p
```
public static final Letter p
```

q
```
public static final Letter q
```

r
```
public static final Letter r
```

s
```
public static final Letter s
```

t
```
public static final Letter t
```

u
```
public static final Letter u
```

v
```
public static final Letter v
```

w
```
public static final Letter w
```

x
```
public static final Letter x
```

y
```
public static final Letter y
```

z
```
public static final Letter z
```

LEFT_CURLY_BRACKET

public static final Letter LEFT_CURLY_BRACKET

PIPE
```
public static final Letter PIPE
```

RIGHT_CURLY_BRACKET

public static final Letter RIGHT_CURLY_BRACKET

TILDE
```
public static final Letter TILDE
```

SPACE
```
public static final Letter SPACE
```

Method Detail
- values
```
public static Letter[] values()
```
  Returns an array containing the constants of this enum type, in the order they are declared.
  
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
```
public static Letter valueOf(java.lang.String name)
```
  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
  
  Parameters:
  
  name - the name of the enum constant to be returned.
  
  Returns:
  
  the enum constant with the specified name
  
  Throws:
  
  java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
  
  java.lang.NullPointerException - if the argument is null
- getLetter
```
public char getLetter()
```
- getMod
```
public int getMod()
```
- matches
```
public boolean matches(ImageLetter imageLetter)
```
- matches
```
public boolean matches(char letter,
                       int mod)
```
- getLetter
```
public static Letter getLetter(ImageLetter imageLetter)
```
- getLetter
```
public static Letter getLetter(char character,
                               int mod)
```
- toString
```
public java.lang.String toString()
```
  Overrides:
  
  toString in class java.lang.Enum<Letter>

Enum Letter

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

EXCLAMATION

EXCLAMATION_DOT

QUOTE_LEFT

QUOTE_RIGHT

HASHTAG

DOLLAR

PERCENT_BASE

PERCENT_LDOT

PERCENT_RDOT

AMPERSAND

APOSTROPHE

LEFT_PARENTHESE

RIGHT_PARENTHESE

ASTERISK

PLUS

COMMA

MINUS

PERIOD

FORWARD_SLASH

ZERO

ONE

TWO

THREE

FOUR

FIVE

SIX

SEVEN

EIGHT

NINE

COLON_TOP

COLON_BOTTOM

SEMICOLON_TOP

SEMICOLON_BOTTOM

LESS_THAN

EQUALS_TOP

EQUALS_BOTTOM

GREATER_THAN

QUESTION_MARK_TOP

QUESTION_MARK_BOTTOM

AT

A

B

C

D

E

F

G

H

I

J

K

L

M

N

O

P

Q

R

S

T

U

V

W

X

Y

Z

LEFT_SQUARE_BRACKET

BACKSLASH

RIGHT_SQUARE_BRACKET

CARROT

UNDERSCORE

GRAVE