com.purplehillsbooks.streams

Class UUDecoderStream

java.lang.Object

java.io.InputStream

com.purplehillsbooks.streams.UUDecoderStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class UUDecoderStream
extends java.io.InputStream

Given an InputStream to read a raw NNTP message body, this will decode the UUEncoding and give you the decoded result of what the body was holding. (generally the result is a binary file stream) The format of the file is: begin {mode} {file}{newline} {length byte}{formatted bytes}{newline} {length byte}{formatted bytes}{newline} {length byte}{formatted bytes}{newline} {length byte}{formatted bytes}{newline} `{newline} end{newline} Four formatted bytes are consumed output three result bytes lines before the begin and after the end are ignored. Exceptions are thrown if the begin is not found, if the end is not found, or if the lines between are nonsense. "No strings or characters are used in the processing of the bytes" Author: Keith D Swenson, August 2012

Constructor Summary

Constructors

Constructor and Description
UUDecoderStream(java.io.InputStream in) Create a UUdecoder that decodes the specified input stream

Method Summary

Modifier and Type	Method and Description
int	available()
int	getMode() Get the "mode" field from the prefix.
java.lang.String	getName() Get the "name" field from the prefix.
boolean	markSupported()
int	read() Read the next decoded byte from this input stream.
void	readOneLine(int maxLineLen) Skip any leftover CR or LF bytes, and read the next line from input and store in the inBuffer.

Methods inherited from class java.io.InputStream

close, mark, read, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

UUDecoderStream

public UUDecoderStream(java.io.InputStream in)

Create a UUdecoder that decodes the specified input stream

Parameters:

in - the input stream

Method Detail

read

public int read()
         throws java.io.IOException

Read the next decoded byte from this input stream. The byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Specified by:

read in class java.io.InputStream

Returns:

next byte of data, or -1 if the end of stream is reached.

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

FilterInputStream.in

markSupported

public boolean markSupported()

Overrides:

markSupported in class java.io.InputStream

available

public int available()
              throws java.io.IOException

Overrides:

available in class java.io.InputStream

Throws:

java.io.IOException

getName

public java.lang.String getName()
                         throws java.io.IOException

Get the "name" field from the prefix. This is meant to be the pathname of the decoded file

Returns:

name of decoded file

Throws:

java.io.IOException - if an I/O error occurs.

getMode

public int getMode()
            throws java.io.IOException

Get the "mode" field from the prefix. This is the permission mode of the source file.

Returns:

permission mode of source file

Throws:

java.io.IOException - if an I/O error occurs.

readOneLine

public void readOneLine(int maxLineLen)
                 throws java.io.IOException

Skip any leftover CR or LF bytes, and read the next line from input and store in the inBuffer. Line is terminated by the next CR. LF characters are ignored and thrown away in all cases. Blank lines are ignored (skipped). maxLineLen limits the length of a line. If a CR is not found before the limit is reached, then then characters up the limit are returned. Reading will resume at that point when the next readOneLine is called. This effectively breaks very long lines into multiple line results of maxLineLength. Resulting bytes are placed into inBuffer and inSize tells you how many have been read. inputDone flag is set when the source stream is empty, but keep in mind the current inBuffer may still have data in it.

Throws:

java.io.IOException