Record Class StringValue

java.lang.Object

java.lang.Record

org.microbean.attributes.StringValue

Record Components:

value - the value

All Implemented Interfaces:

Comparable<StringValue>, Constable, Value<StringValue>

public record StringValue(String value)
extends Record
implements Value<StringValue>

A Value whose value is a String.

Author:

Laird Nelson

Field Summary

Fields

Modifier and Type	Field	Description
static final StringValue	EMPTY

Constructor Summary

Constructors

Constructor	Description
StringValue(String value)	Creates a new StringValue.

Method Summary

Modifier and Type	Method	Description
final int	compareTo(StringValue other)
final Optional<DynamicConstantDesc<StringValue>>	describeConstable()
final boolean	equals(Object other)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
static final StringValue	of(String s)	Returns a StringValue suitable for the supplied arguments.
final String	toString()	Returns a string representation of this record class.
String	value()	Returns the value of the value record component.

Methods inherited from class java.lang.Object

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

Field Details

EMPTY

public static final StringValue EMPTY

Constructor Details

StringValue

public StringValue(String value)

Creates a new StringValue.

Parameters:

value - the value; must not be null

Throws:

NullPointerException - if value is null

Method Details

compareTo

public final int compareTo(StringValue other)

Specified by:

compareTo in interface Comparable<StringValue>

describeConstable

public final Optional<DynamicConstantDesc<StringValue>> describeConstable()

Specified by:

describeConstable in interface Constable

equals

public final boolean equals(Object other)

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:

other - the object with which to compare

Returns:

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

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

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

of

public static final StringValue of(String s)

Returns a StringValue suitable for the supplied arguments.

Parameters:

s - a non-null String

Returns:

a non-null StringValue

Throws:

NullPointerException - if s is null

value

public String value()

Returns the value of the value record component.

Returns:

the value of the value record component