org.projectnyx.config

Class ConfigParser

java.lang.Object

org.projectnyx.config.ConfigParser

public class ConfigParser
extends Object

The class for parsing a Nyx-style XML config file.

Constructor Summary

Constructors

Constructor and Description
ConfigParser(File file) Creates a parser on a Nyx-style XML config file.
ConfigParser(InputStream is) Creates a parser that reads a Nyx-style XML config from an InputStream
ConfigParser(Reader reader) Creates a parser that reads a Nyx-style XML config from a Reader

Method Summary

Modifier and Type	Method and Description
static Class<? extends ConfigElement>	computeClassName(String name, String packageContext)
String	getPackageContext()
ConfigElement	parse() Parses the config and returns the config root.
ConfigParser	setPackageContext(String packageContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigParser

public ConfigParser(File file)
             throws IOException

Creates a parser on a Nyx-style XML config file.

Parameters:

file - The file to read contents from

Throws:

IOException - if the file cannot be opened for reading

ConfigParser

public ConfigParser(InputStream is)

Creates a parser that reads a Nyx-style XML config from an InputStream

Parameters:

is - The stream to read config from

ConfigParser

public ConfigParser(Reader reader)

Creates a parser that reads a Nyx-style XML config from a Reader

Parameters:

reader - The reader to read config from

Method Detail

parse

public ConfigElement parse()
                    throws NumberFormatException,
                           IOException

Parses the config and returns the config root.

Returns:

the root config element that this config holds

Throws:

NumberFormatException - if any config formatting errors are encountered, or if a config entry has a mismatched type (e.g. a supposedly integer field is not a number)

IOException - if an I/O error occurs

See Also:

org.projectnyx.config

computeClassName

public static Class<? extends ConfigElement> computeClassName(String name,
                                                              String packageContext)

getPackageContext

public String getPackageContext()

setPackageContext

public ConfigParser setPackageContext(String packageContext)