org.ws4d.java.communication.protocol.http

Class Base64Util.OutputStream

java.lang.Object

java.io.OutputStream

org.ws4d.java.communication.protocol.http.Base64Util.OutputStream

All Implemented Interfaces:

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

Enclosing class:

Base64Util

public static class Base64Util.OutputStream
extends java.io.OutputStream

A Base64Util.OutputStream will write data to another java.io.OutputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.

Since:

1.3

See Also:

Base64Util

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close() Flushes and closes the stream.
void	flush() Flushes this output stream and forces any buffered output bytes to be written out.
void	flushBase64() Method added by PHIL.
void	resumeEncoding() Resumes encoding of the stream.
void	suspendEncoding() Suspends encoding of the stream.
void	write(byte[] theBytes) Writes b.length bytes from the specified byte array to this output stream.
void	write(byte[] theBytes, int off, int len) Calls write(int) repeatedly until len bytes have been written.
void	write(int theByte) Writes the byte to the output stream after converting to/from Base64 notation.

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputStream

public OutputStream(java.io.OutputStream out)

Constructs a Base64Util.OutputStream in ENCODE mode.

Parameters:

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

Since:

1.3

OutputStream

public OutputStream(java.io.OutputStream out,
                    int options)

Constructs a Base64Util.OutputStream in either ENCODE or DECODE mode.

Valid options:

    ENCODE or DECODE: Encode or Decode as data is read.
    DONT_BREAK_LINES: don't break lines at 76 characters
      (only meaningful when encoding)
      <i>Note: Technically, this makes your encoding non-compliant.</i>
 

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

Parameters:

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

options - Specified options.

Since:

1.3

See Also:

Base64Util.ENCODE, Base64Util.DECODE, Base64Util.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. 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.

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 have been 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 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

suspendEncoding

public void suspendEncoding()
                     throws java.io.IOException

Suspends encoding of the stream. May be helpful if you need to embed a piece of base640-encoded data in a stream.

Throws:

java.io.IOException

Since:

1.5.1

resumeEncoding

public void resumeEncoding()

Resumes encoding of the stream. May be helpful if you need to embed a piece of base640-encoded data in a stream.

Since:

1.5.1

write

public void write(byte[] theBytes)
           throws java.io.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 java.io.OutputStream

Throws:

java.io.IOException

Since:

3.0

flush

public void flush()
           throws java.io.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.

This method simply performs out.flush().

Specified by:

flush in interface java.io.Flushable

Overrides:

flush in class java.io.OutputStream

Throws:

java.io.IOException

Since:

3.0