Replace LibUsbException with UsbPlatformException

Author: kayahr

src/main/java/org/usb4java/javax/AbstractDevice.java

@@ -23,6 +23,7 @@
 import javax.usb.UsbDeviceDescriptor;
 import javax.usb.UsbDisconnectedException;
 import javax.usb.UsbException;
+import javax.usb.UsbPlatformException;
 import javax.usb.UsbPort;
 import javax.usb.UsbStringDescriptor;
 import javax.usb.event.UsbDeviceEvent;
@@ -99,12 +100,12 @@ abstract class AbstractDevice implements UsbDevice
      *            The libusb device. This reference is only valid during the
      *            constructor execution, so don't store it in a property or
      *            something like that.
-     * @throws LibUsbException
+     * @throws UsbPlatformException
      *             When device configuration could not be read.
      */
     AbstractDevice(final DeviceManager manager, final DeviceId id,
         final DeviceId parentId, final int speed, final Device device)
-        throws LibUsbException
+        throws UsbPlatformException
     {
         if (manager == null)
             throw new IllegalArgumentException("manager must be set");
@@ -126,8 +127,9 @@ abstract class AbstractDevice implements UsbDevice
                 configDescriptor);
             if (result < 0)
             {
-                throw new LibUsbException("Unable to get configuation " + i
-                    + " for device " + id, result);
+                throw ExceptionUtils.createPlatformException(
+                    "Unable to get configuation " + i + " for device " + id,
+                    result);
             }
             try
             {
@@ -159,7 +161,7 @@ abstract class AbstractDevice implements UsbDevice
         }
         else if (result < 0)
         {
-            throw new LibUsbException(
+            throw ExceptionUtils.createPlatformException(
                 "Unable to read active config descriptor from device " + id,
                 result);
         }
@@ -221,8 +223,8 @@ public final DeviceHandle open() throws UsbException
                 final int result = LibUsb.open(device, handle);
                 if (result < 0)
                 {
-                    throw new LibUsbException("Can't open device "
-                        + this.id, result);
+                    throw ExceptionUtils.createPlatformException(
+                        "Can't open device " + this.id, result);
                 }
                 this.handle = handle;
             }
@@ -379,8 +381,8 @@ final void setActiveUsbConfigurationNumber(final byte number)
 
             final int result = LibUsb.setConfiguration(open(), number & 0xff);
             if (result < 0)
-                throw new LibUsbException("Unable to set configuration",
-                    result);
+                throw ExceptionUtils.createPlatformException(
+                    "Unable to set configuration", result);
             this.activeConfigurationNumber = number;
         }
     }
@@ -414,16 +416,20 @@ final void claimInterface(final byte number, final boolean force)
             {
                 result = LibUsb.detachKernelDriver(handle, number);
                 if (result < 0)
-                    throw new LibUsbException(
+                {
+                    throw ExceptionUtils.createPlatformException(
                         "Unable to detach kernel driver", result);
+                }
                 this.detachedKernelDriver = true;
             }
         }
 
         final int result = LibUsb.claimInterface(handle, number & 0xff);
         if (result < 0)
-            throw new LibUsbException("Unable to claim interface",
-                result);
+        {
+            throw ExceptionUtils.createPlatformException(
+                "Unable to claim interface", result);
+        }
         this.claimedInterfaceNumbers.add(number);
     }
 
@@ -444,14 +450,20 @@ final void releaseInterface(final byte number) throws UsbException
 
         final DeviceHandle handle = open();
         int result = LibUsb.releaseInterface(handle, number & 0xff);
-        if (result < 0) throw new LibUsbException(
-            "Unable to release interface", result);
+        if (result < 0)
+        {
+            throw ExceptionUtils.createPlatformException(
+                "Unable to release interface", result);
+        }
 
         if (this.detachedKernelDriver)
         {
             result = LibUsb.attachKernelDriver(handle, number & 0xff);
-            if (result < 0) throw new LibUsbException(
-                "Uanble to re-attach kernel driver", result);
+            if (result < 0)
+            {
+                throw ExceptionUtils.createPlatformException(
+                    "Uanble to re-attach kernel driver", result);
+            }
         }
 
         this.claimedInterfaceNumbers.remove(number);
