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 TraceInputStream

com.sun.mail.util.TraceInputStream

public class TraceInputStream
extends FilterInputStream

This class is a FilterInputStream that writes the bytes being read from the given input stream into the given output stream. This class is typically used to provide a trace of the data that is being retrieved from an input stream.


Constructor Summary

          Creates an input stream filter built on top of the specified input stream.
 
Method Summary
 int

          Reads the next byte of data from this input stream.
 int
read(byte[] b, int off, int len)

          Reads up to len bytes of data from this input stream into an array of bytes.
 void
setQuote(boolean quote)

          Set quote mode.
 void
setTrace(boolean trace)

          Set trace mode.
 

Constructor Detail

TraceInputStream

public TraceInputStream(InputStream in,
                        OutputStream traceOut)
Creates an input stream filter built on top of the specified input stream.

Parameters:
in - the underlying input stream.
traceOut
Method Detail

read

public int read()
         throws IOException
Reads the next byte of data from this input stream. Returns -1 if no data is available. Writes out the read byte into the trace stream, if trace mode is true

Overrides:
read in class FilterInputStream
Throws:
IOException

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException
Reads up to len bytes of data from this input stream into an array of bytes. Returns -1 if no more data is available. Writes out the read bytes into the trace stream, if trace mode is true

Overrides:
read in class FilterInputStream
Parameters:
b
off
len
Throws:
IOException

setQuote

public void setQuote(boolean quote)
Set quote mode.

Parameters:
quote - the quote mode

setTrace

public void setTrace(boolean trace)
Set trace mode.

Parameters:
trace - the trace mode


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.