Package org.ini4j

Class ConfigParser

java.lang.Object

org.ini4j.ConfigParser

All Implemented Interfaces:

java.io.Serializable

public class ConfigParser
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConfigParser.ConfigParserException
static class	ConfigParser.DuplicateSectionException
static class	ConfigParser.InterpolationException
static class	ConfigParser.InterpolationMissingOptionException
static class	ConfigParser.NoOptionException
static class	ConfigParser.NoSectionException
static class	ConfigParser.ParsingException

Constructor Summary

Constructors

Constructor	Description
ConfigParser()
ConfigParser(java.util.Map<java.lang.String,java.lang.String> defaults)

Method Summary

Modifier and Type	Method	Description
void	addSection(java.lang.String section)
java.util.Map<java.lang.String,java.lang.String>	defaults()
java.lang.String	get(java.lang.String section, java.lang.String option)
java.lang.String	get(java.lang.String section, java.lang.String option, boolean raw)
java.lang.String	get(java.lang.String sectionName, java.lang.String optionName, boolean raw, java.util.Map<java.lang.String,java.lang.String> variables)
boolean	getBoolean(java.lang.String section, java.lang.String option)
double	getDouble(java.lang.String section, java.lang.String option)
float	getFloat(java.lang.String section, java.lang.String option)
protected Ini	getIni()
int	getInt(java.lang.String section, java.lang.String option)
long	getLong(java.lang.String section, java.lang.String option)
boolean	hasOption(java.lang.String sectionName, java.lang.String optionName)
boolean	hasSection(java.lang.String sectionName)
java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>>	items(java.lang.String sectionName)
java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>>	items(java.lang.String sectionName, boolean raw)
java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>>	items(java.lang.String sectionName, boolean raw, java.util.Map<java.lang.String,java.lang.String> variables)
java.util.List<java.lang.String>	options(java.lang.String sectionName)
void	read(java.io.File file)
void	read(java.io.InputStream stream)
void	read(java.io.Reader reader)
void	read(java.lang.String... filenames)
void	read(java.net.URL url)
boolean	removeOption(java.lang.String sectionName, java.lang.String optionName)
boolean	removeSection(java.lang.String sectionName)
java.util.List<java.lang.String>	sections()
void	set(java.lang.String sectionName, java.lang.String optionName, java.lang.Object value)
void	write(java.io.File file)
void	write(java.io.OutputStream stream)
void	write(java.io.Writer writer)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigParser

public ConfigParser()

ConfigParser

public ConfigParser(java.util.Map<java.lang.String,java.lang.String> defaults)

Method Detail

getBoolean

public boolean getBoolean(java.lang.String section,
                          java.lang.String option)
                   throws ConfigParser.NoSectionException,
                          ConfigParser.NoOptionException,
                          ConfigParser.InterpolationException

Throws:

ConfigParser.NoSectionException

ConfigParser.NoOptionException

ConfigParser.InterpolationException

getDouble

public double getDouble(java.lang.String section,
                        java.lang.String option)
                 throws ConfigParser.NoSectionException,
                        ConfigParser.NoOptionException,
                        ConfigParser.InterpolationException

Throws:

ConfigParser.NoSectionException

ConfigParser.NoOptionException

ConfigParser.InterpolationException

getFloat

public float getFloat(java.lang.String section,
                      java.lang.String option)
               throws ConfigParser.NoSectionException,
                      ConfigParser.NoOptionException,
                      ConfigParser.InterpolationException

Throws:

ConfigParser.NoSectionException

ConfigParser.NoOptionException

ConfigParser.InterpolationException

getInt

public int getInt(java.lang.String section,
                  java.lang.String option)
           throws ConfigParser.NoSectionException,
                  ConfigParser.NoOptionException,
                  ConfigParser.InterpolationException

Throws:

ConfigParser.NoSectionException

ConfigParser.NoOptionException

ConfigParser.InterpolationException

getLong

public long getLong(java.lang.String section,
                    java.lang.String option)
             throws ConfigParser.NoSectionException,
                    ConfigParser.NoOptionException,
                    ConfigParser.InterpolationException

Throws:

ConfigParser.NoSectionException

ConfigParser.NoOptionException

ConfigParser.InterpolationException

addSection

public void addSection(java.lang.String section)
                throws ConfigParser.DuplicateSectionException

