Module com.pi4j

Package com.pi4j.io

Enum Class IOType

java.lang.Object

java.lang.Enum<IOType>

com.pi4j.io.IOType

All Implemented Interfaces:

Serializable, Comparable<IOType>, Constable

public enum IOType
extends Enum<IOType>

IOType class.

Version:

$Id: $Id

Author:

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

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANALOG_INPUT
ANALOG_OUTPUT
DIGITAL_INPUT
DIGITAL_OUTPUT
I2C
PWM
SERIAL
SPI

Method Summary

Modifier and Type	Method	Description
static IOType	getByConfigClass(Class<? extends IOConfig> configClass)	getByConfigClass.
static IOType	getByIO(IO io)	getByIO.
static IOType	getByIO(Provider provider)	getByIO.
static IOType	getByIOClass(Class<? extends IO> ioClass)	getByIOClass.
static IOType	getByProviderClass(Class<? extends Provider> providerClass)	getByProviderClass.
static IOType	getByProviderClass(String name)	getByProviderClass.
Class<? extends IOConfigBuilder>	getConfigBuilderClass()	Getter for the field configBuilderClass.
Class<? extends IOConfig>	getConfigClass()	Getter for the field configClass.
static Class<? extends IOConfig>	getConfigClass(IOType type)	Getter for the field configClass.
Class<? extends IO>	getIOClass()	getIOClass.
static Class<? extends IO>	getIOClass(IOType type)	getIOClass.
Class<? extends Provider>	getProviderClass()	Getter for the field providerClass.
static Class<? extends Provider>	getProviderClass(IOType type)	Getter for the field providerClass.
boolean	isType(IOType type)	isType.
<CB extends IOConfigBuilder> CB	newConfigBuilder(Context context)
static IOType	parse(String ioType)	parse.
static IOType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IOType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ANALOG_INPUT

public static final IOType ANALOG_INPUT

ANALOG_OUTPUT

public static final IOType ANALOG_OUTPUT

DIGITAL_INPUT

public static final IOType DIGITAL_INPUT

DIGITAL_OUTPUT

public static final IOType DIGITAL_OUTPUT

PWM

public static final IOType PWM

I2C

public static final IOType I2C

SPI

public static final IOType SPI

SERIAL

public static final IOType SERIAL

Method Details

values

public static IOType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static IOType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getProviderClass

public Class<? extends Provider> getProviderClass()

Getter for the field providerClass.

Returns:

a Class object.

getIOClass

public Class<? extends IO> getIOClass()

getIOClass.

Returns:

a Class object.

getConfigClass

public Class<? extends IOConfig> getConfigClass()

Getter for the field configClass.

Returns:

a Class object.

getConfigBuilderClass

public Class<? extends IOConfigBuilder> getConfigBuilderClass()

Getter for the field configBuilderClass.

Returns:

a Class object.

newConfigBuilder

public <CB extends IOConfigBuilder> CB newConfigBuilder(Context context)

isType

public boolean isType(IOType type)

isType.

Parameters:

type - a IOType object.

Returns:

a boolean.

getIOClass

public static Class<? extends IO> getIOClass(IOType type)

getIOClass.

Parameters:

type - a IOType object.

Returns:

a Class object.

getProviderClass

public static Class<? extends Provider> getProviderClass(IOType type)

Getter for the field providerClass.

Parameters:

type - a IOType object.

Returns:

a Class object.

getConfigClass

public static Class<? extends IOConfig> getConfigClass(IOType type)

Getter for the field configClass.

Parameters:

type - a IOType object.

Returns:

a Class object.

getByProviderClass

public static IOType getByProviderClass(String name)

getByProviderClass.

Parameters:

name - a String object.

Returns:

a IOType object.

getByIO

public static IOType getByIO(Provider provider)

getByIO.

Parameters:

provider - a Provider object.

Returns:

a IOType object.

getByProviderClass

public static IOType getByProviderClass(Class<? extends Provider> providerClass)

getByProviderClass.

Parameters:

providerClass - a Class object.

Returns:

a IOType object.

getByIO

public static IOType getByIO(IO io)

getByIO.

Parameters:

io - a IO object.

Returns:

a IOType object.

getByIOClass

public static IOType getByIOClass(Class<? extends IO> ioClass)

getByIOClass.

Parameters:

ioClass - a Class object.

Returns:

a IOType object.

getByConfigClass

public static IOType getByConfigClass(Class<? extends IOConfig> configClass)

getByConfigClass.

Parameters:

configClass - a Class object.

Returns:

a IOType object.

parse

public static IOType parse(String ioType)

parse.

Parameters:

ioType - a String object.

Returns:

a IOType object.