Record Class DeviceAddress

java.lang.Object
java.lang.Record
xbot.common.injection.DeviceAddress
Record Components:
type - device type
canBus - CAN bus, present only for CAN devices
channel - channel or device number

public record DeviceAddress(DevicePolice.DeviceType type, Optional<CANBusId> canBus, int channel) extends Record
A channel reservation, including the bus for CAN devices. Native bus identities are accepted directly by can(CANPort, int).

Factories describe a request without throwing for invalid channel or bus values. DevicePolice validates the complete request before reserving any channels.

  • Constructor Details

    • DeviceAddress

      public DeviceAddress(DevicePolice.DeviceType type, Optional<CANBusId> canBus, int channel)
      Creates an instance of a DeviceAddress record class.
      Parameters:
      type - the value for the type record component
      canBus - the value for the canBus record component
      channel - the value for the channel record component
  • Method Details

    • can

      public static DeviceAddress can(org.wpilib.hardware.bus.CANPort port, int channel)
    • can

      public static DeviceAddress can(CANBusId bus, int channel)
    • channel

      public static DeviceAddress channel(DevicePolice.DeviceType type, int channel)
    • validationError

      public Optional<String> validationError()
      Returns a validation error, or empty for a valid address. Does not report or reserve anything.
    • 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 the compare method from their corresponding wrapper classes.
      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.
    • type

      public DevicePolice.DeviceType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component
    • canBus

      public Optional<CANBusId> canBus()
      Returns the value of the canBus record component.
      Returns:
      the value of the canBus record component
    • channel

      public int channel()
      Returns the value of the channel record component.
      Returns:
      the value of the channel record component