Record Class Scheduler.ScheduleResult.LowerPriorityThanRunningCommand

java.lang.Object
java.lang.Record
org.wpilib.command3.Scheduler.ScheduleResult.LowerPriorityThanRunningCommand
Record Components:
command - the command that failed to be scheduled
alreadyRunning - the running command that prevented the command from being scheduled
All Implemented Interfaces:
Scheduler.ScheduleResult, Scheduler.ScheduleResult.Failure
Enclosing interface:
Scheduler.ScheduleResult
public static record Scheduler.ScheduleResult.LowerPriorityThanRunningCommand(Command command, Command alreadyRunning) extends Record implements Scheduler.ScheduleResult.Failure
A scheduling attempt that failed because the command was lower priority than a running command with shared requirements.

  • Constructor Details

    • LowerPriorityThanRunningCommand

      public LowerPriorityThanRunningCommand(Command command, Command alreadyRunning)
      Creates an instance of a LowerPriorityThanRunningCommand record class.
      Parameters:
      command - the value for the command record component
      alreadyRunning - the value for the alreadyRunning record component

  • Method Details

    • successful

      public boolean successful()
      A scheduling attempt that failed because the command was lower priority than a running command with shared requirements is always unsuccessful.
      Specified by:
      successful in interface Scheduler.ScheduleResult
      Specified by:
      successful in interface Scheduler.ScheduleResult.Failure
      Returns:
      false

    • 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

    • alreadyRunning

      public Command alreadyRunning()
      Returns the value of the alreadyRunning record component.
      Returns:
      the value of the alreadyRunning record component