Module com.pi4j

Package com.pi4j.provider

Interface Providers

All Superinterfaces:

Describable

public interface Providers
extends Describable

This class provides static methods to configure the Pi4J library's default platform. Pi4J supports the following platforms: RaspberryPi, BananaPi, BananaPro, Odroid.

Version:

$Id: $Id

Author:

Robert Savage (http://www.savagehomeautomation.com)

See Also:

• http://www.pi4j.com/

Method Summary

Modifier and Type	Method	Description
Map<String,Provider>	all()	Get all providers
<T extends Provider> Map<String,T>	all(IOType ioType)	Get all providers of a specified io type.
<T extends Provider> Map<String,T>	all(Class<T> providerClass)	Get all providers of a specified io class/interface.
ProviderGroup<AnalogInputProvider>	analogInput()	analogInput.
ProviderGroup<AnalogOutputProvider>	analogOutput()	analogOutput.
default Descriptor	describe()	describe.
ProviderGroup<DigitalInputProvider>	digitalInput()	digitalInput.
ProviderGroup<DigitalOutputProvider>	digitalOutput()	digitalOutput.
default <T extends Provider> boolean	exists(IOType ioType)	exists.
default <T extends Provider> boolean	exists(Class<T> providerClass)	exists.
boolean	exists(String providerId)	exists.
default <T extends Provider> boolean	exists(String providerId, IOType ioType)	exists.
default <T extends Provider> boolean	exists(String providerId, Class<T> providerClass)	exists.
default <T extends Provider> T	get(IOType ioType)	get.
default <T extends Provider> T	get(Class<T> providerClass)	get.
<T extends Provider> T	get(String providerId)	get.
default <T extends Provider> T	get(String providerId, IOType ioType)	get.
default <T extends Provider> T	get(String providerId, Class<T> providerClass)	get.
default Map<String,Provider>	getAll()	getAll.
default <T extends Provider> Map<String,T>	getAll(IOType ioType)	getAll.
default <T extends Provider> Map<String,T>	getAll(Class<T> providerClass)	getAll.
default ProviderGroup<AnalogInputProvider>	getAnalogInputProviders()	getAnalogInput.
default ProviderGroup<AnalogOutputProvider>	getAnalogOutputProviders()	getAnalogOutput.
default ProviderGroup<DigitalInputProvider>	getDigitalInputProviders()	getDigitalInput.
default ProviderGroup<DigitalOutputProvider>	getDigitalOutputProviders()	getDigitalOutput.
default ProviderGroup<I2CProvider>	getI2CProviders()	getI2C.
default ProviderGroup<PwmProvider>	getPwmProviders()	getPwm.
default ProviderGroup<SerialProvider>	getSerialProviders()	getSerial.
default ProviderGroup<SpiProvider>	getSpiProviders()	getSpi.
ProviderGroup<I2CProvider>	i2c()	i2c.
ProviderGroup<PwmProvider>	pwm()	pwm.
ProviderGroup<SerialProvider>	serial()	serial.
ProviderGroup<SpiProvider>	spi()	spi.

Method Details

analogInput

ProviderGroup<AnalogInputProvider> analogInput()

analogInput.

Returns:

a ProviderGroup object.

analogOutput

ProviderGroup<AnalogOutputProvider> analogOutput()

analogOutput.

Returns:

a ProviderGroup object.

digitalInput

ProviderGroup<DigitalInputProvider> digitalInput()

digitalInput.

Returns:

a ProviderGroup object.

digitalOutput

ProviderGroup<DigitalOutputProvider> digitalOutput()

digitalOutput.

Returns:

a ProviderGroup object.

pwm

ProviderGroup<PwmProvider> pwm()

pwm.

Returns:

a ProviderGroup object.

spi

ProviderGroup<SpiProvider> spi()

spi.

Returns:

a ProviderGroup object.

i2c

ProviderGroup<I2CProvider> i2c()

i2c.

Returns:

a ProviderGroup object.

serial

ProviderGroup<SerialProvider> serial()

serial.

Returns:

a ProviderGroup object.

all

Map<String,Provider> all()

Get all providers

Returns:

a Map object.

all

<T extends Provider> Map<String,T> all(Class<T> providerClass)
                                throws ProviderNotFoundException

Get all providers of a specified io class/interface.

Type Parameters:

T - providers extending the Provider interface

Parameters:

providerClass - a Class object.

Returns:

a Map object.

Throws:

ProviderNotFoundException - if any.

all

<T extends Provider> Map<String,T> all(IOType ioType)
                                throws ProviderNotFoundException

Get all providers of a specified io type.

Type Parameters:

T - providers extending the Provider interface

Parameters:

ioType - a IOType object.

Returns:

a Map object.

Throws:

ProviderNotFoundException - if any.

exists

boolean exists(String providerId)

exists.

Parameters:

providerId - a String object.

Returns:

a boolean.

exists

default <T extends Provider> boolean exists(String providerId,
 Class<T> providerClass)

exists.

Type Parameters:

T - a T object.

Parameters:

providerId - a String object.

providerClass - a Class object.

Returns:

a boolean.

exists

default <T extends Provider> boolean exists(String providerId,
 IOType ioType)

exists.

Type Parameters:

T - a T object.

Parameters:

providerId - a String object.

ioType - a IOType object.

Returns:

a boolean.

exists

default <T extends Provider> boolean exists(IOType ioType)

exists.

Type Parameters:

T - a T object.

Parameters:

ioType - a IOType object.

Returns:

a boolean.

exists

default <T extends Provider> boolean exists(Class<T> providerClass)

exists.

Type Parameters:

T - a T object.

Parameters:

providerClass - a Class object.

Returns:

a boolean.

get

<T extends Provider> T get(String providerId)
                    throws ProviderNotFoundException

get.

Type Parameters:

T - a T object.

Parameters:

providerId - a String object.

Returns:

a T object.

Throws:

ProviderNotFoundException - if any.

get

default <T extends Provider> T get(String providerId,
 Class<T> providerClass)
                            throws ProviderNotFoundException,
ProviderTypeException

get.

Type Parameters:

T - a T object.

Parameters:

providerId - a String object.

providerClass - a Class object.

Returns:

a T object.

Throws:

ProviderNotFoundException - if any.

ProviderTypeException - if any.

get

default <T extends Provider> T get(String providerId,
 IOType ioType)
                            throws ProviderNotFoundException,
ProviderIOTypeException

get.

Type Parameters:

T - a T object.

Parameters:

providerId - a String object.

ioType - a IOType object.

Returns:

a T object.

Throws:

ProviderNotFoundException - if any.

ProviderIOTypeException - if any.

get

default <T extends Provider> T get(Class<T> providerClass)
                            throws ProviderNotFoundException

get.

Type Parameters:

T - a T object.

Parameters:

providerClass - a Class object.

Returns:

a T object.

Throws:

ProviderNotFoundException - if any.

get

default <T extends Provider> T get(IOType ioType)
                            throws ProviderNotFoundException

get.

Type Parameters:

T - a T object.

Parameters:

ioType - a IOType object.

Returns:

a T object.

Throws:

ProviderNotFoundException - if any.

getAnalogInputProviders

default ProviderGroup<AnalogInputProvider> getAnalogInputProviders()

getAnalogInput.

Returns:

a ProviderGroup object.

getAnalogOutputProviders

default ProviderGroup<AnalogOutputProvider> getAnalogOutputProviders()

getAnalogOutput.

Returns:

a ProviderGroup object.

getDigitalInputProviders

default ProviderGroup<DigitalInputProvider> getDigitalInputProviders()

getDigitalInput.

Returns:

a ProviderGroup object.

getDigitalOutputProviders

default ProviderGroup<DigitalOutputProvider> getDigitalOutputProviders()

getDigitalOutput.

Returns:

a ProviderGroup object.

getPwmProviders

default ProviderGroup<PwmProvider> getPwmProviders()

getPwm.

Returns:

a ProviderGroup object.

getSpiProviders

default ProviderGroup<SpiProvider> getSpiProviders()

getSpi.

Returns:

a ProviderGroup object.

getI2CProviders

default ProviderGroup<I2CProvider> getI2CProviders()

getI2C.

Returns:

a ProviderGroup object.

getSerialProviders

default ProviderGroup<SerialProvider> getSerialProviders()

getSerial.

Returns:

a ProviderGroup object.

getAll

default Map<String,Provider> getAll()

getAll.

Returns:

a Map object.

getAll

default <T extends Provider> Map<String,T> getAll(Class<T> providerClass)
                                           throws ProviderNotFoundException

getAll.

Type Parameters:

T - a T object.

Parameters:

providerClass - a Class object.

Returns:

a Map object.

Throws:

ProviderNotFoundException - if any.

getAll

default <T extends Provider> Map<String,T> getAll(IOType ioType)
                                           throws ProviderNotFoundException

getAll.

Type Parameters:

T - a T object.

Parameters:

ioType - a IOType object.

Returns:

a Map object.

Throws:

ProviderNotFoundException - if any.

describe

default Descriptor describe()

describe.

Specified by:

describe in interface Describable

Returns:

a Descriptor object.