Throws:

ConfigParser.DuplicateSectionException

defaults

public java.util.Map<java.lang.String,java.lang.String> defaults()

get

public java.lang.String get(java.lang.String section,
                            java.lang.String option)
                     throws ConfigParser.NoSectionException,
                            ConfigParser.NoOptionException,
                            ConfigParser.InterpolationException

Throws:

ConfigParser.NoSectionException

ConfigParser.NoOptionException

ConfigParser.InterpolationException

get

public java.lang.String get(java.lang.String section,
                            java.lang.String option,
                            boolean raw)
                     throws ConfigParser.NoSectionException,
                            ConfigParser.NoOptionException,
                            ConfigParser.InterpolationException

Throws:

ConfigParser.NoSectionException

ConfigParser.NoOptionException

ConfigParser.InterpolationException

get

public java.lang.String get(java.lang.String sectionName,
                            java.lang.String optionName,
                            boolean raw,
                            java.util.Map<java.lang.String,java.lang.String> variables)
                     throws ConfigParser.NoSectionException,
                            ConfigParser.NoOptionException,
                            ConfigParser.InterpolationException

Throws:

ConfigParser.NoSectionException

ConfigParser.NoOptionException

ConfigParser.InterpolationException

hasOption

public boolean hasOption(java.lang.String sectionName,
                         java.lang.String optionName)

hasSection

public boolean hasSection(java.lang.String sectionName)

items

public java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>> items(java.lang.String sectionName)
                                                                                   throws ConfigParser.NoSectionException,
                                                                                          ConfigParser.InterpolationMissingOptionException

Throws:

ConfigParser.NoSectionException

ConfigParser.InterpolationMissingOptionException

items

public java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>> items(java.lang.String sectionName,
                                                                                          boolean raw)
                                                                                   throws ConfigParser.NoSectionException,
                                                                                          ConfigParser.InterpolationMissingOptionException

Throws:

ConfigParser.NoSectionException

ConfigParser.InterpolationMissingOptionException

items

public java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>> items(java.lang.String sectionName,
                                                                                          boolean raw,
                                                                                          java.util.Map<java.lang.String,java.lang.String> variables)
                                                                                   throws ConfigParser.NoSectionException,
                                                                                          ConfigParser.InterpolationMissingOptionException

Throws:

ConfigParser.NoSectionException

ConfigParser.InterpolationMissingOptionException

options

public java.util.List<java.lang.String> options(java.lang.String sectionName)
                                         throws ConfigParser.NoSectionException

Throws:

ConfigParser.NoSectionException

read

public void read(java.lang.String... filenames)
          throws java.io.IOException,
                 ConfigParser.ParsingException

Throws:

java.io.IOException

ConfigParser.ParsingException

read

public void read(java.io.Reader reader)
          throws java.io.IOException,
                 ConfigParser.ParsingException

Throws:

java.io.IOException

ConfigParser.ParsingException

read

public void read(java.net.URL url)
          throws java.io.IOException,
                 ConfigParser.ParsingException

Throws:

java.io.IOException

ConfigParser.ParsingException

read

public void read(java.io.File file)
          throws java.io.IOException,
                 ConfigParser.ParsingException

Throws:

java.io.IOException

ConfigParser.ParsingException

read

public void read(java.io.InputStream stream)
          throws java.io.IOException,
                 ConfigParser.ParsingException

Throws:

java.io.IOException

ConfigParser.ParsingException

removeOption

public boolean removeOption(java.lang.String sectionName,
                            java.lang.String optionName)
                     throws ConfigParser.NoSectionException

Throws:

ConfigParser.NoSectionException

removeSection

public boolean removeSection(java.lang.String sectionName)

sections

public java.util.List<java.lang.String> sections()

set

public void set(java.lang.String sectionName,
                java.lang.String optionName,
                java.lang.Object value)
         throws ConfigParser.NoSectionException

Throws:

ConfigParser.NoSectionException

write

public void write(java.io.Writer writer)
           throws java.io.IOException

Throws:

java.io.IOException

write

public void write(java.io.OutputStream stream)
           throws java.io.IOException

Throws:

java.io.IOException

write

public void write(java.io.File file)
           throws java.io.IOException

Throws:

java.io.IOException

getIni

protected Ini getIni()