Module org.tquadrat.foundation.inifile

Package org.tquadrat.foundation.inifile

Record Class INIFile.Entry

java.lang.Object

java.lang.Record

org.tquadrat.foundation.inifile.INIFile.Entry

Record Components:

group - The group for the entry.

key - The key for the entry.

value - The entry's value.

All Implemented Interfaces:

Comparable<INIFile.Entry>

Enclosing interface:

INIFile

public static record INIFile.Entry(String group, String key, String value)
extends Record
implements Comparable<INIFile.Entry>

An entry for the INI file.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: INIFile.java 1128 2024-04-06 07:17:56Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.inifile.INIFile.Entry"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final String	group	The field for the group record component.
private final String	key	The field for the key record component.
private final String	value	The field for the value record component.

Constructor Summary

Constructors

Constructor	Description
Entry(String group, String key, String value)	Creates an instance of a Entry record class.

Method Summary

Modifier and Type	Method	Description
int	compareTo(INIFile.Entry o)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	group()	Returns the value of the group record component.
final int	hashCode()	Returns a hash code value for this object.
String	key()	Returns the value of the key record component.
final String	toString()
String	value()	Returns the value of the value record component.
final <T> T	value(StringConverter<? extends T> stringConverter)	Retrieves the value and translates it to the desired type.

Methods inherited from class java.lang.Object

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

Field Details

group

private final String group

The field for the group record component.

key

private final String key

The field for the key record component.

value

private final String value

The field for the value record component.

Constructor Details

Entry

public Entry(String group,
 String key,
 String value)

Creates an instance of a Entry record class.

Parameters:

group - the value for the group record component

key - the value for the key record component

value - the value for the value record component

Method Details

compareTo

@API(status=STABLE,
     since="0.4.2")
public int compareTo(INIFile.Entry o)

Specified by:

compareTo in interface Comparable<INIFile.Entry>

Since:

0.4.2

toString

public final String toString()

Specified by:

toString in class Record

value

public final <T> T value(StringConverter<? extends T> stringConverter)

Retrieves the value and translates it to the desired type.

Type Parameters:

T - The target type.

Parameters:

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

Returns:

The value; can be null.

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

group

public String group()

Returns the value of the group record component.

Returns:

the value of the group record component

key

public String key()

Returns the value of the key record component.

Returns:

the value of the key record component

value

public String value()

Returns the value of the value record component.

Returns:

the value of the value record component