Package dev.turboism.sdk.cubism.transaction

Record Class AuthoringTransactionOptions

java.lang.Object

java.lang.Record

dev.turboism.sdk.cubism.transaction.AuthoringTransactionOptions

Record Components:

label - user-visible label associated with the single native Undo entry when a change commits

public record AuthoringTransactionOptions(String label)
extends Record

Immutable options for one synchronous authoring transaction.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_LABEL_LENGTH	Maximum number of Java characters accepted in a transaction label.

Constructor Summary

Constructors

Constructor	Description
AuthoringTransactionOptions(String label)	Validates and normalizes the transaction label.

Method Summary

Modifier and Type	Method	Description
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.
String	label()	Returns the value of the label record component.
static AuthoringTransactionOptions	of(String label)	Creates validated options for the supplied history label.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Field Details

MAX_LABEL_LENGTH

public static final int MAX_LABEL_LENGTH

Maximum number of Java characters accepted in a transaction label.

See Also:

• Constant Field Values

Constructor Details

AuthoringTransactionOptions

public AuthoringTransactionOptions(String label)

Validates and normalizes the transaction label.

Method Details

of

public static AuthoringTransactionOptions of(String label)

Creates validated options for the supplied history label.

Parameters:

label - user-visible authoring transaction label

Returns:

immutable validated options

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.

label

public String label()

Returns the value of the label record component.

Returns:

the value of the label record component