Package org.wpilib.commands3

Record Class SchedulerEvent.Canceled

java.lang.Object
java.lang.Record
org.wpilib.commands3.SchedulerEvent.Canceled
Record Components:
command - The command that was canceled
timestampMicros - When the command was canceled
All Implemented Interfaces:
SchedulerEvent
Enclosing interface:
SchedulerEvent
public static record SchedulerEvent.Canceled(Command command, long timestampMicros) extends Record implements SchedulerEvent
An event marking when a command was canceled. If the command was canceled because it was interrupted by another command, an SchedulerEvent.Interrupted will be emitted immediately prior to the cancellation event.

  • Constructor Details

    • Canceled

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

  • Method Details

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.
      Returns:
      the value of the command record component

    • timestampMicros

      public long timestampMicros()
      Returns the value of the timestampMicros record component.
      Specified by:
      timestampMicros in interface SchedulerEvent
      Returns:
      the value of the timestampMicros record component
      See Also: