Module org.tquadrat.foundation.inifile

Package org.tquadrat.foundation.inifile.internal

Class INIFileImpl

java.lang.Object

org.tquadrat.foundation.inifile.internal.INIFileImpl

All Implemented Interfaces:

INIFile

@ClassVersion(sourceVersion="$Id: INIFileImpl.java 1134 2024-05-20 16:53:16Z tquadrat $")
@API(status=INTERNAL,
     since="0.1.0")
public final class INIFileImpl
extends Object
implements INIFile

The implementation for INIFile.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: INIFileImpl.java 1134 2024-05-20 16:53:16Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.inifile.internal.INIFileImpl"

⁠

Nested Class Summary

Nested classes/interfaces inherited from interface org.tquadrat.foundation.inifile.INIFile

INIFile.Entry

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	LAST_UPDATED_FORMAT	The format String that is used for the last updated comment.
private static final Pattern	LAST_UPDATED_PATTERN	The pattern that is used for the last updated comment.
private Clock	m_Clock	The clock that is used to determine the last update.
private final StringBuilder	m_Comment	The comment for this file.
private final Path	m_File	The reference to file that is used to persist the contents.
private final Map<String,Group>	m_Groups	The groups.
private Instant	m_LastUpdated	The time when the file was last updated.

Fields inherited from interface org.tquadrat.foundation.inifile.INIFile

LINE_LENGTH

Constructor Summary

Constructors

Modifier	Constructor	Description
private	INIFileImpl(Path file)	Creates a new instance of INIFileImpl.

Method Summary

Modifier and Type	Method	Description
final void	addComment(String comment)	Adds the given comment to the INI file.
final void	addComment(String group, String comment)	Adds the given comment to the given group.
final void	addComment(String group, String key, String comment)	Adds the given comment to the value that is identified by the given group and key.
static final Stream<String>	breakString(String s)	Breaks the given String into chunks of 75 characters.
static final INIFile	create(Path file)	Creates an empty INI file.
private final Group	createGroup(String group)	Creates a new instance of Group for the given name.
final String	dumpContents()	Dumps the contents to a String.
final Optional<String>	getValue(String group, String key)	Retrieves the value for the given key from the given group.
final <T> Optional<T>	getValue(String group, String key, StringConverter<? extends T> stringConverter)	Retrieves the value for the given key from the given group.
final boolean	hasGroup(String group)	Checks whether the INI file contains a group with the given name.
final boolean	hasValue(String group, String key)	Checks whether the INI file contains an entry with the given key.
private final List<String>	joinLines(Iterable<String> lines)	Join all lines that end with a backslash with the next line on the list.
final Collection<INIFile.Entry>	listEntries()	Returns all entries of the INI file.
static final INIFile	open(Path file)	Opens the given INI file and reads its contents.
private final void	parse()	Loads the content from the file into memory.
final void	parse(List<String> lines)	Parses the given lines to the INI file contents.
final void	refresh()	Re-reads the values.
final void	save()	Saves the contents of the INI file to the file that was provided to create(Path) or open(Path).
final void	setClock(Clock clock)	Sets the clock that is used to determine the last update.
final void	setComment(String comment)	Sets the given comment to the INI file.
final void	setComment(String group, String comment)	Sets the given comment to the given group.
final void	setComment(String group, String key, String comment)	Sets the given comment to the value that is identified by the given group and key.
final void	setValue(String group, String key, String value)	Stores the given value with the given key to the given group.
static final Collection<String>	splitComment(CharSequence comment)	Splits a comment to the proper line length.
final String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tquadrat.foundation.inifile.INIFile

getValue, getValue, loadEntries, loadEntries, setValue

Field Details

m_Clock

private Clock m_Clock

The clock that is used to determine the last update. This is changed only for testing purposes, the default is Clock.systemDefaultZone().

m_Comment

private final StringBuilder m_Comment

The comment for this file.

m_File

private final Path m_File

The reference to file that is used to persist the contents.

m_Groups

private final Map<String,Group> m_Groups

The groups.

m_LastUpdated

private Instant m_LastUpdated

The time when the file was last updated.

LAST_UPDATED_FORMAT

private static final String LAST_UPDATED_FORMAT

The format String that is used for the last updated comment.

LAST_UPDATED_PATTERN

private static final Pattern LAST_UPDATED_PATTERN

The pattern that is used for the last updated comment.

Constructor Details

INIFileImpl

private INIFileImpl(Path file)

Creates a new instance of INIFileImpl.

The constructor does not check whether the file argument is null; this has to be done by the factory methods create(Path) and open(Path).

But that this constructor is public allows simpler tests.

Parameters:

file - The file that holds the contents.

Method Details

addComment

public final void addComment(String comment)

Adds the given comment to the INI file.

The new comment will be appended to an already existing one.

Specified by:

addComment in interface INIFile

Parameters:

comment - The comment.

addComment

public final void addComment(String group,
 String comment)

Adds the given comment to the given group.

The new comment will be appended to an already existing one.

Specified by:

addComment in interface INIFile

Parameters:

group - The group.

comment - The comment.

addComment

public final void addComment(String group,
 String key,
 String comment)

