Base64::OutputStream Class Reference

List of all members.

Public Member Functions
	OutputStream (java.io.OutputStream out)
	OutputStream (java.io.OutputStream out, int options)
void	write (int theByte) throws java.io.IOException
void	write (byte[] theBytes, int off, int len) throws java.io.IOException
void	flushBase64 () throws java.io.IOException
void	close () throws java.io.IOException
void	suspendEncoding () throws java.io.IOException
void	resumeEncoding ()
Private Attributes
boolean	encode
int	position
byte[]	buffer
int	bufferLength
int	lineLength
boolean	breakLines
byte[]	b4
boolean	suspendEncoding

---

Detailed Description

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

See also:

Base64

Since:

1.3

Definition at line 1228 of file Base64.java.

---

Constructor & Destructor Documentation

Base64::OutputStream::OutputStream (  java.io.OutputStream  out  )  [inline]

Constructs a Base64.OutputStream in ENCODE mode. Parameters: out  the java.io.OutputStream to which data will be written. Since: 1.3 Definition at line 1245 of file Base64.java. References Base64::ENCODE. { this( out, ENCODE ); } // end constructor

Base64::OutputStream::OutputStream (  java.io.OutputStream  out, int  options )  [inline]

Constructs a Base64.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) Note: Technically, this makes your encoding non-compliant. Example: new Base64.OutputStream( out, Base64.ENCODE ) Parameters: out  the java.io.OutputStream to which data will be written. options  Specified options. See also: Base64::ENCODE Base64::DECODE Base64::DONT_BREAK_LINES Since: 1.3 Definition at line 1271 of file Base64.java. References bufferLength, Base64::DONT_BREAK_LINES, encode, and Base64::ENCODE. { super( out ); this.breakLines = (options & DONT_BREAK_LINES) != DONT_BREAK_LINES; this.encode = (options & ENCODE) == ENCODE; this.bufferLength = encode ? 3 : 4; this.buffer = new byte[ bufferLength ]; this.position = 0; this.lineLength = 0; this.suspendEncoding = false; this.b4 = new byte[4]; } // end constructor

---

Member Function Documentation

void Base64::OutputStream::close (   )  throws java.io.IOException [inline]

Flushes and closes (I think, in the superclass) the stream. Since: 1.3 Definition at line 1403 of file Base64.java. References buffer, and flushBase64(). { // 1. Ensure that pending characters are written flushBase64(); // 2. Actually close the stream // Base class both flushes and closes. super.close(); buffer = null; out = null; } // end close

void Base64::OutputStream::flushBase64 (   )  throws java.io.IOException [inline]

Method added by PHIL. [Thanks, PHIL. -Rob] This pads the buffer without closing the stream. Definition at line 1380 of file Base64.java. References b4, buffer, encode, Base64::encode3to4(), and position. { if( position > 0 ) { if( encode ) { out.write( encode3to4( b4, buffer, position ) ); position = 0; } // end if: encoding else { throw new java.io.IOException( "Base64 input not properly padded." ); } // end else: decoding } // end if: buffer partially full } // end flush

void Base64::OutputStream::resumeEncoding (   )  [inline]

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 Definition at line 1439 of file Base64.java. { this.suspendEncoding = false; } // end resumeEncoding

void Base64::OutputStream::suspendEncoding (   )  throws java.io.IOException [inline]

Suspends 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 Definition at line 1425 of file Base64.java. References flushBase64(). { flushBase64(); this.suspendEncoding = true; } // end suspendEncoding

void Base64::OutputStream::write (  byte[]  theBytes, int  off, int  len )  throws java.io.IOException [inline]

Calls write(int) repeatedly until len bytes are written. Parameters: theBytes  array from which to read bytes off  offset for array len  max number of bytes to read into array Since: 1.3 Definition at line 1358 of file Base64.java. References suspendEncoding(), and write(). { // Encoding suspended? if( suspendEncoding ) { super.out.write( theBytes, off, len ); return; } // end if: supsended for( int i = 0; i < len; i++ ) { write( theBytes[ off + i ] ); } // end for: each byte written } // end write

void Base64::OutputStream::write (  int  theByte  )  throws java.io.IOException [inline]

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. Parameters: theByte  the byte to write Since: 1.3 Definition at line 1297 of file Base64.java. References b4, breakLines, buffer, bufferLength, Base64::DECODABET, encode, Base64::encode3to4(), lineLength, Base64::MAX_LINE_LENGTH, Base64::NEW_LINE, position, suspendEncoding(), and Base64::WHITE_SPACE_ENC. { // Encoding suspended? if( suspendEncoding ) { super.out.write( theByte ); return; } // end if: supsended // Encode? if( encode ) { buffer[ position++ ] = (byte)theByte; if( position >= bufferLength ) // Enough to encode. { out.write( encode3to4( b4, buffer, bufferLength ) ); lineLength += 4; if( breakLines && lineLength >= MAX_LINE_LENGTH ) { out.write( NEW_LINE ); lineLength = 0; } // end if: end of line position = 0; } // end if: enough to output } // end if: encoding // Else, Decoding else { // Meaningful Base64 character? if( DECODABET[ theByte & 0x7f ] > WHITE_SPACE_ENC ) { buffer[ position++ ] = (byte)theByte; if( position >= bufferLength ) // Enough to output. { int len = Base64.decode4to3( buffer, 0, b4, 0 ); out.write( b4, 0, len ); //out.write( Base64.decode4to3( buffer ) ); position = 0; } // end if: enough to output } // end if: meaningful base64 character else if( DECODABET[ theByte & 0x7f ] != WHITE_SPACE_ENC ) { throw new java.io.IOException( "Invalid character in Base64 data." ); } // end else: not white space either } // end else: decoding } // end write

---

Member Data Documentation

byte [] Base64::OutputStream::b4 [private]

Definition at line 1236 of file Base64.java.

boolean Base64::OutputStream::breakLines [private]

Definition at line 1235 of file Base64.java.

byte [] Base64::OutputStream::buffer [private]

Definition at line 1232 of file Base64.java.

int Base64::OutputStream::bufferLength [private]

Definition at line 1233 of file Base64.java.

boolean Base64::OutputStream::encode [private]

Definition at line 1230 of file Base64.java.

int Base64::OutputStream::lineLength [private]

Definition at line 1234 of file Base64.java.

int Base64::OutputStream::position [private]

Definition at line 1231 of file Base64.java.

boolean Base64::OutputStream::suspendEncoding [private]

Definition at line 1237 of file Base64.java.

---

The documentation for this class was generated from the following file:

• Base64.java

---