All Superinterfaces:

Describable, EventProducer, InitializedEventProducer<Context>, com.pi4j.internal.IOCreator, com.pi4j.internal.ProviderAliases, com.pi4j.internal.ProviderProvider, ShutdownEventProducer<Context>
```
public interface Context
extends Describable, com.pi4j.internal.IOCreator, com.pi4j.internal.ProviderProvider, InitializedEventProducer<Context>, ShutdownEventProducer<Context>
```
Context 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
`Future<Context>`	`asyncShutdown()`
`ContextConfig`	`config()`	config.
`default <I extends IO> I`	`create(IOConfig config, IOType ioType)`
`default <T extends IO> T`	`create(String id)`
`default <T extends IO> T`	`create(String id, IOType ioType)`
`default <P extends Platform> P`	`defaultPlatform()`	platform.
`default Descriptor`	`describe()`	describe.
`default <P extends Platform> P`	`getDefaultPlatform()`	platform.
`default <T extends IO> T`	`getIO(String id)`
`default <T extends IO> T`	`getIO(String id, Class<T> ioClass)`
`default <P extends Platform> P`	`getPlatform()`	platform.
`default <P extends Platform> P`	`getPlatform(Class<P> platformClass)`	platform.
`default <P extends Platform> P`	`getPlatform(String id)`	platform.
`default boolean`	`hasIO(String id)`
`default boolean`	`hasPlatform(Class<? extends Platform> platformClass)`	Has platforms.
`default boolean`	`hasPlatform(String id)`	platform.
`default <T extends Provider> boolean`	`hasProvider(IOType ioType)`	hasProvider.
`default <T extends Provider> boolean`	`hasProvider(Class<T> providerClass)`	hasProvider.
`default boolean`	`hasProvider(String providerId)`	hasProvider.
`default <T extends IO> T`	`io(String id)`
`default <T extends IO> T`	`io(String id, Class<T> ioClass)`
`boolean`	`isShutdown()`
`default <P extends Platform> P`	`platform()`	platform.
`default <P extends Platform> P`	`platform(Class<P> platformClass)`	platform.
`default <P extends Platform> P`	`platform(String id)`	platform.
`Platforms`	`platforms()`	platforms.
`ContextProperties`	`properties()`	properties.
`default <T extends Provider> T`	`provider(IOType ioType)`	provider.
`default <T extends Provider> T`	`provider(Class<T> providerClass)`	provider.
`default <T extends Provider> T`	`provider(String providerId)`	provider.
`default <T extends Provider> T`	`provider(String providerId, Class<T> providerClass)`	provider.
`Providers`	`providers()`	providers.
`Registry`	`registry()`	registry.
`Context`	`shutdown()`	shutdown.

Methods inherited from interface com.pi4j.event.InitializedEventProducer
addListener, removeAllInitializedListeners, removeListener

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

Methods inherited from interface com.pi4j.event.ShutdownEventProducer
addListener, removeAllShutdownListeners, removeListener

- Method Detail
 - config
```
ContextConfig config()
```
 config.
 
 Returns:
 
 a ContextConfig object.
 - properties
```
ContextProperties properties()
```
 properties.
 
 Returns:
 
 a ContextProperties object.
 - providers
```
Providers providers()
```
 providers.
 
 Returns:
 
 a Providers object.
 - registry
```
Registry registry()
```
 registry.
 
 Returns:
 
 a Registry object.
 - platforms
```
Platforms platforms()
```
 platforms.
 
 Returns:
 
 a Platforms object.
 - shutdown
```
Context shutdown()
 throws ShutdownException
```
 shutdown.
 
 Returns:
 
 a Context object.
 
 Throws:
 
 ShutdownException - if an error occurs during shutdown.
 - asyncShutdown
```
Future<Context> asyncShutdown()
```
 Returns:
 
 Future of Context
 - isShutdown
