javax.usb.UsbInterfacePolicy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of usb-api Show documentation

Java API for communicating with devices that are attached via USB

The newest version!

package javax.usb;

/**
 * Copyright (c) 1999 - 2001, International Business Machines Corporation.
 * All Rights Reserved.
 *
 * This software is provided and licensed under the terms and conditions
 * of the Common Public License:
 * http://oss.software.ibm.com/developerworks/opensource/license-cpl.html
 */

/**
 * Interface describing the policy to claim an interface with.
 * @author Dan Streetman
 */
public interface UsbInterfacePolicy
{
	/**
	 * If the claim should be forced.
	 * 
	 * This will try to forcibly claim the UsbInterface.
	 * This is only intended as a flag to the implementation
	 * to try everything possible to allow a successful claim.
	 * The implementation may try to override any other driver(s)
	 * that have the interface claimed.
	 * 

	 * The implementation is not required to use this flag.
	 * 
	 * WARNING: This should only be used
	 * if you are absolutely sure you want to drive the
	 * interface.
	 * @param usbInterface The UsbInterface being claimed.
	 * @return If the interface should be forcibly claimed.
	 */
	public boolean forceClaim(UsbInterface usbInterface);

}