Package org.sosy_lab.common.configuration

Record Class AnnotatedValue<T>

java.lang.Object

java.lang.Record

org.sosy_lab.common.configuration.AnnotatedValue<T>

@Immutable(containerOf="T")
public record AnnotatedValue<T>(T value, Optional<String> annotation)
extends Record

Immutable container that stores a value and an optional string.

Constructor Summary

Constructors

Constructor	Description
AnnotatedValue(T value, Optional<String> annotation)	Creates an instance of a AnnotatedValue record class.

Method Summary

Modifier and Type	Method	Description
Optional<String>	annotation()	Returns the value of the annotation record component.
static <T> AnnotatedValue<T>	create(T value)
static <T> AnnotatedValue<T>	create(T value, String annotation)
static <T> AnnotatedValue<T>	create(T value, Optional<String> annotation)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
T	value()	Returns the value of the value record component.

Methods inherited from class java.lang.Object

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

Constructor Details

AnnotatedValue

public AnnotatedValue(T value,
 Optional<String> annotation)

Creates an instance of a AnnotatedValue record class.

Parameters:

value - the value for the value record component

annotation - the value for the annotation record component

Method Details

create

public static <T> AnnotatedValue<T> create(T value)

create

public static <T> AnnotatedValue<T> create(T value,
 String annotation)

create

public static <T> AnnotatedValue<T> create(T value,
 Optional<String> annotation)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

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.

value

public T value()

Returns the value of the value record component.

Returns:

the value of the value record component

annotation

public Optional<String> annotation()

Returns the value of the annotation record component.

Returns:

the value of the annotation record component