Module com.pi4j

Package com.pi4j.io.serial

Enum FlowControl

java.lang.Object

java.lang.Enum<FlowControl>

com.pi4j.io.serial.FlowControl

All Implemented Interfaces:

Serializable, Comparable<FlowControl>

public enum FlowControl
extends Enum<FlowControl>

FlowControl class.

Version:

$Id: $Id

Author:

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

Enum Constant Summary

Enum Constants

Enum Constant	Description
HARDWARE
NONE
SOFTWARE

Method Summary

Modifier and Type	Method	Description
int	getIndex()	Getter for the field index.
static FlowControl	getInstance(int control)	getInstance.
static FlowControl	getInstance(String flow_control)	getInstance.
static FlowControl	parse(String parity)	parse.
static FlowControl	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FlowControl[]	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

NONE

public static final FlowControl NONE

HARDWARE

public static final FlowControl HARDWARE

SOFTWARE

public static final FlowControl SOFTWARE

Method Detail

values

public static FlowControl[] 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 (FlowControl c : FlowControl.values())
    System.out.println(c);

Returns:

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

valueOf

public static FlowControl 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

getIndex

public int getIndex()

Getter for the field index.

Returns:

a int.

getInstance

public static FlowControl getInstance(String flow_control)

getInstance.

Parameters:

flow_control - a String object.

Returns:

a FlowControl object.

getInstance

public static FlowControl getInstance(int control)

getInstance.

Parameters:

control - a int.

Returns:

a FlowControl object.

parse

public static FlowControl parse(String parity)

parse.

Parameters:

parity - a String object.

Returns:

a FlowControl object.