org.mariuszgromada.math.janetsudoku

Class ErrorCodes

java.lang.Object

org.mariuszgromada.math.janetsudoku.ErrorCodes

public final class ErrorCodes
extends Object

Error codes definition for Janet-Sudoku. The code convention is as follows:
Errors.[CLASS]_[METHOD]_[ERROR_TYPE]

Version:

1.0.0

Author:

Mariusz Gromada
mariuszgromada.org@gmail.com
Janet Sudoku - project web page
MathSpace.pl
MathParser.org - mXparser project page
Janet Sudoku on GitHub
Janet Sudoku on CodePlex
Janet Sudoku on SourceForge
Janet Sudoku on BitBucket
mXparser-MathParser.org on GitHub

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_CODE_UNKNOWN_MSG Error code unknown
static int	SUDOKUSOLVER_BOARD_ERROR Board contains an error.
static String	SUDOKUSOLVER_BOARD_ERROR_MSG Board contains an error.
static int	SUDOKUSOLVER_CHECKIFUNIQUESOLUTION_CHECKING_NOT_STARTED Finding all Sudoku solutions requested, but not started.
static String	SUDOKUSOLVER_CHECKIFUNIQUESOLUTION_CHECKING_NOT_STARTED_MSG Finding all Sudoku solutions requested, but not started.
static int	SUDOKUSOLVER_FINDALLSOLUTIONS_SEARCHING_NOT_STARTED Finding all Sudoku solutions requested, but not started.
static String	SUDOKUSOLVER_FINDALLSOLUTIONS_SEARCHING_NOT_STARTED_MSG Finding all Sudoku solutions requested, but not started.
static int	SUDOKUSOLVER_GETCELLDIGIT_INCORRECT_INDEX Incorrect cell definition while calling getCell method (incorrect index).
static String	SUDOKUSOLVER_GETCELLDIGIT_INCORRECT_INDEX_MSG Incorrect cell definition while calling getCell method (incorrect index).
static int	SUDOKUSOLVER_LOADBOARD_LOADING_FAILED Sudoku board loading failed.
static String	SUDOKUSOLVER_LOADBOARD_LOADING_FAILED_MSG Sudoku board loading failed.
static int	SUDOKUSOLVER_SETCELL_INCORRECT_DEFINITION Incorrect cell definition while calling setCell method (incorrect index or incorrect digit).
static String	SUDOKUSOLVER_SETCELL_INCORRECT_DEFINITION_MSG Incorrect cell definition while calling setCell method (incorrect index or incorrect digit).
static int	SUDOKUSOLVER_SOLVE_SOLVING_FAILED Sudoku solving requested, but falied.
static String	SUDOKUSOLVER_SOLVE_SOLVING_FAILED_MSG Sudoku solving requested, but falied.
static int	SUDOKUSOLVER_SOLVE_SOLVING_NOT_STARTED Sudoku solving requested, but not started.
static String	SUDOKUSOLVER_SOLVE_SOLVING_NOT_STARTED_MSG Sudoku solving requested, but not started.
static int	SUDOKUSTORE_BOARDSEGMENTSTARTINDEX_INCORRECT_SEGMENT Incorrect segment index while calling SudokuStore.boardSegmentStartIndex(int)
static String	SUDOKUSTORE_BOARDSEGMENTSTARTINDEX_INCORRECT_SEGMENT_MSG Incorrect segment index while calling SudokuStore.boardSegmentStartIndex(int)
static int	SUDOKUSTORE_CALCULATEPUZZLERATING_NO_SOLUTION Puzzle solution does not exist.
static String	SUDOKUSTORE_CALCULATEPUZZLERATING_NO_SOLUTION_MSG Puzzle solution does not exist.
static int	SUDOKUSTORE_CALCULATEPUZZLERATING_NON_UNIQUE_SOLUTION Puzzle has non-unique solution.
static String	SUDOKUSTORE_CALCULATEPUZZLERATING_NON_UNIQUE_SOLUTION_MSG Puzzle has non-unique solution.
static int	SUDOKUSTORE_CALCULATEPUZZLERATING_PUZZLE_ERROR Obvious puzzle error.
static String	SUDOKUSTORE_CALCULATEPUZZLERATING_PUZZLE_ERROR_MSG Puzzle contains obvious puzzle error.
static int	SUDOKUSTORE_CALCULATEPUZZLERATING_THREADS_JOIN_FAILED Threads join failed.
static String	SUDOKUSTORE_CALCULATEPUZZLERATING_THREADS_JOIN_FAILED_MSG Threads join failed.
static int	SUDOKUSTORE_RANDOMINDEX_INCORRECT_PARAMETER Negative or zero parameter while calling SudokuStore.randomIndex(int)
static String	SUDOKUSTORE_RANDOMINDEX_INCORRECT_PARAMETER_MSG Negative or zero parameter while calling SudokuStore.randomIndex(int)
static int	SUDOKUSTORE_RANDOMNUMBER_INCORRECT_PARAMETER Negative or zero parameter while calling SudokuStore.randomNumber(int)
static String	SUDOKUSTORE_RANDOMNUMBER_INCORRECT_PARAMETER_MSG Negative or zero parameter while calling SudokuStore.randomNumber(int)

