Base64::InputStream Class Reference

List of all members.

Public Member Functions
	InputStream (java.io.InputStream in)
	InputStream (java.io.InputStream in, int options)
int	read () throws java.io.IOException
int	read (byte[] dest, int off, int len) throws java.io.IOException
Private Attributes
boolean	encode
int	position
byte[]	buffer
int	bufferLength
int	numSigBytes
int	lineLength
boolean	breakLines

---

Detailed Description

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

See also:

Base64

Since:

1.3

Definition at line 998 of file Base64.java.

---

Constructor & Destructor Documentation

Base64::InputStream::InputStream (  java.io.InputStream  in  )  [inline]

Constructs a Base64.InputStream in DECODE mode. Parameters: in  the java.io.InputStream from which to read data. Since: 1.3 Definition at line 1015 of file Base64.java. References Base64::DECODE. { this( in, DECODE ); } // end constructor

Base64::InputStream::InputStream (  java.io.InputStream  in, int  options )  [inline]

Constructs a Base64.InputStream 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.InputStream( in, Base64.DECODE ) Parameters: in  the java.io.InputStream from which to read data. options  Specified options See also: Base64::ENCODE Base64::DECODE Base64::DONT_BREAK_LINES Since: 2.0 Definition at line 1042 of file Base64.java. References bufferLength, Base64::DONT_BREAK_LINES, encode, and Base64::ENCODE. { super( in ); this.breakLines = (options & DONT_BREAK_LINES) != DONT_BREAK_LINES; this.encode = (options & ENCODE) == ENCODE; this.bufferLength = encode ? 4 : 3; this.buffer = new byte[ bufferLength ]; this.position = -1; this.lineLength = 0; } // end constructor

---

Member Function Documentation

int Base64::InputStream::read (  byte[]  dest, int  off, int  len )  throws java.io.IOException [inline]

Calls read() repeatedly until the end of stream is reached or len bytes are read. Returns number of bytes read into array or -1 if end of stream is encountered. Parameters: dest  array to hold values off  offset for array len  max number of bytes to read into array Returns: bytes read into array or -1 if end of stream is encountered. Since: 1.3 Definition at line 1188 of file Base64.java. References read(). { int i; int b; for( i = 0; i < len; i++ ) { b = read(); //if( b < 0 && i == 0 ) // return -1; if( b >= 0 ) dest[off + i] = (byte)b; else if( i == 0 ) return -1; else break; // Out of 'for' loop } // end for: each byte read return i; } // end read

int Base64::InputStream::read (   )  throws java.io.IOException [inline]

Reads enough of the input stream to convert to/from Base64 and returns the next byte. Returns: next byte Since: 1.3 encode && Definition at line 1060 of file Base64.java. References breakLines, buffer, bufferLength, Base64::DECODABET, Base64::decode4to3(), encode, Base64::encode3to4(), lineLength, Base64::MAX_LINE_LENGTH, numSigBytes, position, and Base64::WHITE_SPACE_ENC. { // Do we need to get data? if( position < 0 ) { if( encode ) { byte[] b3 = new byte[3]; int numBinaryBytes = 0; for( int i = 0; i < 3; i++ ) { try { int b = in.read(); // If end of stream, b is -1. if( b >= 0 ) { b3[i] = (byte)b; numBinaryBytes++; } // end if: not end of stream } // end try: read catch( java.io.IOException e ) { // Only a problem if we got no data at all. if( i == 0 ) throw e; } // end catch } // end for: each needed input byte if( numBinaryBytes > 0 ) { encode3to4( b3, 0, numBinaryBytes, buffer, 0 ); position = 0; numSigBytes = 4; } // end if: got data else { return -1; } // end else } // end if: encoding // Else decoding else { byte[] b4 = new byte[4]; int i = 0; for( i = 0; i < 4; i++ ) { // Read four "meaningful" bytes: int b = 0; do{ b = in.read(); } while( b >= 0 && DECODABET[ b & 0x7f ] <= WHITE_SPACE_ENC ); if( b < 0 ) break; // Reads a -1 if end of stream b4[i] = (byte)b; } // end for: each needed input byte if( i == 4 ) { numSigBytes = decode4to3( b4, 0, buffer, 0 ); position = 0; } // end if: got four characters else if( i == 0 ){ return -1; } // end else if: also padded correctly else { // Must have broken out from above. throw new java.io.IOException( "Improperly padded Base64 input." ); } // end } // end else: decode } // end else: get data // Got data? if( position >= 0 ) { // End of relevant data? if( /*!encode &&*/ position >= numSigBytes ) return -1; if( encode && breakLines && lineLength >= MAX_LINE_LENGTH ) { lineLength = 0; return '\n'; } // end if else { lineLength++; // This isn't important when decoding // but throwing an extra "if" seems // just as wasteful. int b = buffer[ position++ ]; if( position >= bufferLength ) position = -1; return b & 0xFF; // This is how you "cast" a byte that's // intended to be unsigned. } // end else } // end if: position >= 0 // Else error else { // When JDK1.4 is more accepted, use an assertion here. throw new java.io.IOException( "Error in Base64 code reading stream." ); } // end else } // end read

---

Member Data Documentation

boolean Base64::InputStream::breakLines [private]

Definition at line 1006 of file Base64.java.

byte [] Base64::InputStream::buffer [private]

Definition at line 1002 of file Base64.java.

int Base64::InputStream::bufferLength [private]

Definition at line 1003 of file Base64.java.

boolean Base64::InputStream::encode [private]

Definition at line 1000 of file Base64.java.

int Base64::InputStream::lineLength [private]

Definition at line 1005 of file Base64.java.

int Base64::InputStream::numSigBytes [private]

Definition at line 1004 of file Base64.java.

int Base64::InputStream::position [private]

Definition at line 1001 of file Base64.java.

---

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

• Base64.java

---