```
boolean isShutdown()
```
 Returns:
 
 Flag indicating if the context has been shutdown
 - platform
```
default  P platform()
```
 platform.
 
 Type Parameters:
 
 P - a P object.
 
 Returns:
 
 a P object.
 - getPlatform
```
default  P getPlatform()
```
 platform.
 
 Type Parameters:
 
 P - a P object.
 
 Returns:
 
 a P object.
 - getDefaultPlatform
```
default  P getDefaultPlatform()
```
 platform.
 
 Type Parameters:
 
 P - a P object.
 
 Returns:
 
 a P object.
 - defaultPlatform
```
default  P defaultPlatform()
```
 platform.
 
 Type Parameters:
 
 P - a P object.
 
 Returns:
 
 a P object.
 - platform
```
default  P platform(String id)
 throws PlatformNotFoundException
```
 platform.
 
 Type Parameters:
 
 P - the platform type
 
 Parameters:
 
 id - Id of the platform.
 
 Returns:
 
 a P object.
 
 Throws:
 
 PlatformNotFoundException - if platform specified by id is not found.
 - getPlatform
```
default  P getPlatform(String id)
 throws PlatformNotFoundException
```
 platform.
 
 Type Parameters:
 
 P - the platform type
 
 Parameters:
 
 id - Id of the platform.
 
 Returns:
 
 a P object.
 
 Throws:
 
 PlatformNotFoundException - if platform specified by id is not found.
 - hasPlatform
```
default boolean hasPlatform(String id)
 throws PlatformNotFoundException
```
 platform.
 
 Parameters:
 
 id - Id of the platform.
 
 Returns:
 
 a P object.
 
 Throws:
 
 PlatformNotFoundException - if platform specified by id is not found.
 - platform
```
default  P platform(Class platformClass)
 throws PlatformNotFoundException
```
 platform.
 
 Type Parameters:
 
 P - the platform type
 
 Parameters:
 
 platformClass - a P object.
 
 Returns:
 
 a P object.
 
 Throws:
 
 PlatformNotFoundException - if platform specified by platformClass is not found.
 - getPlatform
```
default  P getPlatform(Class platformClass)
 throws PlatformNotFoundException
```
 platform.
 
 Type Parameters:
 
 P - the platform type
 
 Parameters:
 
 platformClass - a P object.
 
 Returns:
 
 a P object.
 
 Throws:
 
 PlatformNotFoundException - if platform specified by platformClass is not found.
 - hasPlatform
```
default boolean hasPlatform(Class<? extends Platform> platformClass)
 throws PlatformNotFoundException
```
 Has platforms.
 
 Parameters:
 
 platformClass - a P object.
 
 Returns:
 
 boolean
 
 Throws:
 
 PlatformNotFoundException - if platform specified by platformClass is not found.
 - provider
```
default <T extends Provider> T provider(String providerId)
 throws ProviderNotFoundException
```
 provider.
 
 Specified by:
 
 provider in interface com.pi4j.internal.ProviderProvider
 
 Type Parameters:
 
 T - a T object.
 
 Parameters:
 
 providerId - a String object.
 
 Returns:
 
 a T object.
 
 Throws:
 
 ProviderNotFoundException - if any.
 - provider
```
default <T extends Provider> T provider(String providerId,
 Class<T> providerClass)
 throws ProviderNotFoundException
```
 provider.
 
 Specified by:
 
 provider in interface com.pi4j.internal.ProviderProvider
 
 Type Parameters:
 
 T - the provider type
 
 Parameters:
 
 providerId - a String object.
 
 providerClass - a T object.
 
 Returns:
 
 a T object.
 
 Throws:
 
 ProviderNotFoundException - if any.
 - hasProvider
```
default boolean hasProvider(String providerId)
```
 hasProvider.
 
 Specified by:
 
 hasProvider in interface com.pi4j.internal.ProviderProvider
 
 Parameters:
 
 providerId - a String object.
 
 Returns:
 
 a boolean.
 - hasProvider