Constructor Summary

Constructors

Constructor and Description
ErrorCodes()

Method Summary

Methods

Modifier and Type	Method and Description
static void	consolePrintlnIfError(int errorCode)
static boolean	errorCodeExists(int errorCode) Checks whether error code exists.
static String	getErrorDescription(int errorCode) Return error code description.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUDOKUSOLVER_LOADBOARD_LOADING_FAILED

public static final int SUDOKUSOLVER_LOADBOARD_LOADING_FAILED

Sudoku board loading failed.

See Also:

SudokuSolver, #see SudokuSolver#loadBoard(int[][]), SudokuSolver.loadBoard(String), Constant Field Values

SUDOKUSOLVER_SOLVE_SOLVING_NOT_STARTED

public static final int SUDOKUSOLVER_SOLVE_SOLVING_NOT_STARTED

Sudoku solving requested, but not started.

See Also:

SudokuSolver, SudokuSolver.solve(), Constant Field Values

SUDOKUSOLVER_SOLVE_SOLVING_FAILED

public static final int SUDOKUSOLVER_SOLVE_SOLVING_FAILED

Sudoku solving requested, but falied.

See Also:

SudokuSolver, SudokuSolver.solve(), Constant Field Values

SUDOKUSOLVER_FINDALLSOLUTIONS_SEARCHING_NOT_STARTED

public static final int SUDOKUSOLVER_FINDALLSOLUTIONS_SEARCHING_NOT_STARTED

Finding all Sudoku solutions requested, but not started.

See Also:

SudokuSolver, SudokuSolver.findAllSolutions(), Constant Field Values

SUDOKUSOLVER_CHECKIFUNIQUESOLUTION_CHECKING_NOT_STARTED

public static final int SUDOKUSOLVER_CHECKIFUNIQUESOLUTION_CHECKING_NOT_STARTED

Finding all Sudoku solutions requested, but not started.

See Also:

SudokuSolver, SudokuSolver.findAllSolutions(), Constant Field Values

SUDOKUSOLVER_SETCELL_INCORRECT_DEFINITION

public static final int SUDOKUSOLVER_SETCELL_INCORRECT_DEFINITION

Incorrect cell definition while calling setCell method (incorrect index or incorrect digit).

See Also:

SudokuSolver, SudokuSolver.setCell(int, int, int), Constant Field Values

SUDOKUSOLVER_GETCELLDIGIT_INCORRECT_INDEX

public static final int SUDOKUSOLVER_GETCELLDIGIT_INCORRECT_INDEX

Incorrect cell definition while calling getCell method (incorrect index).

See Also:

SudokuSolver, SudokuSolver.getCellDigit(int, int), Constant Field Values

SUDOKUSTORE_BOARDSEGMENTSTARTINDEX_INCORRECT_SEGMENT

public static final int SUDOKUSTORE_BOARDSEGMENTSTARTINDEX_INCORRECT_SEGMENT

Incorrect segment index while calling SudokuStore.boardSegmentStartIndex(int)

See Also:

SudokuStore, SudokuStore.boardSegmentStartIndex(int), Constant Field Values

SUDOKUSTORE_RANDOMINDEX_INCORRECT_PARAMETER

