ca.szc.configparser

Class Ini

java.lang.Object

ca.szc.configparser.Ini

public class Ini
extends Object

A Python-compatible Java INI parser

Constructor Summary

Constructors

Constructor and Description
Ini() Creates an INI parser with the default configuration

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getCommentPrefixes()
List<String>	getDelimiters()
List<String>	getInlineCommentPrefixes()
Map<String,Map<String,String>>	getSections()
String	getValue(String sectionName, String optionName)
String	getValue(String sectionName, String optionName, String fallback)
boolean	isAllowDuplicates()
boolean	isAllowInterpolation()
boolean	isAllowNoValue()
boolean	isEmptyLinesInValues()
boolean	isSpaceAroundDelimiters()
Ini	read(BufferedReader reader) Parse INI text
Ini	read(Path iniPath) Parse an INI file with the default Charset
Ini	read(Path iniPath, Charset charset) Parse an INI file with a specified Charset
Ini	setAllowDuplicates(boolean allowDuplicates) Set if duplicate sections and options will be accepted, or throw a IniParserException at read(BufferedReader) time.
Ini	setAllowInterpolation(boolean allowInterpolation) Set if interpolation of values should be performed.
Ini	setAllowNoValue(boolean allowNoValue) Set if option keys with no values will be accepted, or throw a IniParserException at read(BufferedReader) time.
Ini	setCommentPrefixes(List<String> commentPrefixes) Set which Strings should start full comment lines.
Ini	setDelimiters(List<String> delimiters) Set which Strings should divide option keys from values
Ini	setEmptyLinesInValues(boolean emptyLinesInValues) Set if empty lines should be considered to be a part of the latest option's value or not.
Ini	setInlineCommentPrefixes(List<String> inlineCommentPrefixes) Set which Strings should divide data from comments on non-blank lines
Ini	setSpaceAroundDelimiters(boolean spaceAroundDelimiters) Set if spaces should be placed around option key/value delimiters when writing
Ini	write(BufferedWriter writer) Write INI formatted text
Ini	write(Path iniPath) Write an INI file with the default Charset
Ini	write(Path iniPath, Charset charset) Write an INI file with a specified Charset

Methods inherited from class java.lang.Object

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

Constructor Detail

Ini

public Ini()

Creates an INI parser with the default configuration

Method Detail

getCommentPrefixes

public List<String> getCommentPrefixes()

getDelimiters

public List<String> getDelimiters()

getInlineCommentPrefixes

public List<String> getInlineCommentPrefixes()

getSections

public Map<String,Map<String,String>> getSections()

getValue

public String getValue(String sectionName,
              String optionName)
                throws NoSectionError,
                       NoOptionError

Throws:

NoSectionError

NoOptionError

getValue

public String getValue(String sectionName,
              String optionName,
              String fallback)
                throws NoSectionError,
                       NoOptionError

Throws:

NoSectionError

NoOptionError

isAllowDuplicates

public boolean isAllowDuplicates()

isAllowInterpolation

public boolean isAllowInterpolation()

isAllowNoValue

public boolean isAllowNoValue()

isEmptyLinesInValues

public boolean isEmptyLinesInValues()

isSpaceAroundDelimiters

public boolean isSpaceAroundDelimiters()

read

public Ini read(BufferedReader reader)
         throws IOException,
                IniParserException

Parse INI text

Parameters:

reader - the BufferedReader to read the INI text from

Returns:

this Ini

Throws:

IOException - When errors are encountered while reading from reader

IniParserException - When the INI text read is invalid in some way.

read

public Ini read(Path iniPath)
         throws IOException,
                IniParserException

Parse an INI file with the default Charset

Parameters:

iniPath - The Path pointing the the INI file to read

Returns:

this Ini

Throws:

IOException - When errors are encountered while reading from reader

IniParserException - When the INI text read is invalid in some way.

See Also:

StandardCharsets.UTF_8

read

public Ini read(Path iniPath,
       Charset charset)
         throws IOException,
                IniParserException

Parse an INI file with a specified Charset

Parameters:

iniPath - The Path pointing the the INI file to read

charset - The Charset to use when reading the file

Returns:

this Ini

Throws:

IOException - When errors are encountered while reading from reader

IniParserException - When the INI text read is invalid in some way.

See Also:

StandardCharsets

setAllowDuplicates

public Ini setAllowDuplicates(boolean allowDuplicates)

Set if duplicate sections and options will be accepted, or throw a IniParserException at read(BufferedReader) time.

Parameters:

allowDuplicates - duplicates are accepted iff true

Returns:

this Ini

setAllowInterpolation

public Ini setAllowInterpolation(boolean allowInterpolation)

Set if interpolation of values should be performed. Values containing the string "${section:option}" will be substituted for the value of the given option in the given section. Errors encountered parsing interpolations will result in a IniParserException being thrown at read(BufferedReader) time.

Parameters:

allowInterpolation - values will be interpolated iff true

Returns:

this Ini

setAllowNoValue

public Ini setAllowNoValue(boolean allowNoValue)

Set if option keys with no values will be accepted, or throw a IniParserException at read(BufferedReader) time.

Parameters:

allowNoValue - no value options are accepted iff true

Returns:

this Ini

setCommentPrefixes

public Ini setCommentPrefixes(List<String> commentPrefixes)

Set which Strings should start full comment lines.

Parameters:

commentPrefixes - the full line comment prefixes

Returns:

this Ini

setDelimiters

public Ini setDelimiters(List<String> delimiters)

Set which Strings should divide option keys from values

Parameters:

delimiters - the key/value delimiters

Returns:

this Ini

setEmptyLinesInValues

public Ini setEmptyLinesInValues(boolean emptyLinesInValues)

Set if empty lines should be considered to be a part of the latest option's value or not. Can cause IniParserException to be thrown in some cases when false

Parameters:

emptyLinesInValues - empty lines are added to option values iff true

Returns:

this Ini

setInlineCommentPrefixes

public Ini setInlineCommentPrefixes(List<String> inlineCommentPrefixes)

Set which Strings should divide data from comments on non-blank lines

Parameters:

inlineCommentPrefixes - the partial line comment prefixes

Returns:

this Ini

setSpaceAroundDelimiters

public Ini setSpaceAroundDelimiters(boolean spaceAroundDelimiters)

Set if spaces should be placed around option key/value delimiters when writing

Parameters:

spaceAroundDelimiters - place spaces around key/value delimiters iff true

Returns:

this Ini

write

public Ini write(BufferedWriter writer)
          throws IOException

Write INI formatted text

Parameters:

writer - the BufferedWriter to write the INI text to

Returns:

this Ini

Throws:

IOException - When errors are encountered while writing to the writer

write

public Ini write(Path iniPath)
          throws IOException

Write an INI file with the default Charset

Parameters:

iniPath - The Path pointing the the INI file to write

Returns:

this Ini

Throws:

IOException - When errors are encountered while writing to the writer

See Also:

StandardCharsets.UTF_8

write

public Ini write(Path iniPath,
        Charset charset)
          throws IOException

Write an INI file with a specified Charset

Parameters:

iniPath - The Path pointing the the INI file to write

charset - The Charset to use when writing the file

Returns:

this Ini

Throws:

IOException - When errors are encountered while writing to the writer

See Also:

StandardCharsets