Module com.pi4j

Package com.pi4j.io.spi

Enum Class SpiMode

java.lang.Object

java.lang.Enum<SpiMode>

com.pi4j.io.spi.SpiMode

All Implemented Interfaces:

Serializable, Comparable<SpiMode>, Constable

public enum SpiMode
extends Enum<SpiMode>

SpiMode 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
MODE_0
MODE_1
MODE_2
MODE_3

Method Summary

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

MODE_0

public static final SpiMode MODE_0

MODE_1

public static final SpiMode MODE_1

MODE_2

public static final SpiMode MODE_2

MODE_3

public static final SpiMode MODE_3

Method Details

values

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

getMode

public int getMode()

Getter for the field mode.

Returns:

a int.

getByNumber

public static SpiMode getByNumber(short modeNumber)

getByNumber.

Parameters:

modeNumber - a short.

Returns:

a SpiMode object.

getByNumber

public static SpiMode getByNumber(int modeNumber)

getByNumber.

Parameters:

modeNumber - a int.

Returns:

a SpiMode object.

parse

public static SpiMode parse(String mode)

parse.

Parameters:

mode - a String object.

Returns:

a SpiMode object.