@@ -499,8 +511,11 @@ public final UsbStringDescriptor getUsbStringDescriptor(final byte index)
         final int result =
             LibUsb.getStringDescriptor(handle, index, langId, data);
         if (result < 0)
-            throw new LibUsbException("Unable to get string descriptor "
-                + index + " from device " + this, result);
+        {
+            throw ExceptionUtils.createPlatformException(
+                "Unable to get string descriptor " + index + " from device "
+                    + this, result);
+        }
         return new SimpleUsbStringDescriptor(data);
     }
 
@@ -525,8 +540,10 @@ private short[] getLanguages() throws UsbException
         final int result = LibUsb.getDescriptor(handle, LibUsb.DT_STRING,
             (byte) 0, buffer);
         if (result < 0)
-            throw new LibUsbException(
+        {
+            throw ExceptionUtils.createPlatformException(
                 "Unable to get string descriptor languages", result);
+        }
         if (result < 2)
             throw new UsbException("Received illegal descriptor length: "
                 + result);

src/main/java/org/usb4java/javax/AbstractIrpQueue.java

@@ -226,7 +226,7 @@ protected final void processControlIrp(final UsbControlIrp irp)
             getConfig().getTimeout());
         if (result < 0)
         {
-            throw new LibUsbException(
+            throw ExceptionUtils.createPlatformException(
                 "Unable to submit control message", result);
         }
         buffer.rewind();

src/main/java/org/usb4java/javax/Configuration.java

@@ -169,7 +169,7 @@ void setUsbInterface(final byte number, final Interface iface)
                 iface.getUsbInterfaceDescriptor().bAlternateSetting());
             if (result < 0)
             {
-                throw new LibUsbException(
+                throw ExceptionUtils.createPlatformException(
                     "Unable to set alternate interface", result);
             }
             this.activeSettings.put(number & 0xff, iface);

src/main/java/org/usb4java/javax/DeviceManager.java

@@ -13,6 +13,7 @@
 
 import javax.usb.UsbException;
 import javax.usb.UsbHub;
+import javax.usb.UsbPlatformException;
 
 import org.usb4java.Context;
 import org.usb4java.Device;
@@ -64,7 +65,10 @@ final class DeviceManager
         this.context = new Context();
         final int result = LibUsb.init(this.context);
         if (result != 0)
-            throw new LibUsbException("Unable to initialize libusb", result);
+        {
+            throw ExceptionUtils.createPlatformException(
+                "Unable to initialize libusb", result);
+        }
     }
 
     /**
@@ -82,11 +86,11 @@ public void dispose()
      * @param device
      *            The libusb device. Must not be null.
      * @return The device id.
-     * @throws LibUsbException
+     * @throws UsbPlatformException
      *             When device descriptor could not be read from the specified
      *             device.
      */
