Module com.pi4j

Package com.pi4j.io.spi

Enum Class SpiBus

java.lang.Object

java.lang.Enum<SpiBus>

com.pi4j.io.spi.SpiBus

All Implemented Interfaces:

Serializable, Comparable<SpiBus>, Constable

public enum SpiBus
extends Enum<SpiBus>

SpiBus 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
BUS_0
BUS_1
BUS_2
BUS_3
BUS_4
BUS_5
BUS_6

Method Summary

Modifier and Type	Method	Description
int	getBus()	Getter for the field bus.
static SpiBus	getByNumber(int busNumber)	getByNumber.
static SpiBus	getByNumber(short busNumber)	getByNumber.
static SpiBus	parse(String bus)	parse.
static SpiBus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SpiBus[]	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

BUS_0

public static final SpiBus BUS_0

BUS_1

public static final SpiBus BUS_1

BUS_2

public static final SpiBus BUS_2

BUS_3

public static final SpiBus BUS_3

BUS_4

public static final SpiBus BUS_4

BUS_5

public static final SpiBus BUS_5

BUS_6

public static final SpiBus BUS_6

Method Details

values

public static SpiBus[] 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 SpiBus 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

getBus

public int getBus()

Getter for the field bus.

Returns:

a int.

getByNumber

public static SpiBus getByNumber(short busNumber)

getByNumber.

Parameters:

busNumber - a short.

Returns:

a SpiBus object.

getByNumber

public static SpiBus getByNumber(int busNumber)

getByNumber.

Parameters:

busNumber - a int.

Returns:

a SpiBus object.

parse

public static SpiBus parse(String bus)

parse.

Parameters:

bus - a String object.

Returns:

a SpiBus object.