Module org.tquadrat.foundation.inifile

Package org.tquadrat.foundation.inifile.internal

Class Group

java.lang.Object

org.tquadrat.foundation.inifile.internal.Group

All Implemented Interfaces:

Comparable<Group>

@ClassVersion(sourceVersion="$Id: Group.java 1105 2024-02-28 12:58:46Z tquadrat $")
@API(status=INTERNAL,
     since="0.1.0")
public final class Group
extends Object
implements Comparable<Group>

The group for an INI file.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: Group.java 1105 2024-02-28 12:58:46Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final StringBuilder	m_Comment	The comment for this group.
private final String	m_Name	The name of the group.
private final Map<String,Value>	m_Values	The values for this group.

Constructor Summary

Constructors

Constructor	Description
Group(String name)	Creates a new instance for Group.

Method Summary

Modifier and Type	Method	Description
final void	addComment(String comment)	Adds a comment to the group.
final void	addComment(String key, String comment)	Adds a comment to the value with the given key.
static final boolean	checkGroupNameCandidate(String candidate)	An implementation of Predicate to be used with Objects.requireValidArgument(Object,String,Predicate) when checking the names for new groups.
final int	compareTo(Group o)
private final Value	createValue(String key)	Creates a new instance of Value for the given name.
final boolean	equals(Object o)
final Collection<String>	getKeys()	Returns all keys for this group.
final String	getName()	Returns the name for this group.
final Optional<Value>	getValue(String key)	Returns the value for the given key from this group.
final int	hashCode()
final void	setComment(String comment)	Sets a comment to the group.
final void	setComment(String key, String comment)	Sets a comment to the value with the given key.
final Value	setValue(String key, String value)	Sets the given value for the given key.
final String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

m_Comment

private final StringBuilder m_Comment

The comment for this group.

m_Name

private final String m_Name

The name of the group.

m_Values

private final Map<String,Value> m_Values

The values for this group.

Constructor Details

Group

public Group(String name)

Creates a new instance for Group.

Parameters:

name - The name for the group.

Method Details

addComment

public final void addComment(String comment)

Adds a comment to the group.

Parameters:

comment - The comment.

addComment

public final void addComment(String key,
 String comment)

Adds a comment to the value with the given key.

Parameters:

key - The key.

comment - The comment.

checkGroupNameCandidate

@API(status=INTERNAL,
     since="0.4.4")
public static final boolean checkGroupNameCandidate(String candidate)

An implementation of Predicate to be used with Objects.requireValidArgument(Object,String,Predicate) when checking the names for new groups.

The candidate may not contain newline characters, tab characters or closing brackets (']').

You should avoid equal signs ('='), hash signs ('#') and opening brackets ('['), too, although they are technically allowed.

Parameters:

candidate - The key or name to check.

Returns:

true if the value is a valid name or key.

Throws:

NullArgumentException - The candidate is null.

EmptyArgumentException - The candidate is the empty string.

BlankArgumentException - The candidate consists of whitespace only.

Since:

0.4.4

compareTo

@API(status=MAINTAINED,
     since="0.4.2")
public final int compareTo(Group o)

This method is different from equals() as it does not consider the comment.

Specified by:

compareTo in interface Comparable<Group>

Since:

0.4.2

createValue

private final Value createValue(String key)

Creates a new instance of Value for the given name.

Parameters:

key - The name of the value.

Returns:

The new instance.

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

getKeys

public final Collection<String> getKeys()

Returns all keys for this group.

Returns:

The keys.

getName

public final String getName()

Returns the name for this group.

Returns:

The group's name.

getValue

public final Optional<Value> getValue(String key)

Returns the value for the given key from this group.

Parameters:

key - The key.

Returns:

An instance of Optional that holds the value.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

setComment

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

Sets a comment to the group.

Any previously existing comment will be overwritten.

Parameters:

comment - The comment.

Since:

0.4.2

setComment

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

Sets a comment to the value with the given key.

Any previously existing comment will be overwritten.

Parameters:

key - The key.

comment - The comment.

Since:

0.4.2

setValue

public final Value setValue(String key,
 String value)

Sets the given value for the given key.

Parameters:

key - The key.

value - The new value; can be null.

Returns:

The instance of Value for the new value.

toString

public final String toString()

Overrides:

toString in class Object