com.objsys.xbinder.runtime

Class Base64.EncoderOutputStream

java.lang.Object

java.io.OutputStream

com.objsys.xbinder.runtime.Base64.EncoderOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

Enclosing class:

Base64

public static class Base64.EncoderOutputStream
extends java.io.OutputStream

A Base64.EncoderOutputStream will write character data to a java.io.Writer, given in the constructor, while encoding the bytes you write to Base64 notation.

Since:

1.3

See Also:

Base64

Constructor Summary

Constructors

Constructor and Description
EncoderOutputStream(java.io.Writer out) Constructs a Base64.EncoderOutputStream in ENCODE mode.
EncoderOutputStream(java.io.Writer out, int options) Constructs a Base64.EncoderOutputStream in either ENCODE or DECODE mode.

Method Summary

Modifier and Type	Method and Description
void	close() Flushes and closes (I think, in the superclass) the stream.
void	flushBase64() Method added by PHIL.
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.OutputStream

flush, write

Methods inherited from class java.lang.Object

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

Constructor Detail

EncoderOutputStream

public EncoderOutputStream(java.io.Writer out)

Constructs a Base64.EncoderOutputStream in ENCODE mode.

Parameters:

out - the java.io.Writer to which data will be written.

Since:

1.3

EncoderOutputStream

public EncoderOutputStream(java.io.Writer out,
                           int options)

Constructs a Base64.EncoderOutputStream in either ENCODE or DECODE mode.

Valid options:

   ENCODE: Encode data.
   DONT_BREAK_LINES: don't break lines at 76 characters
     Note: Technically, this makes your encoding non-compliant.
 

Example: new Base64.OutputStream( out, Base64.ENCODE )

Parameters:

out - the java.io.Writer to which data will be written.

options - Specified options.

Since:

1.3

See Also:

Base64.ENCODE, Base64.DONT_BREAK_LINES

Method Detail

write

public void write(int theByte)
           throws java.io.IOException

Writes the byte to the output stream after converting to/from Base64 notation. Bytes are buffered three at a time before the output stream actually gets a write() call.

Specified by:

write in class java.io.OutputStream

Parameters:

theByte - the byte to write

Throws:

java.io.IOException

Since:

1.3

write

public void write(byte[] theBytes,
                  int off,
                  int len)
           throws java.io.IOException

Calls write(int) repeatedly until len bytes are written.

Overrides:

write in class java.io.OutputStream

Parameters:

theBytes - array from which to read bytes

off - offset for array

len - max number of bytes to read into array

Throws:

java.io.IOException

Since:

1.3

flushBase64

public void flushBase64()
                 throws java.io.IOException

Method added by PHIL. [Thanks, PHIL. -Rob] This pads the buffer without closing the stream.

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Flushes and closes (I think, in the superclass) the stream.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.OutputStream

Throws:

java.io.IOException

Since:

1.3