Module com.pi4j
Package com.pi4j.io
Class IOBase<IO_TYPE extends IO,CONFIG_TYPE extends IOConfig,PROVIDER_TYPE extends Provider>
- java.lang.Object
-
- com.pi4j.common.IdentityBase
-
- com.pi4j.io.IOBase<IO_TYPE,CONFIG_TYPE,PROVIDER_TYPE>
-
- All Implemented Interfaces:
Describable
,Identity
,Lifecycle
,Extension
,IO<IO_TYPE,CONFIG_TYPE,PROVIDER_TYPE>
- Direct Known Subclasses:
com.pi4j.io.gpio.GpioBase
,I2CBase
,PwmBase
,SerialBase
,SpiBase
public abstract class IOBase<IO_TYPE extends IO,CONFIG_TYPE extends IOConfig,PROVIDER_TYPE extends Provider> extends IdentityBase implements IO<IO_TYPE,CONFIG_TYPE,PROVIDER_TYPE>
Abstract IOBase class.
- Version:
- $Id: $Id
- Author:
- Robert Savage (http://www.savagehomeautomation.com)
-
-
Field Summary
Fields Modifier and Type Field Description protected CONFIG_TYPE
config
protected PROVIDER_TYPE
provider
-
Fields inherited from class com.pi4j.common.IdentityBase
description, id, logger, metadata, name
-
-
Constructor Summary
Constructors Constructor Description IOBase(PROVIDER_TYPE provider, CONFIG_TYPE config)
Constructor for IOBase.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CONFIG_TYPE
config()
config.Descriptor
describe()
describe.IO_TYPE
description(String description)
description.IO_TYPE
initialize(Context context)
initialize.IO_TYPE
name(String name)
name.PROVIDER_TYPE
provider()
provider.IO_TYPE
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
-
-
-
-
Field Detail
-
config
protected CONFIG_TYPE extends IOConfig config
-
provider
protected PROVIDER_TYPE extends Provider provider
-
-
Constructor Detail
-
IOBase
public IOBase(PROVIDER_TYPE provider, CONFIG_TYPE config)
Constructor for IOBase.
- Parameters:
provider
- a PROVIDER_TYPE object.config
- a CONFIG_TYPE object.
-
-
Method Detail
-
provider
public PROVIDER_TYPE provider()
provider.
- Specified by:
provider
in interfaceIO<IO_TYPE extends IO,CONFIG_TYPE extends IOConfig,PROVIDER_TYPE extends Provider>
- Returns:
- a PROVIDER_TYPE object.
-
name
public IO_TYPE name(String name)
name.
- Specified by:
name
in interfaceIO<IO_TYPE extends IO,CONFIG_TYPE extends IOConfig,PROVIDER_TYPE extends Provider>
- Parameters:
name
- aString
object.- Returns:
- a IO_TYPE object.
-
description
public IO_TYPE description(String description)
description.
- Specified by:
description
in interfaceIO<IO_TYPE extends IO,CONFIG_TYPE extends IOConfig,PROVIDER_TYPE extends Provider>
- Parameters:
description
- aString
object.- Returns:
- a IO_TYPE object.
-
config
public CONFIG_TYPE config()
config.
- Specified by:
config
in interfaceIO<IO_TYPE extends IO,CONFIG_TYPE extends IOConfig,PROVIDER_TYPE extends Provider>
- Returns:
- a CONFIG_TYPE object.
-
initialize
public IO_TYPE initialize(Context context) throws InitializeException
initialize.
- Specified by:
initialize
in interfaceLifecycle<IO_TYPE extends IO>
- Parameters:
context
- aContext
object.- Returns:
- a T object.
- Throws:
InitializeException
- if an error occurs during initialization.
-
shutdown
public IO_TYPE shutdown(Context context) throws ShutdownException
shutdown.
-
describe
public Descriptor describe()
describe.
- Specified by:
describe
in interfaceDescribable
- Specified by:
describe
in interfaceExtension<IO_TYPE extends IO>
- Specified by:
describe
in interfaceIdentity
- Returns:
- a
Descriptor
object.
-
-