Module com.pi4j

Package com.pi4j.io.serial

Class SerialBase

java.lang.Object

com.pi4j.common.IdentityBase

com.pi4j.io.IOBase<Serial,SerialConfig,SerialProvider>

com.pi4j.io.serial.SerialBase

All Implemented Interfaces:

Describable, Identity, Lifecycle, Extension, IO<Serial,SerialConfig,SerialProvider>, IODataReader, IODataWriter, Serial, AutoCloseable, Readable

public abstract class SerialBase
extends IOBase<Serial,SerialConfig,SerialProvider>
implements Serial

Abstract SerialBase class.

Version:

$Id: $Id

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isOpen

Fields inherited from class com.pi4j.io.IOBase

config, provider

Fields inherited from class com.pi4j.common.IdentityBase

description, id, metadata, name

Fields inherited from interface com.pi4j.io.serial.Serial

DEFAULT_BAUD, DEFAULT_DATA_BITS, DEFAULT_FLOW_CONTROL, DEFAULT_PARITY, DEFAULT_STOP_BITS

Constructor Summary

Constructors

Constructor	Description
SerialBase(SerialProvider provider, SerialConfig config)	Constructor for SerialBase.

Method Summary

Modifier and Type	Method	Description
void	close()	close.
boolean	isOpen()	Serial Device Communication State is OPEN
void	open()	open.

Methods inherited from class com.pi4j.io.IOBase

config, describe, description, initialize, name, provider, shutdown

Methods inherited from class com.pi4j.common.IdentityBase

description, id, metadata, name

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.pi4j.common.Identity

description, getDescription, getId, getMetadata, getName, id, metadata, name

Methods inherited from interface com.pi4j.io.IO

config, description, name, provider, type

Methods inherited from interface com.pi4j.io.IODataReader

getInputStream, in, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, readByte, readByteBuffer, readByteBuffer, readCharArray, readCharArray, readCharArray, readCharArray, readCharBuffer, readCharBuffer, readCharBuffer, readCharBuffer, readNBytes, readNBytes, readString, readString, readString, readString

Methods inherited from interface com.pi4j.io.IODataWriter

getOutputStream, out, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write

Methods inherited from interface com.pi4j.common.Lifecycle

initialize, shutdown

Methods inherited from interface com.pi4j.io.serial.Serial

available, drain

Field Details

isOpen

protected boolean isOpen

Constructor Details

SerialBase

public SerialBase(SerialProvider provider,
 SerialConfig config)

Constructor for SerialBase.

Parameters:

provider - a SerialProvider object.

config - a SerialConfig object.

Method Details

isOpen

public boolean isOpen()

Serial Device Communication State is OPEN

Specified by:

isOpen in interface Serial

Returns:

The Serial device communication state

open

public void open()

open.

Specified by:

open in interface Serial

close

public void close()

close.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Serial