ggencoder.datastructures
Class AbstractGameGenieCode

java.lang.Object
  extended byggencoder.datastructures.AbstractGameGenieCode
All Implemented Interfaces:
GameGenieCode
Direct Known Subclasses:
GBGGGameGenieCode, GenesisGameGenieCode

public abstract class AbstractGameGenieCode
extends java.lang.Object
implements GameGenieCode

An abstract implementation of the GameGenieCode interface.

Version:
1.4, 07/15/04
Author:
John David Ratliff

Field Summary
static char[] GBGG_ALPHABET
          Game Genie alphabet for GameBoy/GameGear codes.
static char[] GENESIS_ALPHABET
          Game Genie alphabet for Genesis codes.
static char[] NES_ALPHABET
          Game Genie alphabet for NES codes.
static char[] SNES_ALPHABET
          Game Genie alphabet for SNES codes.
 
Constructor Summary
AbstractGameGenieCode()
           
 
Method Summary
 java.lang.String getCode()
          Gets the code string.
static GameGenieCode parseGBGG(java.lang.String code)
          Parses a GameBoy/GameGear Game Genie code into a GameGenieCode object.
static GameGenieCode parseGenesis(java.lang.String code)
          Parses a Genesis Game Genie code into a GameGenieCode object.
static GameGenieCode parseNES(java.lang.String code)
          Parses an NES Game Genie code into a GameGenieCode object.
static GameGenieCode parseSNES(java.lang.String code)
          Parses an SNES Game Genie code into a GameGenieCode object.
 void setCode(java.lang.String code)
          Sets the code string.
 int toHex(char letter)
          Translates a game genie letter to hexadecimal.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface ggencoder.datastructures.GameGenieCode
getAlphabet
 

Field Detail

NES_ALPHABET

public static final char[] NES_ALPHABET
Game Genie alphabet for NES codes.


SNES_ALPHABET

public static final char[] SNES_ALPHABET
Game Genie alphabet for SNES codes.


GENESIS_ALPHABET

public static final char[] GENESIS_ALPHABET
Game Genie alphabet for Genesis codes.


GBGG_ALPHABET

public static final char[] GBGG_ALPHABET
Game Genie alphabet for GameBoy/GameGear codes.

Constructor Detail

AbstractGameGenieCode

public AbstractGameGenieCode()
Method Detail

parseNES

public static GameGenieCode parseNES(java.lang.String code)
                              throws InvalidGameGenieCodeException
Parses an NES Game Genie code into a GameGenieCode object.

Parameters:
code - The NES game genie code.
Returns:
The GameGenieCode object.
Throws:
InvalidGameGenieCodeException - if the code is not a valid NES game genie code.

parseSNES

public static GameGenieCode parseSNES(java.lang.String code)
                               throws InvalidGameGenieCodeException
Parses an SNES Game Genie code into a GameGenieCode object.

Parameters:
code - The SNES game genie code.
Returns:
The GameGenieCode object.
Throws:
InvalidGameGenieCodeException - if the code is not a valid SNES game genie code.

parseGenesis

public static GameGenieCode parseGenesis(java.lang.String code)
                                  throws InvalidGameGenieCodeException
Parses a Genesis Game Genie code into a GameGenieCode object.

Parameters:
code - The Genesis game genie code.
Returns:
The GameGenieCode object.
Throws:
InvalidGameGenieCodeException - if the code is not a valid Genesis game genie code.

parseGBGG

public static GameGenieCode parseGBGG(java.lang.String code)
                               throws InvalidGameGenieCodeException
Parses a GameBoy/GameGear Game Genie code into a GameGenieCode object.

Parameters:
code - The Genesis game genie code.
Returns:
The GameGenieCode object.
Throws:
InvalidGameGenieCodeException - if the code is not a valid GameBoy/GameGear game genie code.

getCode

public java.lang.String getCode()
Gets the code string.

Specified by:
getCode in interface GameGenieCode
Returns:
The code string.

setCode

public void setCode(java.lang.String code)
Sets the code string.

Specified by:
setCode in interface GameGenieCode
Parameters:
code - The new code string.

toHex

public int toHex(char letter)
          throws InvalidGameGenieLetterException
Translates a game genie letter to hexadecimal.

Specified by:
toHex in interface GameGenieCode
Parameters:
letter - The letter to translate.
Returns:
The hex value of the letter.
Throws:
InvalidGameGenieLetterException - if the letter is not part of the game genie alphabet.