Module org.tquadrat.foundation.inifile

Package org.tquadrat.foundation.inifile.internal

Class Value

java.lang.Object

org.tquadrat.foundation.inifile.internal.Value

All Implemented Interfaces:

Comparable<Value>

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

The container for the value of an INI file.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

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

Since:

0.1.0

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final StringBuilder	m_Comment	The comment for this value.
private final Group	m_Group	The reference to the parent group.
private final String	m_Key	The key.
private String	m_Value	The value itself.

Constructor Summary

Constructors

Constructor	Description
Value(Group parent, String key)	Creates a new instance of Value.
Value(Group parent, String key, String value)	Creates a new instance of Value.

Method Summary

Modifier and Type	Method	Description
final void	addComment(String comment)	Adds a comment to the value.
static final boolean	checkKeyCandidate(String candidate)	An implementation of Predicate to be used with Objects.requireValidArgument(Object,String,Predicate) when checking the keys for new values.
int	compareTo(Value o)
final boolean	equals(Object o)
final String	getValue()	Returns the current value.
final int	hashCode()
final void	setComment(String comment)	Sets a comment to the group.
final void	setValue(String value)	Sets a new value.
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 value.

m_Group

private final Group m_Group

The reference to the parent group.

m_Key

private final String m_Key

The key.

m_Value

private String m_Value

The value itself.

Constructor Details

Value

public Value(Group parent,
 String key)

Creates a new instance of Value.

Parameters:

parent - The parent group.

key - The key.

Value

public Value(Group parent,
 String key,
 String value)

Creates a new instance of Value.

Parameters:

parent - The parent group.

key - The key.

value - The value.

Method Details

addComment

public final void addComment(String comment)

Adds a comment to the value.

Parameters:

comment - The comment.

checkKeyCandidate

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

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

The candidate may not begin with a hash symbol ('#') or an opening bracket ('['), and it may not contain newline characters, tab characters or equal signs.

You should avoid hash symbols and opening brackets completely, even inside or at the end of the key, as well as closing brackets (']'), despite they are technically valid.

Parameters:

candidate - The key to check.

Returns:

true if the value is a valid key, false otherwise.

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 int compareTo(Value o)

Specified by:

compareTo in interface Comparable<Value>

Since:

0.4.2

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

getValue

public final String getValue()

Returns the current value.

Returns:

The current value; can be null.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

setComment

@API(status=STABLE,
     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

setValue

public final void setValue(String value)

Sets a new value.

Parameters:

value - The new value; can be null.

toString

public final String toString()

Overrides:

toString in class Object