```
default <T extends Provider> boolean hasProvider(IOType ioType)
```
 hasProvider.
 
 Specified by:
 
 hasProvider in interface com.pi4j.internal.ProviderProvider
 
 Type Parameters:
 
 T - a T object.
 
 Parameters:
 
 ioType - a IOType object.
 
 Returns:
 
 a boolean.
 - hasProvider
```
default <T extends Provider> boolean hasProvider(Class<T> providerClass)
```
 hasProvider.
 
 Specified by:
 
 hasProvider in interface com.pi4j.internal.ProviderProvider
 
 Type Parameters:
 
 T - a T object.
 
 Parameters:
 
 providerClass - a Class object.
 
 Returns:
 
 a boolean.
 - provider
```
default <T extends Provider> T provider(Class<T> providerClass)
 throws ProviderNotFoundException,
 ProviderInterfaceException
```
 provider.
 
 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.
 - provider
```
default <T extends Provider> T provider(IOType ioType)
 throws ProviderNotFoundException
```
 provider.
 
 Specified by:
 
 provider in interface com.pi4j.internal.ProviderAliases
 
 Specified by:
 
 provider in interface com.pi4j.internal.ProviderProvider
 
 Type Parameters:
 
 T - a T object.
 
 Parameters:
 
 ioType - a IOType object.
 
 Returns:
 
 a T object.
 
 Throws:
 
 ProviderNotFoundException - if the provider specified by ioType can not be found.
 - create
```
default  I create(IOConfig config,
 IOType ioType)
```
 Specified by:
 
 create in interface com.pi4j.internal.IOCreator
 - create
```
default <T extends IO> T create(String id)
```
 Specified by:
 
 create in interface com.pi4j.internal.IOCreator
 - create
```
default <T extends IO> T create(String id,
 IOType ioType)
```
 Specified by:
 
 create in interface com.pi4j.internal.IOCreator
 - hasIO
```
default boolean hasIO(String id)
 throws IOInvalidIDException,
 IONotFoundException
```
 Throws:
 
 IOInvalidIDException
 
 IONotFoundException
 - io
```
default <T extends IO> T io(String id)
 throws IOInvalidIDException,
 IONotFoundException
```
 Throws:
 
 IOInvalidIDException
 
 IONotFoundException
 - io
```
default <T extends IO> T io(String id,
 Class<T> ioClass)
 throws IOInvalidIDException,
 IONotFoundException
```
 Throws:
 
 IOInvalidIDException
 
 IONotFoundException
 - getIO
```
default <T extends IO> T getIO(String id)
 throws IOInvalidIDException,
 IONotFoundException
```
 Throws:
 
 IOInvalidIDException
 
 IONotFoundException
 - getIO
```
default <T extends IO> T getIO(String id,
 Class<T> ioClass)
 throws IOInvalidIDException,
 IONotFoundException
```
 Throws:
 
 IOInvalidIDException
 
 IONotFoundException
 - describe
```
default Descriptor describe()
```
 describe.
 
 Specified by:
 
 describe in interface Describable
 
 Returns:
 
 a Descriptor object.

Interface Context

Method Summary

Methods inherited from interface com.pi4j.event.InitializedEventProducer

Methods inherited from interface com.pi4j.internal.IOCreator

Methods inherited from interface com.pi4j.internal.ProviderAliases

Methods inherited from interface com.pi4j.internal.ProviderProvider

Methods inherited from interface com.pi4j.event.ShutdownEventProducer

Method Detail

config

properties

providers

registry

platforms

shutdown

asyncShutdown

isShutdown

platform

getPlatform

getDefaultPlatform

defaultPlatform

platform

getPlatform

hasPlatform

platform

getPlatform

hasPlatform

provider

provider

hasProvider

hasProvider

hasProvider

provider

provider

create

create

create

hasIO

io

io

getIO

getIO

describe