Package org.springframework.shell.component.view.control

Record Class ProgressView.ProgressViewStartEvent

java.lang.Object

java.lang.Record

org.springframework.shell.component.view.control.ProgressView.ProgressViewStartEvent

Record Components:

view - the view sending an event

args - the event args

All Implemented Interfaces:

ViewEvent

Enclosing class:

ProgressView

public static record ProgressView.ProgressViewStartEvent(View view, ProgressView.ProgressViewStateEventArgs args)
extends Record
implements ViewEvent

ViewEvent indicating that proggress has been started.

Constructor Summary

Constructors

Constructor	Description
ProgressViewStartEvent(View view, ProgressView.ProgressViewStateEventArgs args)	Creates an instance of a ProgressViewStartEvent record class.

Method Summary

Modifier and Type	Method	Description
ProgressView.ProgressViewStateEventArgs	args()	Returns the value of the args 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.
static ProgressView.ProgressViewStartEvent	of(View view, ProgressView.ProgressState state)
final String	toString()	Returns a string representation of this record class.
View	view()	Returns the value of the view record component.

Methods inherited from class java.lang.Object

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

Constructor Details

ProgressViewStartEvent

public ProgressViewStartEvent(View view,
 ProgressView.ProgressViewStateEventArgs args)

Creates an instance of a ProgressViewStartEvent record class.

Parameters:

view - the value for the view record component

args - the value for the args record component

Method Details

of

public static ProgressView.ProgressViewStartEvent of(View view,
 ProgressView.ProgressState state)

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.

view

public View view()

Returns the value of the view record component.

Specified by:

view in interface ViewEvent

Returns:

the value of the view record component

args

public ProgressView.ProgressViewStateEventArgs args()

Returns the value of the args record component.

Specified by:

args in interface ViewEvent

Returns:

the value of the args record component