org.eclipse.kura.driver

Interface DriverService

@ProviderType
public interface DriverService

The interface DriverService is an utility service API to provide useful methods for drivers

Since:

1.2

Method Summary

Modifier and Type	Method and Description
Driver	getDriver(java.lang.String driverPid) Gets the driver instance by the provided driver PID (kura.service.pid).
java.lang.String	getDriverPid(Driver driver) Gets the driver PID.
java.util.List<Driver>	listDrivers() Returns the list containing all the available driver instances

Method Detail

getDriver

Driver getDriver(java.lang.String driverPid)

Gets the driver instance by the provided driver PID (kura.service.pid).

Parameters:

driverPid - the driver PID to check

Returns:

the driver instance

Throws:

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

getDriverPid

java.lang.String getDriverPid(Driver driver)

Gets the driver PID. (kura.service.pid) by the provided driver instance

Parameters:

driver - the driver instance to check

Returns:

the driver PID

Throws:

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

listDrivers

java.util.List<Driver> listDrivers()

Returns the list containing all the available driver instances

Returns:

the list of drivers available in service registry or empty list if no drivers are available