inf112.fiasko.roborally.utility

Class BoardLoaderUtil

java.lang.Object

inf112.fiasko.roborally.utility.BoardLoaderUtil

public final class BoardLoaderUtil
extends java.lang.Object

This class helps loading boards

Method Summary

Modifier and Type	Method and Description
static java.lang.String[]	getBoardListHumanReadable() Gets a list of all available boards with human-readable names
static java.lang.String	getRealBoardName(java.lang.String boardName) Gets the actual file name of a board given its human-readable name
static Board	loadBoard(java.lang.String boardFile, java.util.List<Robot> robotList) Loads a board described in a file

Methods inherited from class java.lang.Object

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

Method Detail

getRealBoardName

public static java.lang.String getRealBoardName(java.lang.String boardName)

Gets the actual file name of a board given its human-readable name

Parameters:

boardName - The human-readable name of a board

Returns:

The file name of the board

getBoardListHumanReadable

public static java.lang.String[] getBoardListHumanReadable()
                                                    throws java.io.IOException

Gets a list of all available boards with human-readable names

Returns:

A list of all available boards

Throws:

java.io.IOException - If the board list cannot be read

loadBoard

public static Board loadBoard(java.lang.String boardFile,
                              java.util.List<Robot> robotList)
                       throws java.io.IOException

Loads a board described in a file

Parameters:

boardFile - The file containing the board description

robotList - A list of robots on the board

Returns:

A board

Throws:

java.io.IOException - If the board file cannot be loaded