maps

Class MapReader

java.lang.Object

maps.MapReader

public final class MapReader
extends java.lang.Object

A utility class for reading maps.

Method Summary

Modifier and Type	Method and Description
static MapFormat	guessFormat(java.io.File file) Guess the format for a Map.
static Map	readMap(java.io.File file) Read a Map from a file and guess the format.
static Map	readMap(java.io.File file, MapFormat format) Read a Map from a file using a particular format.
static Map	readMap(java.lang.String file) Read a Map from a file and guess the format.
static Map	readMap(java.lang.String file, MapFormat format) Read a Map from a file using a particular format.

Methods inherited from class java.lang.Object

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

Method Detail

readMap

public static Map readMap(java.lang.String file)
                   throws MapException

Read a Map from a file and guess the format.

Parameters:

file - The name of the file to read.

Returns:

A Map.

Throws:

MapException - If there is a problem reading the map.

readMap

public static Map readMap(java.lang.String file,
                          MapFormat format)
                   throws MapException

Read a Map from a file using a particular format.

Parameters:

file - The name of the file to read.

format - The format to use. If this is null then the format will be guessed.

Returns:

A Map.

Throws:

MapException - If there is a problem reading the map.

readMap

public static Map readMap(java.io.File file)
                   throws MapException

Read a Map from a file and guess the format.

Parameters:

file - The file to read.

Returns:

A Map.

Throws:

MapException - If there is a problem reading the map.

readMap

public static Map readMap(java.io.File file,
                          MapFormat format)
                   throws MapException

Read a Map from a file using a particular format.

Parameters:

file - The file to read.

format - The format to use. If this is null then the format will be guessed.

Returns:

A Map.

Throws:

MapException - If there is a problem reading the map.

guessFormat

public static MapFormat guessFormat(java.io.File file)
                             throws MapException

Guess the format for a Map.

Parameters:

file - The file to guess the format of.

Returns:

The most likely format or null if the file type is unrecognised.

Throws:

MapException - If there is a problem reading the file.