net.wimpi.modbus.io

Class ASCIIOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

net.wimpi.modbus.io.ASCIIOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class ASCIIOutputStream
extends FilterOutputStream

Class implementing a specialized OutputStream which encodes bytes written to the stream into two hexadecimal characters each. Note that the "virtual" characters FRAME_START and FRAME_END are exceptions, they are translated to the respective characters as given by the specification.

Version:

1.2

Author:

Dieter Wimberger

See Also:

net.wimpi.modbus.io.ModbusASCIITransport#FRAME_START, net.wimpi.modbus.io.ModbusASCIITransport#FRAME_END

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
ASCIIOutputStream(OutputStream out) Constructs a new ASCIIOutputStream instance writing to the given OutputStream.

Method Summary

Modifier and Type	Method and Description
void	write(byte[] data) Writes an array of bytes encoded as two hexadecimal characters to the raw output stream.
void	write(byte[] data, int off, int len) Writes an array of bytes encoded as two hexadecimal characters to the raw output stream.
void	write(int b) Writes a byte encoded as two hexadecimal characters to the raw output stream.

Methods inherited from class java.io.FilterOutputStream

close, flush

Methods inherited from class java.lang.Object

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

Constructor Detail

ASCIIOutputStream

public ASCIIOutputStream(OutputStream out)

Constructs a new ASCIIOutputStream instance writing to the given OutputStream.

Parameters:

out - a base output stream instance to be wrapped.

Method Detail

write

public void write(int b)
           throws IOException

Writes a byte encoded as two hexadecimal characters to the raw output stream.

Overrides:

write in class FilterOutputStream

Parameters:

b - the byte to be written as int.

Throws:

IOException - if an I/O error occurs.

write

public void write(byte[] data)
           throws IOException

Writes an array of bytes encoded as two hexadecimal characters to the raw output stream.

Overrides:

write in class FilterOutputStream

Parameters:

data - the byte[] to be written.

Throws:

IOException - if an I/O error occurs.

write

public void write(byte[] data,
                  int off,
                  int len)
           throws IOException

Writes an array of bytes encoded as two hexadecimal characters to the raw output stream.

Overrides:

write in class FilterOutputStream

Parameters:

data - the byte[] to be written.

off - the offset into the data to start writing from.

len - the number of bytes to be written from off.

Throws:

IOException - if an I/O error occurs.