Adds the given comment to the value that is identified by the given group and key.

The new comment will be appended to an already existing one.

Specified by:

addComment in interface INIFile

Parameters:

group - The group.

key - The key for the value.

comment - The comment.

breakString

public static final Stream<String> breakString(String s)

Breaks the given String into chunks of 75 characters. All but the last chunk will end with a backslash ("\").

Parameters:

s - The String to split.

Returns:

The stream with the chunks.

create

public static final INIFile create(Path file)
                            throws IOException

Creates an empty INI file. If the file already exists, it will be overwritten without notice.

The given file is used to store the value on a call to save().

Parameters:

file - The file.

Returns:

The new instance.

Throws:

IOException - The file cannot be created.

createGroup

private final Group createGroup(String group)

Creates a new instance of Group for the given name.

Parameters:

group - The name of the group.

Returns:

The new instance.

dumpContents

public final String dumpContents()

Dumps the contents to a String.

Returns:

The contents in a String.

getValue

public final Optional<String> getValue(String group,
 String key)

Retrieves the value for the given key from the given group.

Specified by:

getValue in interface INIFile

Parameters:

group - The group.

key - The key for the value.

Returns:

An instance of Optional that holds the retrieved value.

getValue

public final <T> Optional<T> getValue(String group,
 String key,
 StringConverter<? extends T> stringConverter)

Retrieves the value for the given key from the given group.

Specified by:

getValue in interface INIFile

Type Parameters:

T - The target type.

Parameters:

group - The group.

key - The key for the value.

stringConverter - The implementation of StringConverter that is used to convert the stored value into the target type.

Returns:

An instance of Optional that holds the retrieved value.

hasGroup

public final boolean hasGroup(String group)

Checks whether the INI file contains a group with the given name.

This method will not throw an exception for an invalid group name; instead it returns false.

Specified by:

hasGroup in interface INIFile

Parameters:

group - The group.

Returns:

true if there is a group with the given name, false otherwise.

hasValue

public final boolean hasValue(String group,
 String key)

Checks whether the INI file contains an entry with the given key.

This method will not throw an exception for an invalid group name or an invalid key; instead it returns false.

Specified by:

hasValue in interface INIFile

Parameters:

group - The group.

key - The key.

Returns:

true if there is an entry with the given key, false otherwise.

joinLines

private final List<String> joinLines(Iterable<String> lines)

Join all lines that end with a backslash with the next line on the list.

Parameters:

lines - The input lines.

Returns:

The output.

listEntries

public final Collection<INIFile.Entry> listEntries()

Returns all entries of the INI file.

Specified by:

listEntries in interface INIFile

Returns:

The entries.

open

public static final INIFile open(Path file)
                          throws IOException

Opens the given INI file and reads its contents. If the file does not exist yet, a new, empty file will be created.

Parameters:

file - The file.

Returns:

The new instance.

Throws:

IOException - A problem occurred when reading the file.

parse

private final void parse()
                  throws IOException

Loads the content from the file into memory.

Throws:

IOException - A problem occurred when reading the file.

parse

public final void parse(List<String> lines)
                 throws IOException

Parses the given lines to the INI file contents.

Parameters:

lines - The joined lines; the list does not contain any multi-line constructs.

Throws:

IOException - The structure is invalid.

refresh

public final void refresh()
                   throws IOException

Re-reads the values.

Specified by:

refresh in interface INIFile

Throws:

IOException - A problem occurred when reading the file.

save

public final void save()
                throws IOException

Saves the contents of the INI file to the file that was provided to create(Path) or open(Path).

Specified by:

save in interface INIFile

Throws:

IOException - A problem occurred when writing the contents to the file.

setClock

public final void setClock(Clock clock)

Sets the clock that is used to determine the last update.

This is used only for testing purposes.

Parameters:

clock - The clock.

setComment

@API(status=STABLE,
     since="0.4.3")
public final void setComment(String comment)

Sets the given comment to the INI file.

The new comment will replace any already existing comment.

Specified by:

setComment in interface INIFile

Parameters:

comment - The comment.

Since:

0.4.3

setComment

@API(status=STABLE,
     since="0.4.3")
public final void setComment(String group,
 String comment)

Sets the given comment to the given group.

The new comment will replace any already existing comment.

Specified by:

setComment in interface INIFile

Parameters:

group - The group.

comment - The comment.

Since:

0.4.3

setComment

@API(status=STABLE,
     since="0.4.3")
public final void setComment(String group,
 String key,
 String comment)

Sets the given comment to the value that is identified by the given group and key.

The new comment will replace any already existing comment.

Specified by:

setComment in interface INIFile

Parameters:

group - The group.

key - The key for the value.

comment - The comment.

Since:

0.4.3

setValue

public final void setValue(String group,
 String key,
 String value)

Stores the given value with the given key to the given group.

Specified by:

setValue in interface INIFile

Parameters:

group - The group.

key - The key.

value - The value.

splitComment

public static final Collection<String> splitComment(CharSequence comment)

Splits a comment to the proper line length.

Parameters:

comment - The comment to split.

Returns:

The lines for the comment.

toString

public final String toString()

Overrides:

toString in class Object