javax.comm
Class CommPort

java.lang.Object
  javax.comm.CommPort

Direct Known Subclasses:

ParallelPort, SerialPort

public abstract class CommPort
extends java.lang.Object

Version:

1.0.0

Field Summary

protected java.lang.String

name Define the name (String) field.

Constructor Summary

CommPort()

Method Summary

void	close() Close.
abstract void	disableReceiveFraming() Disable receive framing.
abstract void	disableReceiveThreshold() Disable receive threshold.
abstract void	disableReceiveTimeout() Disable receive timeout.
abstract void	enableReceiveFraming(int framingByte) Enable receive framing with the specified framing byte parameter.
abstract void	enableReceiveThreshold(int thresh) Enable receive threshold with the specified thresh parameter.
abstract void	enableReceiveTimeout(int rcvTimeout) Enable receive timeout with the specified rcv timeout parameter.
abstract int	getInputBufferSize() Gets the input buffer size (int) value.
abstract java.io.InputStream	getInputStream() Gets the input stream value.
java.lang.String	getName() Gets the name (String) value.
abstract int	getOutputBufferSize() Gets the output buffer size (int) value.
abstract java.io.OutputStream	getOutputStream() Gets the output stream value.
abstract int	getReceiveFramingByte() Gets the receive framing byte (int) value.
abstract int	getReceiveThreshold() Gets the receive threshold (int) value.
abstract int	getReceiveTimeout() Gets the receive timeout (int) value.
abstract boolean	isReceiveFramingEnabled() Gets the receive framing enabled (boolean) value.
abstract boolean	isReceiveThresholdEnabled() Gets the receive threshold enabled (boolean) value.
abstract boolean	isReceiveTimeoutEnabled() Gets the receive timeout enabled (boolean) value.
abstract void	setInputBufferSize(int size) Sets the input buffer size value.
abstract void	setOutputBufferSize(int size) Sets the output buffer size value.
java.lang.String	toString() Returns the string value.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

Define the name (String) field.

Constructor Detail

CommPort

public CommPort()

Method Detail

close

public void close()

Close.

disableReceiveFraming

public abstract void disableReceiveFraming()

Disable receive framing.

See Also:

enableReceiveFraming(int)

disableReceiveThreshold

public abstract void disableReceiveThreshold()

Disable receive threshold.

See Also:

enableReceiveThreshold(int), getReceiveThreshold()

disableReceiveTimeout

public abstract void disableReceiveTimeout()

Disable receive timeout.

See Also:

enableReceiveTimeout(int), getReceiveTimeout()

enableReceiveFraming

public abstract void enableReceiveFraming(int framingByte)
                                   throws UnsupportedCommOperationException

Enable receive framing with the specified framing byte parameter.

Parameters:

framingByte - The framing byte (int) parameter.

Throws:

UnsupportedCommOperationException - Unsupported Comm Operation Exception.

See Also:

disableReceiveFraming()

enableReceiveThreshold

public abstract void enableReceiveThreshold(int thresh)
                                     throws UnsupportedCommOperationException

Enable receive threshold with the specified thresh parameter.

Parameters:

thresh - The thresh (int) parameter.

Throws:

UnsupportedCommOperationException - Unsupported Comm Operation Exception.

See Also:

disableReceiveThreshold(), getReceiveThreshold()

enableReceiveTimeout

public abstract void enableReceiveTimeout(int rcvTimeout)
                                   throws UnsupportedCommOperationException

Enable receive timeout with the specified rcv timeout parameter.

Parameters:

rcvTimeout - The rcv timeout (int) parameter.

Throws:

UnsupportedCommOperationException - Unsupported Comm Operation Exception.

See Also:

disableReceiveTimeout(), getReceiveTimeout()

getInputBufferSize

public abstract int getInputBufferSize()

Gets the input buffer size (int) value.

Returns:

The input buffer size (int) value.

See Also:

setInputBufferSize(int)

getInputStream

public abstract java.io.InputStream getInputStream()
                                            throws java.io.IOException

Gets the input stream value.

Returns:

The input stream (InputStream) value.

Throws:

IOException.

java.io.IOException

getName

public java.lang.String getName()

Gets the name (String) value.

Returns:

The name (String) value.

getOutputBufferSize

public abstract int getOutputBufferSize()

Gets the output buffer size (int) value.

Returns:

The output buffer size (int) value.

See Also:

setOutputBufferSize(int)

getOutputStream

public abstract java.io.OutputStream getOutputStream()
                                              throws java.io.IOException

Gets the output stream value.

Returns:

The output stream (OutputStream) value.

Throws:

IOException.

java.io.IOException

getReceiveFramingByte

public abstract int getReceiveFramingByte()

Gets the receive framing byte (int) value.

Returns:

The receive framing byte (int) value.

getReceiveThreshold

public abstract int getReceiveThreshold()

Gets the receive threshold (int) value.

Returns:

The receive threshold (int) value.

See Also:

disableReceiveThreshold(), enableReceiveThreshold(int)

getReceiveTimeout

public abstract int getReceiveTimeout()

Gets the receive timeout (int) value.

Returns:

The receive timeout (int) value.

See Also:

disableReceiveTimeout(), enableReceiveTimeout(int)

isReceiveFramingEnabled

public abstract boolean isReceiveFramingEnabled()

Gets the receive framing enabled (boolean) value.

Returns:

The receive framing enabled (boolean) value.

isReceiveThresholdEnabled

public abstract boolean isReceiveThresholdEnabled()

Gets the receive threshold enabled (boolean) value.

Returns:

The receive threshold enabled (boolean) value.

isReceiveTimeoutEnabled

public abstract boolean isReceiveTimeoutEnabled()

Gets the receive timeout enabled (boolean) value.

Returns:

The receive timeout enabled (boolean) value.

setInputBufferSize

public abstract void setInputBufferSize(int size)

Sets the input buffer size value.

Parameters:

size - The size (int) parameter.

See Also:

getInputBufferSize()

setOutputBufferSize

public abstract void setOutputBufferSize(int size)

Sets the output buffer size value.

Parameters:

size - The size (int) parameter.

See Also:

getOutputBufferSize()

toString

public java.lang.String toString()

Returns the string value.

Overrides:

toString in class java.lang.Object

Returns:

The string (String) value.