public static final int SUDOKUSTORE_RANDOMINDEX_INCORRECT_PARAMETER

Negative or zero parameter while calling SudokuStore.randomIndex(int)

See Also:

SudokuStore, SudokuStore.randomIndex(int), Constant Field Values

SUDOKUSTORE_RANDOMNUMBER_INCORRECT_PARAMETER

public static final int SUDOKUSTORE_RANDOMNUMBER_INCORRECT_PARAMETER

Negative or zero parameter while calling SudokuStore.randomNumber(int)

See Also:

SudokuStore, SudokuStore.randomNumber(int), Constant Field Values

SUDOKUSOLVER_BOARD_ERROR

public static final int SUDOKUSOLVER_BOARD_ERROR

Board contains an error.

See Also:

SudokuSolver, Constant Field Values

SUDOKUSTORE_CALCULATEPUZZLERATING_PUZZLE_ERROR

public static final int SUDOKUSTORE_CALCULATEPUZZLERATING_PUZZLE_ERROR

Obvious puzzle error.

See Also:

SudokuStore, SudokuStore.calculatePuzzleRating(int[][]), Constant Field Values

SUDOKUSTORE_CALCULATEPUZZLERATING_NO_SOLUTION

public static final int SUDOKUSTORE_CALCULATEPUZZLERATING_NO_SOLUTION

Puzzle solution does not exist.

See Also:

SudokuStore, SudokuStore.calculatePuzzleRating(int[][]), Constant Field Values

SUDOKUSTORE_CALCULATEPUZZLERATING_NON_UNIQUE_SOLUTION

public static final int SUDOKUSTORE_CALCULATEPUZZLERATING_NON_UNIQUE_SOLUTION

Puzzle has non-unique solution.

See Also:

SudokuStore, SudokuStore.calculatePuzzleRating(int[][]), Constant Field Values

SUDOKUSTORE_CALCULATEPUZZLERATING_THREADS_JOIN_FAILED

public static final int SUDOKUSTORE_CALCULATEPUZZLERATING_THREADS_JOIN_FAILED

Threads join failed.

See Also:

SudokuStore, SudokuStore.calculatePuzzleRating(int[][]), Constant Field Values

SUDOKUSOLVER_LOADBOARD_LOADING_FAILED_MSG

public static final String SUDOKUSOLVER_LOADBOARD_LOADING_FAILED_MSG

Sudoku board loading failed.

See Also:

SudokuSolver, SudokuSolver.loadBoard(int), SudokuSolver.loadBoard(int[][]), SudokuSolver.loadBoard(String), Constant Field Values

SUDOKUSOLVER_SOLVE_SOLVING_NOT_STARTED_MSG

public static final String SUDOKUSOLVER_SOLVE_SOLVING_NOT_STARTED_MSG

Sudoku solving requested, but not started.

See Also:

SudokuSolver, SudokuSolver.solve(), Constant Field Values

SUDOKUSOLVER_SOLVE_SOLVING_FAILED_MSG

public static final String SUDOKUSOLVER_SOLVE_SOLVING_FAILED_MSG

Sudoku solving requested, but falied.

See Also:

SudokuSolver, SudokuSolver.solve(), Constant Field Values

SUDOKUSOLVER_FINDALLSOLUTIONS_SEARCHING_NOT_STARTED_MSG

public static final String SUDOKUSOLVER_FINDALLSOLUTIONS_SEARCHING_NOT_STARTED_MSG

Finding all Sudoku solutions requested, but not started.

See Also:

SudokuSolver, SudokuSolver.findAllSolutions(), Constant Field Values

SUDOKUSOLVER_CHECKIFUNIQUESOLUTION_CHECKING_NOT_STARTED_MSG

public static final String SUDOKUSOLVER_CHECKIFUNIQUESOLUTION_CHECKING_NOT_STARTED_MSG

Finding all Sudoku solutions requested, but not started.

See Also:

SudokuSolver, SudokuSolver.findAllSolutions(), Constant Field Values

SUDOKUSOLVER_SETCELL_INCORRECT_DEFINITION_MSG

public static final String SUDOKUSOLVER_SETCELL_INCORRECT_DEFINITION_MSG

