com.github.vincentrussell.ini

Class Ini

java.lang.Object

com.github.vincentrussell.ini.Ini

public class Ini
extends Object

This class is responsible for converting input streams into maps of maps that represent ini files.

Constructor Summary

Constructors

Constructor and Description
Ini() default constructor

Method Summary

Modifier and Type	Method and Description
Collection<String>	getKeys(String section) get the keys from a particular section.
Map<String,Object>	getSection(String section) return the section as a map.
Collection<String>	getSections() get the sections from the ini file.
Map<String,Object>	getSectionSortedByKey(String section) return the section as a map; sorted by key
Map<String,Object>	getSectionWithKeysThatMatchFunction(String section, Predicate<Map.Entry<String,Object>> filter) get a subset of a section where all the keys match the provided filter
Map<String,Object>	getSectionWithKeysWithPrefix(String section, String prefix) get a subset of a section where all the keys match the provided prefix
Map<String,Object>	getSectionWithKeysWithRegex(String section, String regex) get a subset of a section where all the keys match the provided prefix
Object	getValue(String section, String key) return a value from the nested structure as an object
<T> T	getValue(String section, String key, Class<T> type) return a value from the nested structure and cast it to the specified type.
boolean	hasKey(String section, String key) return true if the section and section key exists, false otherwise
void	load(File file) default constructor with File
void	load(InputStream inputStream) default constructor with an InputStream
void	load(String string) default constructor with String
void	merge(Ini ini) merge this Ini with another Ini.
void	putValue(String section, String key, Object value) store new values in the ini
void	putValues(String sectionKey, Map<String,Object> sectionEntries) put multiple key/value pairs into a section.
Map<String,Object>	removeSection(String section) Removes the specified section.
Object	removeSectionKey(String section, String key) Removes the specified key in the specified section.
void	store(OutputStream outputStream, String comments) store the ini to an outputstream
void	store(Writer writer, String comments) store the ini to a writer

Methods inherited from class java.lang.Object

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

Constructor Detail

Ini

public Ini()

default constructor

Method Detail

load

public void load(InputStream inputStream)
          throws IOException

default constructor with an InputStream

Parameters:

inputStream - the ini file as an input stream

Throws:

IOException - thrown when there is an error processing the ini.

load

public void load(File file)
          throws IOException

default constructor with File

Parameters:

file - the ini file

Throws:

IOException - thrown when there is an error processing the ini.

load

public void load(String string)
          throws IOException

default constructor with String

Parameters:

string - the contents of the ini file

Throws:

IOException - thrown when there is an error processing the ini.

merge

public void merge(Ini ini)

merge this Ini with another Ini. If there are any merge conflicts the passed in Ini will take precedence.

Parameters:

ini - the ini to merge

hasKey

public boolean hasKey(String section,
                      String key)

return true if the section and section key exists, false otherwise

Parameters:

section - the desired section

key - the key in the section

Returns:

true if the section and section key exists, false otherwise

getValue

public Object getValue(String section,
                       String key)

return a value from the nested structure as an object

Parameters:

section - the desired section

key - the desired key in the section

Returns:

the value from the nested structure and cast it to the specified type.

getValue

public <T> T getValue(String section,
                      String key,
                      Class<T> type)

return a value from the nested structure and cast it to the specified type.

Type Parameters:

T - the generic for the type

Parameters:

section - the desired section

key - the key in the section

type - the desired type

Returns:

the value from the nested structure and cast it to the specified type.

getSections

public Collection<String> getSections()

get the sections from the ini file.

Returns:

the sections as a collection.

getKeys

public Collection<String> getKeys(String section)

get the keys from a particular section.

Parameters:

section - the desired section

Returns:

the keys for a section or an empty collection.

getSection

public Map<String,Object> getSection(String section)

return the section as a map.

Parameters:

section - the desired section

Returns:

null if not found

getSectionSortedByKey

public Map<String,Object> getSectionSortedByKey(String section)

return the section as a map; sorted by key

Parameters:

section - the desired section

Returns:

null if not found

getSectionWithKeysWithPrefix

public Map<String,Object> getSectionWithKeysWithPrefix(String section,
                                                       String prefix)

get a subset of a section where all the keys match the provided prefix

Parameters:

section - the desired section

prefix - that the key starts with

Returns:

a subset of a section where all the keys match the provided prefix

getSectionWithKeysThatMatchFunction

public Map<String,Object> getSectionWithKeysThatMatchFunction(String section,
                                                              Predicate<Map.Entry<String,Object>> filter)

get a subset of a section where all the keys match the provided filter

Parameters:

section -

filter - the filter that the Map.Entry in she specified section must match

Returns:

getSectionWithKeysWithRegex

public Map<String,Object> getSectionWithKeysWithRegex(String section,
                                                      String regex)

get a subset of a section where all the keys match the provided prefix

Parameters:

section - the desired section

regex - that matches the key

Returns:

a subset of a section where all the keys match the provided prefix

putValue

public void putValue(String section,
                     String key,
                     Object value)

store new values in the ini

Parameters:

section - the desired section

key - the key in the section

value - the value to store for that key

putValues

public void putValues(String sectionKey,
                      Map<String,Object> sectionEntries)

put multiple key/value pairs into a section.

Parameters:

sectionEntries -

store

public void store(OutputStream outputStream,
                  String comments)
           throws IOException

store the ini to an outputstream

Parameters:

outputStream - the outputstream to write to

comments - the comments to put at the top of the file

Throws:

IOException - if there is an error writing to the outputstream

store

public void store(Writer writer,
                  String comments)
           throws IOException

store the ini to a writer

Parameters:

writer - the writer to use

comments - commments to put at the top of the file.

Throws:

IOException - if there is an error writing to the writer

removeSection

public Map<String,Object> removeSection(String section)

Removes the specified section. The ini object will not contain a mapping for the specified section once the call returns.

Parameters:

section - the section to remove

Returns:

the previous value associated with key, or null if there was no mapping for key.

removeSectionKey

public Object removeSectionKey(String section,
                               String key)

Removes the specified key in the specified section. The ini object will not contain a mapping for the specified section once the call returns.

Parameters:

section - the section to remove

key - the key in that section to remove

Returns:

the previous value associated with key, or null if there was no mapping for key.