org.usb4java

Class BosDescriptor

java.lang.Object

org.usb4java.BosDescriptor

public final class BosDescriptor
extends Object

A structure representing the Binary Device Object Store (BOS) descriptor. This descriptor is documented in section 9.6.2 of the USB 3.0 specification. All multiple-byte fields are represented in host-endian format.

Author:

Klaus Reimer (k@ailis.de)

Constructor Summary

Constructors

Constructor and Description
BosDescriptor() Constructs a new BOS descriptor which can be passed to the LibUsb.getBosDescriptor(DeviceHandle, BosDescriptor) method.

Method Summary

Modifier and Type	Method and Description
byte	bDescriptorType() Returns the descriptor type.
byte	bLength() Returns the size of this descriptor (in bytes).
byte	bNumDeviceCaps() Returns the number of separate device capability descriptors in the BOS.
BosDevCapabilityDescriptor[]	devCapability() Returns the array with the device capability descriptors.
String	dump() Returns a dump of this descriptor.
boolean	equals(Object obj)
long	getPointer() Returns the native pointer.
int	hashCode()
String	toString()
short	wTotalLength() Returns the length of this descriptor and all of its sub descriptors.

Methods inherited from class java.lang.Object

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

Constructor Detail

BosDescriptor

public BosDescriptor()

Constructs a new BOS descriptor which can be passed to the LibUsb.getBosDescriptor(DeviceHandle, BosDescriptor) method.

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 descriptor size in bytes;

bDescriptorType

public byte bDescriptorType()

Returns the descriptor type.

Returns:

The descriptor type.

wTotalLength

public short wTotalLength()

Returns the length of this descriptor and all of its sub descriptors.

Returns:

The total descriptor length.

bNumDeviceCaps

public byte bNumDeviceCaps()

Returns the number of separate device capability descriptors in the BOS.

Returns:

The number of device capability descriptors.

devCapability

public BosDevCapabilityDescriptor[] devCapability()

Returns the array with the device capability descriptors.

Returns:

The array with device capability descriptors.

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