Incorrect cell definition while calling setCell method (incorrect index or incorrect digit).

See Also:

SudokuSolver, SudokuSolver.setCell(int, int, int), Constant Field Values

SUDOKUSOLVER_GETCELLDIGIT_INCORRECT_INDEX_MSG

public static final String SUDOKUSOLVER_GETCELLDIGIT_INCORRECT_INDEX_MSG

Incorrect cell definition while calling getCell method (incorrect index).

See Also:

SudokuSolver, SudokuSolver.getCellDigit(int, int), Constant Field Values

SUDOKUSTORE_BOARDSEGMENTSTARTINDEX_INCORRECT_SEGMENT_MSG

public static final String SUDOKUSTORE_BOARDSEGMENTSTARTINDEX_INCORRECT_SEGMENT_MSG

Incorrect segment index while calling SudokuStore.boardSegmentStartIndex(int)

See Also:

SudokuStore, SudokuStore.boardSegmentStartIndex(int), Constant Field Values

SUDOKUSTORE_RANDOMINDEX_INCORRECT_PARAMETER_MSG

public static final String SUDOKUSTORE_RANDOMINDEX_INCORRECT_PARAMETER_MSG

Negative or zero parameter while calling SudokuStore.randomIndex(int)

See Also:

SudokuStore, SudokuStore.randomIndex(int), Constant Field Values

SUDOKUSTORE_RANDOMNUMBER_INCORRECT_PARAMETER_MSG

public static final String SUDOKUSTORE_RANDOMNUMBER_INCORRECT_PARAMETER_MSG

Negative or zero parameter while calling SudokuStore.randomNumber(int)

See Also:

SudokuStore, SudokuStore.randomNumber(int), Constant Field Values

SUDOKUSOLVER_BOARD_ERROR_MSG

public static final String SUDOKUSOLVER_BOARD_ERROR_MSG

Board contains an error.

See Also:

SudokuSolver, Constant Field Values

SUDOKUSTORE_CALCULATEPUZZLERATING_PUZZLE_ERROR_MSG

public static final String SUDOKUSTORE_CALCULATEPUZZLERATING_PUZZLE_ERROR_MSG

Puzzle contains obvious puzzle error.

See Also:

SudokuStore, SudokuStore.calculatePuzzleRating(int[][]), Constant Field Values

SUDOKUSTORE_CALCULATEPUZZLERATING_NO_SOLUTION_MSG

public static final String SUDOKUSTORE_CALCULATEPUZZLERATING_NO_SOLUTION_MSG

Puzzle solution does not exist.

See Also:

SudokuStore, SudokuStore.calculatePuzzleRating(int[][]), Constant Field Values

SUDOKUSTORE_CALCULATEPUZZLERATING_NON_UNIQUE_SOLUTION_MSG

public static final String SUDOKUSTORE_CALCULATEPUZZLERATING_NON_UNIQUE_SOLUTION_MSG

Puzzle has non-unique solution.

See Also:

SudokuStore, SudokuStore.calculatePuzzleRating(int[][]), Constant Field Values

SUDOKUSTORE_CALCULATEPUZZLERATING_THREADS_JOIN_FAILED_MSG

public static final String SUDOKUSTORE_CALCULATEPUZZLERATING_THREADS_JOIN_FAILED_MSG

Threads join failed.

See Also:

SudokuStore, SudokuStore.calculatePuzzleRating(int[][]), Constant Field Values

ERROR_CODE_UNKNOWN_MSG

public static final String ERROR_CODE_UNKNOWN_MSG

Error code unknown

See Also:

getErrorDescription(int), Constant Field Values

Constructor Detail

ErrorCodes

public ErrorCodes()

Method Detail

getErrorDescription

public static final String getErrorDescription(int errorCode)

Return error code description.

Parameters:

errorCode - Error code

Returns:

Error code description if error code known, otherwise ERROR_CODE_UNKNOWN_MSG.

errorCodeExists

public static final boolean errorCodeExists(int errorCode)

Checks whether error code exists.

Parameters:

errorCode - Error code

Returns:

True if error code exists, otherwise false.

consolePrintlnIfError

public static final void consolePrintlnIfError(int errorCode)