Record Class ConflictDetector.Conflict

java.lang.Object
java.lang.Record
org.wpilib.command3.ConflictDetector.Conflict
Record Components:
a - The first conflicting command.
b - The second conflicting command.
sharedRequirements - The set of mechanisms required by both commands. This set is read-only
Enclosing class:
ConflictDetector
public static record ConflictDetector.Conflict(Command a, Command b, Set<Mechanism> sharedRequirements) extends Record
A conflict between two commands.

  • Constructor Details

    • Conflict

      public Conflict(Command a, Command b, Set<Mechanism> sharedRequirements)
      Creates an instance of a Conflict record class.
      Parameters:
      a - the value for the a record component
      b - the value for the b record component
      sharedRequirements - the value for the sharedRequirements record component

  • Method Details

    • description

      public String description()
      Gets a descriptive message for the conflict. The description includes the names of the conflicting commands and the names of all mechanisms required by both commands.
      Returns:
      A description of the conflict.

    • 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.

    • a

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

    • b

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

    • sharedRequirements

      public Set<Mechanism> sharedRequirements()
      Returns the value of the sharedRequirements record component.
      Returns:
      the value of the sharedRequirements record component