loci.common

Class IniParser

java.lang.Object

loci.common.IniParser

public class IniParser
extends Object

A simple parser for INI configuration files. Supports pound (#) as comments, and backslash (\) to continue values across multiple lines.

Author:

Curtis Rueden ctrueden at wisc.edu

Field Summary

Fields

Modifier and Type	Field and Description
private String	commentDelimiter
private static org.slf4j.Logger	LOGGER Logger for this class.
private boolean	slashContinues

Constructor Summary

Constructors

Constructor and Description
IniParser()

Method Summary

Methods

Modifier and Type	Method and Description
private boolean	isHeader(String line, char start) Checks whether the input line is a INI header
static BufferedReader	openTextResource(String path) Opens a buffered reader for the given resource.
static BufferedReader	openTextResource(String path, Class<?> c) Opens a buffered reader for the given resource.
private String	parseHeader(String line, char start, char end) Parse a header line given input delimiters
IniList	parseINI(BufferedReader in) Parses the INI-style configuration data from the given input stream.
IniList	parseINI(File file) Parses the INI-style wrapping the given file in a BufferedReader
IniList	parseINI(String path) Parses the INI-style configuration data from the given resource.
IniList	parseINI(String path, Class<?> c) Parses the INI-style configuration data from the given resource, using the given class to find the resource.
private int	readLine(BufferedReader in, StringBuffer sb) Reads (at least) one line from the given input stream into the specified string buffer.
void	setBackslashContinuesLine(boolean slashContinues) Set whether or not a '\' at the end of a line signifies that the line continues on the following line.
void	setCommentDelimiter(String delimiter) Set the String that identifies a comment.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

Logger for this class.

commentDelimiter

private String commentDelimiter

slashContinues

private boolean slashContinues

Constructor Detail

IniParser

public IniParser()

Method Detail

setCommentDelimiter

public void setCommentDelimiter(String delimiter)

Set the String that identifies a comment. Defaults to "#".

setBackslashContinuesLine

public void setBackslashContinuesLine(boolean slashContinues)

Set whether or not a '\' at the end of a line signifies that the line continues on the following line. By default, a '\' does continue the line.

parseINI

public IniList parseINI(String path)
                 throws IOException

Parses the INI-style configuration data from the given resource.

Throws:

IOException

parseINI

public IniList parseINI(String path,
               Class<?> c)
                 throws IOException

Parses the INI-style configuration data from the given resource, using the given class to find the resource.

Throws:

IOException

parseINI

public IniList parseINI(File file)
                 throws IOException

Parses the INI-style wrapping the given file in a BufferedReader

Throws:

IOException

parseINI

public IniList parseINI(BufferedReader in)
                 throws IOException

Parses the INI-style configuration data from the given input stream.

Throws:

IOException

openTextResource

public static BufferedReader openTextResource(String path)

Opens a buffered reader for the given resource.

openTextResource

public static BufferedReader openTextResource(String path,
                              Class<?> c)

Opens a buffered reader for the given resource.

isHeader

private boolean isHeader(String line,
               char start)

Checks whether the input line is a INI header

parseHeader

private String parseHeader(String line,
                 char start,
                 char end)

Parse a header line given input delimiters

readLine

private int readLine(BufferedReader in,
           StringBuffer sb)
              throws IOException

Reads (at least) one line from the given input stream into the specified string buffer.

Returns:

number of lines read

Throws:

IOException