Record Class Scheduler.ScheduleResult.Success

java.lang.Object

java.lang.Record

org.wpilib.command3.Scheduler.ScheduleResult.Success

Record Components:

command - the command that was successfully scheduled

All Implemented Interfaces:

Scheduler.ScheduleResult, Scheduler.ScheduleResult.Successful

Enclosing interface:

Scheduler.ScheduleResult

public static record Scheduler.ScheduleResult.Success(Command command)
extends Record
implements Scheduler.ScheduleResult.Successful

A successful scheduling attempt.

Nested Class Summary

Nested classes/interfaces inherited from interface Scheduler.ScheduleResult

Scheduler.ScheduleResult.AlreadyRunning, Scheduler.ScheduleResult.Failure, Scheduler.ScheduleResult.LowerPriorityThanQueuedCommand, Scheduler.ScheduleResult.LowerPriorityThanRunningCommand, Scheduler.ScheduleResult.Success, Scheduler.ScheduleResult.Successful

Constructor Summary

Constructors

Constructor	Description
Success(Command command)	Creates an instance of a Success record class.

Method Summary

Modifier and Type	Method	Description
Command	command()	Returns the value of the command 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.
boolean	successful()	A successful scheduling attempt is always successful.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

Success

public Success(Command command)

Creates an instance of a Success record class.

Parameters:

command - the value for the command record component

Method Details

successful

public boolean successful()

A successful scheduling attempt is always successful.

Specified by:

successful in interface Scheduler.ScheduleResult

Specified by:

successful in interface Scheduler.ScheduleResult.Successful

Returns:

true

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.

command

public Command command()

Returns the value of the command record component.

Specified by:

command in interface Scheduler.ScheduleResult

Returns:

the value of the command record component