Package com.inductiveautomation.eventstream.designer.ui.viewmodel

Record Class SubtextStateInfo

java.lang.Object

java.lang.Record

com.inductiveautomation.eventstream.designer.ui.viewmodel.SubtextStateInfo

Record Components:

state -

supplementalText -

flags -

public record SubtextStateInfo(SubtextStateInfo.State state, String supplementalText, Set<SubtextStateInfo.Flag> flags)
extends Record

Holds the state information for use with the InformationSubtextPanel.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SubtextStateInfo.Flag
static enum	SubtextStateInfo.State

Constructor Summary

Constructors

Constructor	Description
SubtextStateInfo(SubtextStateInfo.State state, String supplementalText, Set<SubtextStateInfo.Flag> flags)	Creates an instance of a SubtextStateInfo record class.

Method Summary

Modifier and Type	Method	Description
static SubtextStateInfo	create(SubtextStateInfo.State state, String message, Set<SubtextStateInfo.Flag> flags)
static SubtextStateInfo	create(SubtextStateInfo.State state, Set<SubtextStateInfo.Flag> flags)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Set<SubtextStateInfo.Flag>	flags()	Returns the value of the flags record component.
boolean	has(SubtextStateInfo.Flag flag)
final int	hashCode()	Returns a hash code value for this object.
static SubtextStateInfo	of(EventStreamState state, Set<SubtextStateInfo.Flag> flags)
SubtextStateInfo.State	state()	Returns the value of the state record component.
String	supplementalText()	Returns the value of the supplementalText record component.
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

Constructor Details

SubtextStateInfo

public SubtextStateInfo(SubtextStateInfo.State state,
 String supplementalText,
 Set<SubtextStateInfo.Flag> flags)

Creates an instance of a SubtextStateInfo record class.

Parameters:

state - the value for the state record component

supplementalText - the value for the supplementalText record component

flags - the value for the flags record component

Method Details

has

public boolean has(SubtextStateInfo.Flag flag)

create

public static SubtextStateInfo create(SubtextStateInfo.State state,
 Set<SubtextStateInfo.Flag> flags)

create

public static SubtextStateInfo create(SubtextStateInfo.State state,
 String message,
 Set<SubtextStateInfo.Flag> flags)

of

public static SubtextStateInfo of(EventStreamState state,
 Set<SubtextStateInfo.Flag> flags)

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.

state

public SubtextStateInfo.State state()

Returns the value of the state record component.

Returns:

the value of the state record component

supplementalText

public String supplementalText()

Returns the value of the supplementalText record component.

Returns:

the value of the supplementalText record component

flags

public Set<SubtextStateInfo.Flag> flags()

Returns the value of the flags record component.

Returns:

the value of the flags record component