-
- All Superinterfaces:
Describable
,Extension<Platform>
,Identity
,com.pi4j.internal.IOCreator
,Lifecycle<Platform>
,com.pi4j.internal.ProviderAliases
,com.pi4j.internal.ProviderProvider
- All Known Implementing Classes:
PlatformBase
public interface Platform extends com.pi4j.internal.IOCreator, com.pi4j.internal.ProviderProvider, Extension<Platform>
Platform interface.
- Version:
- $Id: $Id
- Author:
- Robert Savage (http://www.savagehomeautomation.com)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description <I extends IO>
Icreate(IOConfig config, IOType ioType)
<T extends IO>
Tcreate(String id)
<T extends IO>
Tcreate(String id, IOType ioType)
default Descriptor
describe()
describe.boolean
enabled(Context context)
enabled.default <T extends Provider>
booleanhasProvider(IOType ioType)
hasProvider.default <T extends Provider>
booleanhasProvider(Class<T> providerClass)
hasProvider.default boolean
hasProvider(String providerId)
hasProvider.int
priority()
The priority in which platforms must be handled.default <T extends Provider>
Tprovider(IOType ioType)
provider.default <T extends Provider>
Tprovider(Class<T> providerClass)
provider.default <T extends Provider>
Tprovider(String providerId)
provider.default <T extends Provider>
Tprovider(String providerId, Class<T> providerClass)
provider.Map<IOType,Provider>
providers()
providers.-
Methods inherited from interface com.pi4j.common.Identity
description, getDescription, getId, getMetadata, getName, id, metadata, name
-
Methods inherited from interface com.pi4j.internal.IOCreator
create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create
-
Methods inherited from interface com.pi4j.common.Lifecycle
initialize, shutdown
-
Methods inherited from interface com.pi4j.internal.ProviderAliases
ain, analogInput, analogOutput, aout, digitalInput, digitalOutput, din, dout, getAnalogInputProvider, getAnalogOutputProvider, getDigitalInputProvider, getDigitalOutputProvider, getI2CProvider, getPwmProvider, getSerialProvider, getSpiProvider, i2c, pwm, serial, spi
-
-
-
-
Method Detail
-
priority
int priority()
The priority in which platforms must be handled. This will be used to determine which one to use if multiple are provided with the same providers.
- Negative number: used e.g. for a Mock provider
- Low number: very unlikely to be used
- Higher number: very likely to be used
- Returns:
- a int.
-
enabled
boolean enabled(Context context)
enabled.
- Parameters:
context
- aContext
object.- Returns:
- a boolean.
-
provider
default <T extends Provider> T provider(Class<T> providerClass) throws ProviderNotFoundException, ProviderInterfaceException
provider.
- Specified by:
provider
in interfacecom.pi4j.internal.ProviderProvider
- Type Parameters:
T
- a T object.- Parameters:
providerClass
- aClass
object.- Returns:
- a T object.
- Throws:
ProviderNotFoundException
- if any.ProviderInterfaceException
- if any.
-
provider
default <T extends Provider> T provider(IOType ioType) throws ProviderNotFoundException
provider.
- Specified by:
provider
in interfacecom.pi4j.internal.ProviderAliases
- Specified by:
provider
in interfacecom.pi4j.internal.ProviderProvider
- Type Parameters:
T
- a T object.- Parameters:
ioType
- aIOType
object.- Returns:
- a T object.
- Throws:
ProviderNotFoundException
- if the provider specified byioType
can not be found.
-
provider
default <T extends Provider> T provider(String providerId, Class<T> providerClass) throws ProviderNotFoundException
provider.
- Specified by:
provider
in interfacecom.pi4j.internal.ProviderProvider
- Type Parameters:
T
- the provider type- Parameters:
providerId
- aString
object.providerClass
- a T object.- Returns:
- a T object.
- Throws:
ProviderNotFoundException
- if any.
-
provider
default <T extends Provider> T provider(String providerId) throws ProviderNotFoundException
provider.
- Specified by:
provider
in interfacecom.pi4j.internal.ProviderProvider
- Type Parameters:
T
- a T object.- Parameters:
providerId
- aString
object.- Returns:
- a T object.
- Throws:
ProviderNotFoundException
- if any.
-
hasProvider
default boolean hasProvider(String providerId)
hasProvider.
- Specified by:
hasProvider
in interfacecom.pi4j.internal.ProviderProvider
- Parameters:
providerId
- aString
object.- Returns:
- a boolean.
-
hasProvider
default <T extends Provider> boolean hasProvider(Class<T> providerClass)
hasProvider.
- Specified by:
hasProvider
in interfacecom.pi4j.internal.ProviderProvider
- Type Parameters:
T
- a T object.- Parameters:
providerClass
- aClass
object.- Returns:
- a boolean.
-
hasProvider
default <T extends Provider> boolean hasProvider(IOType ioType)
hasProvider.
- Specified by:
hasProvider
in interfacecom.pi4j.internal.ProviderProvider
- Type Parameters:
T
- a T object.- Parameters:
ioType
- aIOType
object.- Returns:
- a boolean.
-
create
<I extends IO> I create(IOConfig config, IOType ioType)
- Specified by:
create
in interfacecom.pi4j.internal.IOCreator
-
create
<T extends IO> T create(String id)
- Specified by:
create
in interfacecom.pi4j.internal.IOCreator
-
create
<T extends IO> T create(String id, IOType ioType)
- Specified by:
create
in interfacecom.pi4j.internal.IOCreator
-
describe
default Descriptor describe()
describe.
- Specified by:
describe
in interfaceDescribable
- Specified by:
describe
in interfaceExtension<Platform>
- Specified by:
describe
in interfaceIdentity
- Returns:
- a
Descriptor
object.
-
-