javax.comm.sample
Class SerialParameters

java.lang.Object
  javax.comm.sample.SerialParameters

public class SerialParameters

extends Object

A class that stores parameters for serial ports.

Constructor Summary

SerialParameters()
Default constructer.

SerialParameters(String portName, int baudRate, int flowControlIn, int flowControlOut, int databits, int stopbits, int parity)
Paramaterized constructer.

Method Summary

int	getBaudRate() Gets baud rate as an int.
String	getBaudRateString() Gets baud rate as a String.
int	getDatabits() Gets data bits as an int.
String	getDatabitsString() Gets data bits as a String.
int	getFlowControlIn() Gets flow control for reading as an int.
String	getFlowControlInString() Gets flow control for reading as a String.
int	getFlowControlOut() Gets flow control for writing as an int.
String	getFlowControlOutString() Gets flow control for writing as a String.
int	getParity() Gets parity setting as an int.
String	getParityString() Gets parity setting as a String.
String	getPortName() Gets port name.
int	getStopbits() Gets stop bits setting as an int.
String	getStopbitsString() Gets stop bits setting as a String.
void	setBaudRate(int baudRate) Sets baud rate.
void	setBaudRate(String baudRate) Sets baud rate.
void	setDatabits(int databits) Sets data bits.
void	setDatabits(String databits) Sets data bits.
void	setFlowControlIn(int flowControlIn) Sets flow control for reading.
void	setFlowControlIn(String flowControlIn) Sets flow control for reading.
void	setFlowControlOut(int flowControlOut) Sets flow control for writing.
void	setFlowControlOut(String flowControlOut) Sets flow control for writing.
void	setParity(int parity) Sets parity setting.
void	setParity(String parity) Sets parity setting.
void	setPortName(String portName) Sets port name.
void	setStopbits(int stopbits) Sets stop bits.
void	setStopbits(String stopbits) Sets stop bits.

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialParameters

public SerialParameters()

Default constructer. Sets parameters to no port, 9600 baud, no flow control, 8 data bits, 1 stop bit, no parity.

SerialParameters

public SerialParameters(String portName,
                        int baudRate,
                        int flowControlIn,
                        int flowControlOut,
                        int databits,
                        int stopbits,
                        int parity)

Paramaterized constructer.

Parameters:

portName - The name of the port.

baudRate - The baud rate.

flowControlIn - Type of flow control for receiving.

flowControlOut - Type of flow control for sending.

databits - The number of data bits.

stopbits - The number of stop bits.

parity - The type of parity.

Method Detail

setPortName

public void setPortName(String portName)

Sets port name.

Parameters:

portName - New port name.

getPortName

public String getPortName()

Gets port name.

Returns:

Current port name.

setBaudRate

public void setBaudRate(int baudRate)

Sets baud rate.

Parameters:

baudRate - New baud rate.

setBaudRate

public void setBaudRate(String baudRate)

Sets baud rate.

Parameters:

baudRate - New baud rate.

getBaudRate

public int getBaudRate()

Gets baud rate as an int.

Returns:

Current baud rate.

getBaudRateString

public String getBaudRateString()

Gets baud rate as a String.

Returns:

Current baud rate.

setFlowControlIn

public void setFlowControlIn(int flowControlIn)

Sets flow control for reading.

Parameters:

flowControlIn - New flow control for reading type.

setFlowControlIn

public void setFlowControlIn(String flowControlIn)

Sets flow control for reading.

Parameters:

flowControlIn - New flow control for reading type.

getFlowControlIn

public int getFlowControlIn()

Gets flow control for reading as an int.

Returns:

Current flow control type.

getFlowControlInString

public String getFlowControlInString()

Gets flow control for reading as a String.

Returns:

Current flow control type.

setFlowControlOut

public void setFlowControlOut(int flowControlOut)

Sets flow control for writing.

setFlowControlOut

public void setFlowControlOut(String flowControlOut)

Sets flow control for writing.

getFlowControlOut

public int getFlowControlOut()

Gets flow control for writing as an int.

Returns:

Current flow control type.

getFlowControlOutString

public String getFlowControlOutString()

Gets flow control for writing as a String.

Returns:

Current flow control type.

setDatabits

public void setDatabits(int databits)

Sets data bits.

Parameters:

databits - New data bits setting.

setDatabits

public void setDatabits(String databits)

Sets data bits.

Parameters:

databits - New data bits setting.

getDatabits

public int getDatabits()

Gets data bits as an int.

Returns:

Current data bits setting.

getDatabitsString

public String getDatabitsString()

Gets data bits as a String.

Returns:

Current data bits setting.

setStopbits

public void setStopbits(int stopbits)

Sets stop bits.

Parameters:

stopbits - New stop bits setting.

setStopbits

public void setStopbits(String stopbits)

Sets stop bits.

Parameters:

stopbits - New stop bits setting.

getStopbits

public int getStopbits()

Gets stop bits setting as an int.

Returns:

Current stop bits setting.

getStopbitsString

public String getStopbitsString()

Gets stop bits setting as a String.

Returns:

Current stop bits setting.

setParity

public void setParity(int parity)

Sets parity setting.

Parameters:

parity - New parity setting.

setParity

public void setParity(String parity)

Sets parity setting.

Parameters:

parity - New parity setting.

getParity

public int getParity()

Gets parity setting as an int.

Returns:

Current parity setting.

getParityString

public String getParityString()

Gets parity setting as a String.

Returns:

Current parity setting.