Module com.pi4j

Package com.pi4j.provider

Interface Provider<PROVIDER_TYPE extends Provider,IO_TYPE extends IO,CONFIG_TYPE extends Config>

All Superinterfaces:

Describable, Extension<PROVIDER_TYPE>, Identity, Lifecycle<PROVIDER_TYPE>

All Known Subinterfaces:

AnalogInputProvider, AnalogOutputProvider, AnalogProvider<PROVIDER_TYPE,ANALOG_TYPE,CONFIG_TYPE>, DigitalInputProvider, DigitalOutputProvider, DigitalProvider<PROVIDER_TYPE,DIGITAL_TYPE,CONFIG_TYPE>, com.pi4j.io.gpio.GpioProvider<PROVIDER_TYPE,IO_TYPE,CONFIG_TYPE>, I2CProvider, PwmProvider, SerialProvider, SpiProvider

All Known Implementing Classes:

AnalogInputProviderBase, AnalogOutputProviderBase, AnalogProviderBase, DigitalInputProviderBase, DigitalOutputProviderBase, DigitalProviderBase, com.pi4j.io.gpio.GpioProviderBase, I2CProviderBase, ProviderBase, PwmProviderBase, SerialProviderBase, SpiProviderBase

public interface Provider<PROVIDER_TYPE extends Provider,IO_TYPE extends IO,CONFIG_TYPE extends Config>
extends Extension<PROVIDER_TYPE>

Provider interface.

Version:

$Id: $Id

Author:

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

Method Summary

Modifier and Type	Method	Description
Context	context()
IO_TYPE	create(CONFIG_TYPE config)	create.
default IO_TYPE	create(String id)
default Descriptor	describe()	describe.
default int	getPriority()	Returns the priority for this provider, defaults to 0
default IOType	getType()	getType.
default boolean	isType(IOType type)	isType.
default IOType	type()	type.

Methods inherited from interface com.pi4j.common.Identity

description, getDescription, getId, getMetadata, getName, id, metadata, name

Methods inherited from interface com.pi4j.common.Lifecycle

initialize, shutdown

Method Details

context

Context context()

create

IO_TYPE create(CONFIG_TYPE config)

create.

Parameters:

config - a CONFIG_TYPE object.

Returns:

a IO_TYPE object.

type

default IOType type()

type.

Returns:

a IOType object.

getType

default IOType getType()

getType.

Returns:

a IOType object.

getPriority

default int getPriority()

Returns the priority for this provider, defaults to 0

Returns:

an integer

isType

default boolean isType(IOType type)

isType.

Parameters:

type - a IOType object.

Returns:

a boolean.

describe

default Descriptor describe()

describe.

Specified by:

describe in interface Describable

Specified by:

describe in interface Extension<PROVIDER_TYPE extends Provider>

Specified by:

describe in interface Identity

Returns:

a Descriptor object.

create

default IO_TYPE create(String id)