cgl.narada.util
Class Base64.OutputStream

java.lang.Object
  extended by java.io.OutputStream
      extended by java.io.FilterOutputStream
          extended by cgl.narada.util.Base64.OutputStream
All Implemented Interfaces:
Closeable, Flushable
Enclosing class:
Base64

public static class Base64.OutputStream
extends FilterOutputStream

A {Base64#OutputStream} will write data to another OutputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.

Since:
1.3
See Also:
Base64, FilterOutputStream

Field Summary
 
Fields inherited from class java.io.FilterOutputStream
out
 
Constructor Summary
Base64.OutputStream(OutputStream out)
          Constructs a {Base64#OutputStream} in ENCODE mode.
Base64.OutputStream(OutputStream out, boolean encode)
          Constructs a {Base64#OutputStream} in either ENCODE or DECODE mode.
Base64.OutputStream(OutputStream out, boolean encode, boolean breakLines)
          Constructs a {Base64#OutputStream} in either ENCODE or DECODE mode.
 
Method Summary
 void close()
          Flushes and closes (I think, in the superclass) the stream.
 void flush()
          Appropriately pads Base64 notation when encoding or throws an exception if Base64 input is not properly padded when decoding.
 void write(byte[] theBytes, int off, int len)
          Calls write(int) repeatedly until len bytes are written.
 void write(int theByte)
          Writes the byte to the output stream after converting to/from Base64 notation.
 
Methods inherited from class java.io.FilterOutputStream
write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Base64.OutputStream

public Base64.OutputStream(OutputStream out)
Constructs a {Base64#OutputStream} in ENCODE mode.

Parameters:
out - the OutputStream to which data will be written.
Since:
1.3

Base64.OutputStream

public Base64.OutputStream(OutputStream out,
                           boolean encode)
Constructs a {Base64#OutputStream} in either ENCODE or DECODE mode.

Parameters:
out - the OutputStream to which data will be written.
encode - Conversion direction
Since:
1.3
See Also:
Base64.ENCODE, Base64.DECODE

Base64.OutputStream

public Base64.OutputStream(OutputStream out,
                           boolean encode,
                           boolean breakLines)
Constructs a {Base64#OutputStream} in either ENCODE or DECODE mode.

Parameters:
out - the OutputStream to which data will be written.
encode - Conversion direction
breakLines - Break lines to be less than 80 characters.
Since:
1.3
See Also:
Base64.ENCODE, Base64.DECODE
Method Detail

write

public void write(int theByte)
           throws IOException
Writes the byte to the output stream after converting to/from Base64 notation. When encoding, bytes are buffered three at a time before the output stream actually gets a write() call. When decoding, bytes are buffered four at a time.

Overrides:
write in class FilterOutputStream
Parameters:
theByte - the byte to write
Throws:
IOException
Since:
1.3

write

public void write(byte[] theBytes,
                  int off,
                  int len)
           throws IOException
Calls write(int) repeatedly until len bytes are written.

Overrides:
write in class FilterOutputStream
Parameters:
theBytes - array from which to read bytes
off - offset for array
len - max number of bytes to read into array
Throws:
IOException
Since:
1.3

flush

public void flush()
           throws IOException
Appropriately pads Base64 notation when encoding or throws an exception if Base64 input is not properly padded when decoding.

Specified by:
flush in interface Flushable
Overrides:
flush in class FilterOutputStream
Throws:
IOException
Since:
1.3

close

public void close()
           throws IOException
Flushes and closes (I think, in the superclass) the stream.

Specified by:
close in interface Closeable
Overrides:
close in class FilterOutputStream
Throws:
IOException
Since:
1.3


For comments and suggestions please send e-mail to The NaradaBrokering Project