edu.illinois.cs.cogcomp.lbjava.io

Class HexOutputStream

java.lang.Object

java.io.OutputStream

edu.illinois.cs.cogcomp.lbjava.io.HexOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class HexOutputStream
extends OutputStream

This class will convert whatever data is sent to it into little endian, hexidecimal text and send that text on to another OutputStream. The most common usage of this class will involve passing it to the constructor of another OutputStream. For instance:

 ObjectOutputStream oos = new ObjectOutputStream(new GZIPOutputStream(new HexOutputStream(
         new FileOutputStream(fileName))));
 

Author:

Nick Rizzolo

See Also:

HexInputStream

Constructor Summary

Constructors

Constructor and Description
HexOutputStream(OutputStream o) Initializes this stream with another output stream.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this output stream and releases any system resources associated with this stream.
void	flush() Flushes this output stream and forces any buffered output bytes to be written out.
void	write(byte[] b) Writes b.length bytes from the specified byte array to this output stream.
void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array starting at offset off to this output stream.
void	write(int b) Writes the specified byte to this output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

HexOutputStream

public HexOutputStream(OutputStream o)

Initializes this stream with another output stream.

Parameters:

o - The output stream to which converted output should be sent.

Method Detail

write

public void write(int b)
           throws IOException

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Specified by:

write in class OutputStream

Parameters:

b - The byte to be written.

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Writes b.length bytes from the specified byte array to this output stream. The general contract for write(b) is that it should have exactly the same effect as the call write(b, 0, b.length).

Overrides:

write in class OutputStream

Parameters:

b - The bytes to be written.

Throws:

IOException

write

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

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Overrides:

write in class OutputStream

Parameters:

b - A buffer containing the bytes to be written.

off - The offset of the first byte to be written.

len - The amount of bytes to be written.

Throws:

IOException

flush

public void flush()
           throws IOException

Flushes this output stream and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException