Record Class StringName

java.lang.Object

java.lang.Record

org.microbean.construct.element.StringName

Record Components:

value - the actual name; must not be null

domain - a Domain; must not be null

All Implemented Interfaces:

CharSequence, Constable, Name

public record StringName(String value, Domain domain)
extends Record
implements Constable, Name

A Name implementation based on Strings.

Author:

Laird Nelson

See Also:

• Name
• Domain.toString(CharSequence)

Constructor Summary

Constructors

Constructor	Description
StringName(CharSequence value, Domain domain)	Creates a new StringName.
StringName(String value, Domain domain)	Creates a new StringName.

Method Summary

Modifier and Type	Method	Description
final char	charAt(int index)
final IntStream	chars()
final IntStream	codePoints()
final boolean	contentEquals(CharSequence cs)
final Optional<? extends ConstantDesc>	describeConstable()
Domain	domain()	Returns the value of the domain record component.
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 boolean	isEmpty()
final int	length()
static final StringName	of(CharSequence cs, Domain domain)	Returns a StringName whose value() method will return a String equal to the String conversion of the supplied CharSequence, and whose domain() method will return a Domain equal to the supplied Domain.
final CharSequence	subSequence(int start, int end)
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

Constructor Details

StringName

public StringName(CharSequence value,
 Domain domain)

Creates a new StringName.

Parameters:

value - the actual name; must not be null

domain - a Domain; must not be null

Throws:

NullPointerException - if either argument is null

StringName

public StringName(String value,
 Domain domain)

Creates a new StringName.

Parameters:

value - the actual name; must not be null

domain - a Domain; must not be null

Throws:

NullPointerException - if either argument is null

Method Details

charAt

public final char charAt(int index)

Specified by:

charAt in interface CharSequence

chars

public final IntStream chars()

Specified by:

chars in interface CharSequence

codePoints

public final IntStream codePoints()

Specified by:

codePoints in interface CharSequence

contentEquals

public final boolean contentEquals(CharSequence cs)

Specified by:

contentEquals in interface Name

describeConstable

public final Optional<? extends ConstantDesc> describeConstable()

Specified by:

describeConstable in interface Constable

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface CharSequence

length

public final int length()

Specified by:

length in interface CharSequence

subSequence

public final CharSequence subSequence(int start,
 int end)

Specified by:

subSequence in interface CharSequence

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 interface CharSequence

Specified by:

toString in class Record

Returns:

a string representation of this object

of

public static final StringName of(CharSequence cs,
 Domain domain)

Returns a StringName whose value() method will return a String equal to the String conversion of the supplied CharSequence, and whose domain() method will return a Domain equal to the supplied Domain.

Parameters:

cs - a CharSequence; must not be null

domain - a Domain; must not be null

Returns:

a StringName; never null

Throws:

NullPointerException - if either argument is null

See Also:

• Domain.toString(CharSequence)

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 interface Name

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 interface Name

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 String value()

Returns the value of the value record component.

Returns:

the value of the value record component

domain

public Domain domain()

Returns the value of the domain record component.

Returns:

the value of the domain record component