org.usb4java

Class InterfaceDescriptor

java.lang.Object

org.usb4java.InterfaceDescriptor

public final class InterfaceDescriptor
extends Object

A structure representing the standard USB interface descriptor. This descriptor is documented in section 9.6.5 of the USB 3.0 specification. All multiple-byte fields are represented in host-endian format.

Author:

Klaus Reimer (k@ailis.de)

Method Summary

Modifier and Type	Method and Description
byte	bAlternateSetting() Returns the value used to select this alternate setting for this interface.
byte	bDescriptorType() Returns the descriptor type.
byte	bInterfaceClass() Returns the USB-IF class code for this interface.
byte	bInterfaceNumber() Returns the number of this interface.
byte	bInterfaceProtocol() Returns the USB-IF protocol code for this interface, qualified by the bInterfaceClass and bInterfaceSubClass values.
byte	bInterfaceSubClass() Returns the USB-IF subclass code for this interface, qualified by the bInterfaceClass value.
byte	bLength() Returns the size of this descriptor (in bytes).
byte	bNumEndpoints() Returns the number of endpoints used by this interface (excluding the control endpoint).
String	dump() Returns a dump of this descriptor.
EndpointDescriptor[]	endpoint() Returns the array with endpoints.
boolean	equals(Object obj)
ByteBuffer	extra() Extra descriptors.
int	extraLength() Length of the extra descriptors, in bytes.
long	getPointer() Returns the native pointer.
int	hashCode()
byte	iInterface() Returns the index of string descriptor describing this interface.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getPointer

public long getPointer()

Returns the native pointer.

Returns:

The native pointer.

bLength

public byte bLength()

Returns the size of this descriptor (in bytes).

Returns:

The size of this descriptor (in bytes).

bDescriptorType

public byte bDescriptorType()

Returns the descriptor type. Will have value LibUsb.DT_INTERFACE in this context.

Returns:

The descriptor type.

bInterfaceNumber

public byte bInterfaceNumber()

Returns the number of this interface.

Returns:

The interface number.

bAlternateSetting

public byte bAlternateSetting()

Returns the value used to select this alternate setting for this interface.

Returns:

The alternate setting value.

bNumEndpoints

public byte bNumEndpoints()

Returns the number of endpoints used by this interface (excluding the control endpoint).

Returns:

The number of endpoints.

bInterfaceClass

public byte bInterfaceClass()

Returns the USB-IF class code for this interface. See LibUSB.CLASS_* constants.

Returns:

The USB-IF class code.

bInterfaceSubClass

public byte bInterfaceSubClass()

Returns the USB-IF subclass code for this interface, qualified by the bInterfaceClass value.

Returns:

The USB-IF subclass code.

bInterfaceProtocol

public byte bInterfaceProtocol()

Returns the USB-IF protocol code for this interface, qualified by the bInterfaceClass and bInterfaceSubClass values.

Returns:

The USB-IF protocol code.

iInterface

public byte iInterface()

Returns the index of string descriptor describing this interface.

Returns:

The string descriptor index.

endpoint

public EndpointDescriptor[] endpoint()

Returns the array with endpoints.

Returns:

The array with endpoints.

extra

public ByteBuffer extra()

Extra descriptors. If libusb encounters unknown interface descriptors, it will store them here, should you wish to parse them.

Returns:

The extra descriptors.

extraLength

public int extraLength()

Length of the extra descriptors, in bytes.

Returns:

The extra descriptors length.

dump

public String dump()

Returns a dump of this descriptor.

Returns:

The descriptor dump.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object