Module com.pi4j

Package com.pi4j.platform

Class PlatformBase<PLATFORM extends Platform>

java.lang.Object

com.pi4j.common.IdentityBase<T>

com.pi4j.extension.ExtensionBase<Platform>

com.pi4j.platform.PlatformBase<PLATFORM>

All Implemented Interfaces:

Describable, Identity, Lifecycle<Platform>, Extension<Platform>, com.pi4j.internal.IOCreator, com.pi4j.internal.ProviderAliases, com.pi4j.internal.ProviderProvider, Platform

public abstract class PlatformBase<PLATFORM extends Platform>
extends ExtensionBase<Platform>
implements Platform

Abstract PlatformBase class.

Version:

$Id: $Id

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	context
protected org.slf4j.Logger	logger
protected Map<IOType,Provider>	providers

Fields inherited from class com.pi4j.common.IdentityBase

description, id, metadata, name

Constructor Summary

Constructors

Constructor	Description
PlatformBase()	Constructor for PlatformBase.
PlatformBase(String id)	Constructor for PlatformBase.
PlatformBase(String id, String name)	Constructor for PlatformBase.
PlatformBase(String id, String name, String description)	Constructor for PlatformBase.

Method Summary

Modifier and Type	Method	Description
protected void	addProvider(Context context, String providerId)	addProvider.
<I extends IO> I	create(IOConfig config, IOType ioType)
<T extends IO> T	create(String id)
<T extends IO> T	create(String id, IOType ioType)
abstract boolean	enabled(Context context)	enabled.
protected abstract String[]	getProviders()	Getter for the field providers.
PLATFORM	initialize(Context context)	initialize.
abstract int	priority()	The priority in which platforms must be handled.
<T extends Provider> T	provider(Class<T> providerClass)	provider.
Map<IOType,Provider>	providers()	providers.
PLATFORM	shutdown(Context context)	shutdown.

Methods inherited from class com.pi4j.common.IdentityBase

description, id, metadata, name

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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.platform.Platform

describe, hasProvider, hasProvider, hasProvider, provider, provider, provider

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

Methods inherited from interface com.pi4j.internal.ProviderProvider

getProvider, getProvider, getProvider, getProvider

Field Detail

context

protected Context context

providers

protected Map<IOType,Provider> providers

logger

protected org.slf4j.Logger logger

Constructor Detail

PlatformBase

public PlatformBase()

Constructor for PlatformBase.

PlatformBase

public PlatformBase(String id)

Constructor for PlatformBase.

Parameters:

id - a String object.

PlatformBase

public PlatformBase(String id,
                    String name)

Constructor for PlatformBase.

Parameters:

id - a String object.

name - a String object.

PlatformBase

public PlatformBase(String id,
                    String name,
                    String description)

Constructor for PlatformBase.

Parameters:

id - a String object.

name - a String object.

description - a String object.

Method Detail

providers

public Map<IOType,Provider> providers()

providers.

Specified by:

providers in interface Platform

Returns:

a Map object.

provider

public <T extends Provider> T provider(Class<T> providerClass)
                                throws ProviderNotFoundException,
                                       ProviderInterfaceException

provider.

Specified by:

provider in interface Platform

Specified by:

provider in interface com.pi4j.internal.ProviderProvider

Type Parameters:

T - a T object.

Parameters:

providerClass - a Class object.

Returns:

a T object.

Throws:

ProviderNotFoundException - if any.

ProviderInterfaceException - if any.

create

public <I extends IO> I create(IOConfig config,
                               IOType ioType)

Specified by:

create in interface com.pi4j.internal.IOCreator

Specified by:

create in interface Platform

create

public <T extends IO> T create(String id)

Specified by:

create in interface com.pi4j.internal.IOCreator

Specified by:

create in interface Platform

create

public <T extends IO> T create(String id,
                               IOType ioType)

Specified by:

create in interface com.pi4j.internal.IOCreator

Specified by:

create in interface Platform

priority

public abstract 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

Specified by:

priority in interface Platform

Returns:

a int.

enabled

public abstract boolean enabled(Context context)

enabled.

Specified by:

enabled in interface Platform

Parameters:

context - a Context object.

Returns:

a boolean.

initialize

public PLATFORM initialize(Context context)
                    throws InitializeException

initialize.

Specified by:

initialize in interface Lifecycle<PLATFORM extends Platform>

Parameters:

context - a Context object.

Returns:

a T object.

Throws:

InitializeException - if an error occurs during initialization.

shutdown

public PLATFORM shutdown(Context context)
                  throws ShutdownException

shutdown.

Specified by:

shutdown in interface Lifecycle<PLATFORM extends Platform>

Parameters:

context - a Context object.

Returns:

a T object.

Throws:

ShutdownException - if an error occurs during shutdown.

getProviders

protected abstract String[] getProviders()

Getter for the field providers.

Returns:

an array of String objects.

addProvider

protected void addProvider(Context context,
                           String providerId)
                    throws ProviderException

addProvider.

Parameters:

context - a Context object.

providerId - a String object.

Throws:

ProviderException - if any.