RomanNumeralSymbol (com.hfg API Documentation)

java.lang.Object
- com.hfg.math.RomanNumeralSymbol

All Implemented Interfaces:

Comparable<RomanNumeralSymbol>
```
public class RomanNumeralSymbol
extends Object
implements Comparable<RomanNumeralSymbol>
```
Individual Roman numeral symbol representation. Used by the RomanNumeral class, it encapsulates the logic of which symbols can precede a given symbol.
See http://en.wikipedia.org/wiki/Roman_numerals

Field Summary

Fields
Modifier and Type	Field and Description
`static RomanNumeralSymbol`	`C` The Roman numeral for the integer 100.
`static RomanNumeralSymbol`	`D` The Roman numeral for the integer 500.
`static RomanNumeralSymbol`	`I` The Roman numeral for the integer 1.
`static RomanNumeralSymbol`	`L` The Roman numeral for the integer 50.
`static RomanNumeralSymbol`	`M` The Roman numeral for the integer 1000.
`static RomanNumeralSymbol`	`V` The Roman numeral for the integer 5.
`static RomanNumeralSymbol`	`X` The Roman numeral for the integer 10.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canPrecede(RomanNumeralSymbol inSymbol)` Returns whether this symbol can legally precede the specified symbol given the subtractive principle.
`int`	`compareTo(RomanNumeralSymbol inObj)` Numerically compares two RomanNumeralSymbol objects.
`int`	`getIntValue()` Returns the integer value of the Roman numeral symbol.
`char`	`getLetter()` Returns the character value of the Roman numeral symbol.
`String`	`toString()` Returns the Roman numeral string value of the Roman numeral symbol.
`static RomanNumeralSymbol`	`valueOf(char inLetter)` Returns the RomanNumeralSymbol value for the specified character.
`static RomanNumeralSymbol[]`	`values()` Returns an array of all the RomanNumeralSymbol values.

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

- Field Detail
  - I
```
public static RomanNumeralSymbol I
```
    The Roman numeral for the integer 1.
  - V
```
public static RomanNumeralSymbol V
```
    The Roman numeral for the integer 5.
  - X
```
public static RomanNumeralSymbol X
```
    The Roman numeral for the integer 10.
  - L
```
public static RomanNumeralSymbol L
```
    The Roman numeral for the integer 50.
  - C
```
public static RomanNumeralSymbol C
```
    The Roman numeral for the integer 100.
  - D
```
public static RomanNumeralSymbol D
```
    The Roman numeral for the integer 500.
  - M
```
public static RomanNumeralSymbol M
```
    The Roman numeral for the integer 1000.
- Method Detail
  - valueOf
```
public static RomanNumeralSymbol valueOf(char inLetter)
```
    Returns the RomanNumeralSymbol value for the specified character.
  - values
```
public static RomanNumeralSymbol[] values()
```
    Returns an array of all the RomanNumeralSymbol values.
  - getLetter
```
public char getLetter()
```
    Returns the character value of the Roman numeral symbol.
  - getIntValue
```
public int getIntValue()
```
    Returns the integer value of the Roman numeral symbol.
  - toString
```
public String toString()
```
    Returns the Roman numeral string value of the Roman numeral symbol.
    
    Overrides:
    
    toString in class Object
  - compareTo
```
public int compareTo(RomanNumeralSymbol inObj)
```
    Numerically compares two RomanNumeralSymbol objects.
    
    Specified by:
    
    compareTo in interface Comparable<RomanNumeralSymbol>
  - canPrecede
```
public boolean canPrecede(RomanNumeralSymbol inSymbol)
```
    Returns whether this symbol can legally precede the specified symbol given the subtractive principle.

Class RomanNumeralSymbol

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

I

V

X

L

C

D

M

Method Detail

valueOf

values

getLetter

getIntValue

toString

compareTo

canPrecede