de.frame4j.io

Class SerialDefs.Helper

java.lang.Object

de.frame4j.io.SerialDefs.Helper

Enclosing interface:

SerialDefs

public static final class SerialDefs.Helper
extends Object

Implementation of (helper) methods for serial ports.

Copyright and version see enclosing interface SerialDefs.

Method Summary

Modifier and Type	Method and Description
static int	asParity(CharSequence parityString) Interpret a character sequence as parity specification.
static int	baudRate(int baudIndex) Determine the baud rate from an baud index.
static String	eventAsString(int eventType) Event type as String.
static StringBuilder	flowControlAsText(StringBuilder bastel, int flowControlMode) Data flow control mode as String.
static SerialDefs	newInstance(CharSequence implClass, CharSequence portName) Fetch an object on an implementing class, optionally open the port.
static String	parityAsString(int parity) Parity as String.
static StringBuilder	stateAsString(StringBuilder sb, SerialDefs port) Text representation of the interface's state.

Methods inherited from class java.lang.Object

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

Method Detail

parityAsString

public static String parityAsString(int parity)

Parity as String.

Depending of the parameter value's equality with the relevant constant values "mark", "space", "odd", "even" or "none" will be returned.
If the parameter is no legal parity constant (in the sense of SerialDefs) "--" is returned.

See Also:

SerialDefs.parityAsString(), SerialDefs.PARITY_EVEN

eventAsString

public static String eventAsString(int eventType)

Event type as String.

Depending of the parameter value's equality with the relevant constants PE, FE, OE and so on human readable texts like "parity error", "output buffer empty" and so on are returned. For no match to SerialDefs's event type constants "none" is returned.

flowControlAsText

public static StringBuilder flowControlAsText(StringBuilder bastel,
                                              int flowControlMode)

Data flow control mode as String.

The value (or partly only the lower 4 bits) of the parameter flowControlMode will be interpreted according to SerialDefs's flow control constants and appended as character sequence to bastel.

Parameters:

bastel - StringBuilder to append to; if null bastel is made with an initial capacity of 20

flowControlMode - see SerialDefs

Returns:

bastel

stateAsString

public static StringBuilder stateAsString(StringBuilder sb,
                                          SerialDefs port)

Text representation of the interface's state.

The interface's state will be appended to sb as three line text.

Parameters:

sb - StringBuilder to append to; if null sb is made with initial capacity of 180

port - the implementation, the state of which shall be reported

Returns:

sb

asParity

public static int asParity(CharSequence parityString)

Interpret a character sequence as parity specification.

The character sequences NONE, ODD, EVEN, MARK and SPACE (without regarding case or surrounding white space) will be interpreted as a SerialDefs parity constant and its value returned.

If not to be interpreted (by first three character match) -1 is returned.

See Also:

SerialDefs.PARITY_MARK, TextHelper.trimUq(CharSequence, String)

baudRate

public static int baudRate(int baudIndex)

Determine the baud rate from an baud index.

Values of the parameter baudIndex in the range 0 to 12 will be interpreted as the number / index of one of the usual (standard) baud rates:
110, 150, 300, 600, 1200, 2400, 4800, 9600, 19200, [0 .. 8]
28800, 38400, 57600 and 115200 [9 .. 12].
The corresponding rate will be returned.

Parameter (baudIndex) values >= 60 will be returned unchanged as they may be special baut rates.
Other parameter values (below 60) return -1.

Parameters:

baudIndex - Index 0..12 or itself a rate (if >= 60)

Returns:

Baudrate

newInstance

public static SerialDefs newInstance(CharSequence implClass,
                                     CharSequence portName)

Fetch an object on an implementing class, optionally open the port.

It will be tried to get an (not opened) object of a class implementing SerialDefs making it by its parameterless Constructor. If the parameter implClass does not denominate a fitting class "de.frame4j.io.SerNimpl" will be taken.

Hint: The class used in the end may / should be checked by getClass.getName().

If the making of the not opened SerialDefs object fails, null is returned.

If the parameter portName is not empty it will be tried to connect the SerialDefs object just made by openSerial(portName). The parameter portName may also be a list (according to the rules of the method prepParams(portName, null, false)) of port names. that will be tried one by one until success or end of list.

Hint: The success of the trial to open / to connect can be checked by isReady() of the object returned. In the case of a supplied port name list getPortName() will return the single port name used / connected to in the end.

Parameters:

implClass - the implementing classes name; default is de.frame4j.io.SerNimpl

portName - operation system / platform name or names of the serial port to optionally connect; e.g "COM2" or a list like "COM2 serialB"; null or empty means no opening connecting to be tried by using SerialDefs.openSerial(portName)

Returns:

the ordered SerialDefs object

See Also:

TextHelper.prepParams(CharSequence, String, boolean)