This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

com.sun.mail.util
class BASE64EncoderStream

com.sun.mail.util.BASE64EncoderStream
Direct Known Subclasses:
BEncoderStream
Most common way to construct:

OutputStream out = …;

BASE64EncoderStream base64enc = new BASE64EncoderStream(out);

Based on 45 examples 

public class BASE64EncoderStream
extends FilterOutputStream

This class implements a BASE64 encoder. It is implemented as a FilterOutputStream, so one can just wrap this class around any output stream and write bytes into this filter. The encoding is done as the bytes are written out.

Constructor Summary
BASE64EncoderStream(OutputStream out)

          Create a BASE64 encoder that encodes the specified input stream.
BASE64EncoderStream(OutputStream out, int bytesPerLine)

          Create a BASE64 encoder that encodes the specified output stream.
 
Method Summary
 void
close()

          Forces any buffered output bytes to be encoded out to the stream and closes this output stream
static byte[]
encode(byte[] inbuf)

          Base64 encode a byte array.
 void
flush()

          Flushes this output stream and forces any buffered output bytes to be encoded out to the stream.
 void
write(byte[] b)

          Encodes b.length bytes to this output stream.
 void
write(byte[] b, int off, int len)

          Encodes len bytes from the specified byte array starting at offset off to this output stream.
 void
write(int c)

          Encodes the specified byte to this output stream.
 

Constructor Detail

BASE64EncoderStream

public BASE64EncoderStream(OutputStream out)
Create a BASE64 encoder that encodes the specified input stream. Inserts the CRLF sequence after outputting 76 bytes.

Parameters:
out - the output stream

BASE64EncoderStream

public BASE64EncoderStream(OutputStream out,
                           int bytesPerLine)
Create a BASE64 encoder that encodes the specified output stream.

Parameters:
out - the output stream
bytesPerLine - number of bytes per line. The encoder inserts a CRLF sequence after the specified number of bytes, unless bytesPerLine is Integer.MAX_VALUE, in which case no CRLF is inserted. bytesPerLine is rounded down to a multiple of 4.
Method Detail

close

public synchronized void close()
                        throws IOException
Forces any buffered output bytes to be encoded out to the stream and closes this output stream

Overrides:
close in class FilterOutputStream
Throws:
IOException

encode

public static byte[] encode(byte[] inbuf)
Base64 encode a byte array. No line breaks are inserted. This method is suitable for short strings, such as those in the IMAP AUTHENTICATE protocol, but not to encode the entire content of a MIME part.

Parameters:
inbuf

flush

public synchronized void flush()
                        throws IOException
Flushes this output stream and forces any buffered output bytes to be encoded out to the stream.

Overrides:
flush in class FilterOutputStream
Throws:
IOException - if an I/O error occurs.

write

public void write(byte[] b)
           throws IOException
Encodes b.length bytes to this output stream.

Overrides:
write in class FilterOutputStream
Parameters:
b - the data to be written.
Throws:
IOException - if an I/O error occurs.

write

public synchronized void write(byte[] b,
                               int off,
                               int len)
                        throws IOException
Encodes len bytes from the specified byte array starting at offset off to this output stream.

Overrides:
write in class FilterOutputStream
Parameters:
b - the data.
off - the start offset in the data.
len - the number of bytes to write.
Throws:
IOException - if an I/O error occurs.

write

public synchronized void write(int c)
                        throws IOException
Encodes the specified byte to this output stream.

Overrides:
write in class FilterOutputStream
Parameters:
c - the byte.
Throws:
IOException - if an I/O error occurs.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention. The official Sun™ documentation can be found here at http://java.sun.com/products/javamail/javadocs/index.html.