-    private DeviceId createId(final Device device) throws LibUsbException
+    private DeviceId createId(final Device device) throws UsbPlatformException
     {
         if (device == null)
             throw new IllegalArgumentException("device must be set");
@@ -97,7 +101,7 @@ private DeviceId createId(final Device device) throws LibUsbException
         final int result = LibUsb.getDeviceDescriptor(device, deviceDescriptor);
         if (result < 0)
         {
-            throw new LibUsbException(
+            throw ExceptionUtils.createPlatformException(
                 "Unable to get device descriptor for device " + addressNumber
                     + " at bus " + busNumber, result);
         }
@@ -171,7 +175,7 @@ public void scan(final UsbHub hub)
         {
             updateDeviceList();
         }
-        catch (LibUsbException e)
+        catch (UsbException e)
         {
             throw new ScanException("Unable to scan for USB devices: " + e, e);
         }
@@ -194,20 +198,22 @@ public void scan(final UsbHub hub)
      * Updates the device list by adding newly connected devices to it and by
      * removing no longer connected devices.
      * 
-     * @throws LibUsbException
+     * @throws UsbPlatformException
      *             When libusb reported an error which we can't ignore during
      *             scan.
      */
-    private void updateDeviceList() throws LibUsbException
+    private void updateDeviceList() throws UsbPlatformException
     {
         final List<DeviceId> current = new ArrayList<DeviceId>();
 
         // Get device list from libusb and abort if it failed
         final DeviceList devices = new DeviceList();
         final int result = LibUsb.getDeviceList(this.context, devices);
         if (result < 0)
-            throw new LibUsbException("Unable to get USB device list",
-                result);
+        {
+            throw ExceptionUtils.createPlatformException(            
+                "Unable to get USB device list", result);
+        }
 
         try
         {
@@ -245,7 +251,7 @@ private void updateDeviceList() throws LibUsbException
                     // Remember current device as "current"
                     current.add(id);
                 }
-                catch (LibUsbException e)
+                catch (UsbPlatformException e)
                 {
                     // Devices which can't be enumerated are ignored
                     continue;
@@ -278,18 +284,20 @@ public synchronized void scan()
      * @return device The libusb device. Never null.
      * @throws DeviceNotFoundException
      *             When the device was not found.
-     * @throws LibUsbException
+     * @throws UsbPlatformException
      *             When libusb reported an error while enumerating USB devices.
      */
-    public Device getLibUsbDevice(final DeviceId id) throws LibUsbException
+    public Device getLibUsbDevice(final DeviceId id) throws UsbPlatformException
     {
         if (id == null) throw new IllegalArgumentException("id must be set");
 
         final DeviceList devices = new DeviceList();
         final int result = LibUsb.getDeviceList(this.context, devices);
         if (result < 0)
-            throw new LibUsbException("Unable to get USB device list",
-                result);
+        {
+            throw ExceptionUtils.createPlatformException(
+                "Unable to get USB device list", result);
+        }
         try
         {
             for (Device device: devices)
@@ -302,7 +310,7 @@ public Device getLibUsbDevice(final DeviceId id) throws LibUsbException
                         return device;
                     }
                 }
-                catch (LibUsbException e)
+                catch (UsbPlatformException e)
                 {
                     // Devices for which no ID can be created are ignored
                     continue;

src/main/java/org/usb4java/javax/ExceptionUtils.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2014 Klaus Reimer <k@ailis.de>
+ * See LICENSE.md for licensing information.
+ */
+
+package org.usb4java.javax;
+
+import javax.usb.UsbPlatformException;
+
+import org.usb4java.LibUsb;
+
+/**
+ * Utility methods for exception handling.
+ * 
+ * @author Klaus Reimer (k@ailis.de)
+ */
+final class ExceptionUtils
+{
+    /**
+     * Private constructor to prevent instantiation.
+     */
+    private ExceptionUtils()
+    {
+        // Empty
+    }
+    
+    /**
+     * Creates a USB platform exception.
+     * 
+     * @param message
+     *            The error message.
+     * @param errorCode
+     *            The error code.
+     * @return The USB platform exception.
+     */
+    static UsbPlatformException createPlatformException(final String message,
+        final int errorCode)
+    {
+        return new UsbPlatformException(String.format("USB error %d: %s: %s", 
+            -errorCode, message, LibUsb.strError(errorCode)), errorCode);
+    }
+}

src/main/java/org/usb4java/javax/Hub.java

@@ -8,6 +8,7 @@
 import java.util.List;
 
 import javax.usb.UsbHub;
+import javax.usb.UsbPlatformException;
 
 import org.usb4java.Device;
 
@@ -37,12 +38,12 @@ final class Hub extends AbstractDevice implements UsbHub,
      *            The libusb device. This reference is only valid during the
      *            constructor execution, so don't store it in a property or
      *            something like that.
-     * @throws LibUsbException
+     * @throws UsbPlatformException
      *             When device configuration could not be read.
      */
     Hub(final DeviceManager manager, final DeviceId id,
         final DeviceId parentId, final int speed, final Device device)
-        throws LibUsbException
+        throws UsbPlatformException
     {
         super(manager, id, parentId, speed, device);
     }