org.eclipse.kura.driver.descriptor

Interface DriverDescriptorService

@ProviderType
public interface DriverDescriptorService

The DriverDescriptorService interface is an utility service API to get descriptors for drivers

Since:

1.4

Method Summary

Modifier and Type	Method and Description
java.util.Optional<DriverDescriptor>	getDriverDescriptor(java.lang.String driverPid) Returns the DriverDescriptor corresponding to the Driver instance identified by the provided Driver kura.service.pid.
java.util.List<DriverDescriptor>	listDriverDescriptors() Returns a list of DriverDescriptor objects that correspond to the entire list of Driver Instances in the Framework.

Method Detail

getDriverDescriptor

java.util.Optional<DriverDescriptor> getDriverDescriptor(java.lang.String driverPid)

Returns the DriverDescriptor corresponding to the Driver instance identified by the provided Driver kura.service.pid.

Parameters:

driverPid - the Driver kura.service.pid that identifies a Driver Instance

Returns:

the DriverDescriptor corresponding to the provided method argument. Or an empty Optional is the provided argument is not a Driver kura.service.pid

Throws:

java.lang.NullPointerException - if the provided driver PID is null

Since:

1.4

listDriverDescriptors

java.util.List<DriverDescriptor> listDriverDescriptors()

Returns a list of DriverDescriptor objects that correspond to the entire list of Driver Instances in the Framework.

Returns:

a list of DriverDescriptor

Since:

1.4