com.goldencode.util

Class IniFile

java.lang.Object

com.goldencode.util.IniFile

public class IniFile
extends java.lang.Object

INI file read support.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	filePath File path
private java.util.regex.Pattern	keyValPattern Key-value regex pattern
private static CentralLogger	LOG Logger
private java.util.regex.Pattern	sectionPattern Section regex pattern
private java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	values Map of parsed values

Constructor Summary

Constructors

Constructor and Description
IniFile(java.lang.String filePath) Default ctor.

Method Summary

Modifier and Type	Method and Description
java.lang.Double	getDouble(java.lang.String section, java.lang.String key, java.lang.Double defaultValue) Reads a double value.
java.lang.Float	getFloat(java.lang.String section, java.lang.String key, java.lang.Float defaultValue) Reads a float value.
java.lang.Integer	getInt(java.lang.String section, java.lang.String key, java.lang.Integer defaultValue) Reads an integer value.
java.util.List<java.lang.String>	getSections(java.lang.String pattern) Get all the sections matching the given pattern (lowercase).
java.lang.String	getString(java.lang.String section, java.lang.String key, java.lang.String defaultValue) Reads a string value.
private <T> T	getValue(java.lang.String section, java.lang.String key, T defaultValue, java.util.function.Function<java.lang.String,T> parser) Reads a value.
void	load() Reads the INI file and parses the values.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static CentralLogger LOG

Logger

filePath

private java.lang.String filePath

File path

keyValPattern

private java.util.regex.Pattern keyValPattern

Key-value regex pattern

sectionPattern

private java.util.regex.Pattern sectionPattern

Section regex pattern

values

private java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> values

Map of parsed values

Constructor Detail

IniFile

public IniFile(java.lang.String filePath)

Default ctor.

Parameters:

filePath - INI file path.

Method Detail

load

public void load()
          throws java.io.IOException

Reads the INI file and parses the values.

Throws:

java.io.IOException - When there is an IO error.

getSections

public java.util.List<java.lang.String> getSections(java.lang.String pattern)

Get all the sections matching the given pattern (lowercase).

Parameters:

pattern - The pattern to match.

Returns:

The list of matchin sections.

getDouble

public java.lang.Double getDouble(java.lang.String section,
                                  java.lang.String key,
                                  java.lang.Double defaultValue)

Reads a double value.

Parameters:

section - INI section.

key - Value key.

defaultValue - The default value to return when the key is not found.

Returns:

The double value of the specified key or the provided default value when the key is not found.

getFloat

public java.lang.Float getFloat(java.lang.String section,
                                java.lang.String key,
                                java.lang.Float defaultValue)

Reads a float value.

Parameters:

section - INI section.

key - Value key.

defaultValue - The default value to return when the key is not found.

Returns:

The float value of the specified key or the provided default value when the key is not found.

getInt

public java.lang.Integer getInt(java.lang.String section,
                                java.lang.String key,
                                java.lang.Integer defaultValue)

Reads an integer value.

Parameters:

section - INI section.

key - Value key.

defaultValue - The default value to return when the key is not found.

Returns:

The integer value of the specified key or the provided default value when the key is not found.

getString

public java.lang.String getString(java.lang.String section,
                                  java.lang.String key,
                                  java.lang.String defaultValue)

Reads a string value.

Parameters:

section - INI section.

key - Value key.

defaultValue - The default value to return when the key is not found.

Returns:

The string value of the specified key or the provided default value when the key is not found.

getValue

private <T> T getValue(java.lang.String section,
                       java.lang.String key,
                       T defaultValue,
                       java.util.function.Function<java.lang.String,T> parser)

Reads a value.

Parameters:

section - INI section.

key - Value key.

defaultValue - The default value to return when the key is not found.

parser - The function that parses the read string value.

Returns:

The value of the specified key or the provided default value when the key is not found.