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.


com.sun.mail.util
class QPEncoderStream

com.sun.mail.util.QPEncoderStream
Direct Known Subclasses:
QEncoderStream

public class QPEncoderStream
extends FilterOutputStream

This class implements a Quoted Printable 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

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

          Create a QP encoder that encodes the specified input stream
 
Method Summary
 void

          Forces any buffered output bytes to be encoded out to the stream and closes this output stream
 void

          Flushes this output stream and forces any buffered output bytes to be encoded out to the stream.
protected void
output(int c, boolean encode)

          
 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

QPEncoderStream

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

Parameters:
out - the output stream

QPEncoderStream

public QPEncoderStream(OutputStream out,
                       int bytesPerLine)
Create a QP encoder that encodes the specified input stream

Parameters:
out - the output stream
bytesPerLine - the number of bytes per line. The encoder inserts a CRLF sequence after this many number of bytes.
Method Detail

close

public 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

flush

public 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.

output

protected void output(int c,
                      boolean encode)
               throws IOException
Parameters:
c
encode
Throws:
IOException

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 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 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.


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.