Package com.pi4j.platform

Enum Platform

java.lang.Object

java.lang.Enum<Platform>

com.pi4j.platform.Platform

All Implemented Interfaces:

Serializable, Comparable<Platform>

public enum Platform
extends Enum<Platform>

This enumeration defines the platforms supported by Pi4J.

Author:

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

See Also:

https://pi4j.com/

Enum Constant Summary

Enum Constants

Enum Constant	Description
RASPBERRYPI
SIMULATED

Field Summary

Fields

Modifier and Type	Field	Description
protected String	label
protected String	platformId

Method Summary

Modifier and Type	Method	Description
static Platform	fromId(String platformId)	Lookup a platform enumeration by the platform's unique identifier string.
GpioProvider	getGpioProvider()
static GpioProvider	getGpioProvider(Platform platform)
I2CFactoryProvider	getI2CFactoryProvider()
static I2CFactoryProvider	getI2CFactoryProvider(Platform platform)
String	getId()	Get the platform's unique identifier string.
String	getLabel()	Get the platform's friendly string name/label.
SystemInfoProvider	getSystemInfoProvider()
static SystemInfoProvider	getSystemInfoProvider(Platform platform)
String	id()	Get the platform's unique identifier string.
String	label()	Get the platform's friendly string name/label.
static Platform	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Platform[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RASPBERRYPI

public static final Platform RASPBERRYPI

SIMULATED

public static final Platform SIMULATED

Field Detail

platformId

protected String platformId

label

protected String label

Method Detail

values

public static Platform[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Platform c : Platform.values())
    System.out.println(c);

Returns:

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

valueOf

public static Platform valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getLabel

public String getLabel()

Get the platform's friendly string name/label.

Returns:

label of platform

label

public String label()

Get the platform's friendly string name/label.

Returns:

label of platform

getId

public String getId()

Get the platform's unique identifier string.

Returns:

platform id string

id

public String id()

Get the platform's unique identifier string.

Returns:

platform id string

fromId

public static Platform fromId(String platformId)

Lookup a platform enumeration by the platform's unique identifier string.

Returns:

platform enumeration

getGpioProvider

public GpioProvider getGpioProvider()

getGpioProvider

public static GpioProvider getGpioProvider(Platform platform)

getI2CFactoryProvider

public I2CFactoryProvider getI2CFactoryProvider()

getI2CFactoryProvider

public static I2CFactoryProvider getI2CFactoryProvider(Platform platform)

getSystemInfoProvider

public SystemInfoProvider getSystemInfoProvider()

getSystemInfoProvider

public static SystemInfoProvider getSystemInfoProvider(Platform platform)