Module net.codecrete.usb
Package net.codecrete.usb

Record Class USBControlTransfer

java.lang.Object
java.lang.Record
net.codecrete.usb.USBControlTransfer
Record Components:
requestType - request type (bits 5 and 6 of bmRequestType)
recipient - recipient (bits 0–4 of bmRequestType)
request - request code (value between 0 and 255, called bRequest in USB specification)
value - value (value between 0 and 65535, called wValue in USB specification)
index - index (value between 0 and 65535, called wIndex in USB specification).
public record USBControlTransfer(USBRequestType requestType, USBRecipient recipient, int request, int value, int index) extends Record
USB control transfer parameters.

See description of "Setup Data" in the chapter "USB Device Requests" of the USB specification for additional information.

For control requests directed to an interface or endpoint, the lower byte of index contains the interface or endpoint number.

  • Constructor Details

    • USBControlTransfer

      public USBControlTransfer(USBRequestType requestType, USBRecipient recipient, int request, int value, int index)
      Creates an instance of a USBControlTransfer record class.
      Parameters:
      requestType - the value for the requestType record component
      recipient - the value for the recipient record component
      request - the value for the request record component
      value - the value for the value record component
      index - the value for the index 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.

    • requestType

      public USBRequestType requestType()
      Returns the value of the requestType record component.
      Returns:
      the value of the requestType record component

    • recipient

      public USBRecipient recipient()
      Returns the value of the recipient record component.
      Returns:
      the value of the recipient record component

    • request

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

    • value

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

    • index

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