cformat
Class PrintfStream

java.lang.Object
  |
  +--java.io.OutputStream
        |
        +--java.io.FilterOutputStream
              |
              +--java.io.PrintStream
                    |
                    +--cformat.PrintfStream

public class PrintfStream
extends java.io.PrintStream

PrintStream which outputs primitive types using C printf style formatting. For each primitive type (float, double, char, int, long, String), there is a printf method which takes (as a first argument) either a printf style format string, or a PrintfFormat object. Using the latter can be more efficient because it permits an application to prorate the overhead of parsing a format string.

Because Java does not permit variable numbers of arguments, each printf function accepts only one primitive type, and the format can correspondingly contain only one conversion sequence.

Author:
John E. Lloyd, Fall 2000
See Also:
PrintfFormat, PrintfWriter

Constructor Summary
PrintfStream(java.io.OutputStream out)
          Creates a PrintfStream, without automatic line flushing, from an existing OutputStream.
PrintfStream(java.io.OutputStream out, boolean autoFlush)
          Creates a PrintfStream from an existing OutputStream.
 
Method Summary
 void printf(PrintfFormat fmt, char x)
          Prints a char in accordance with the supplied PrintfFormat object.
 void printf(PrintfFormat fmt, double x)
          Prints a double in accordance with the supplied PrintfFormat object.
 void printf(PrintfFormat fmt, float x)
          Prints a float in accordance with the supplied PrintfFormat object.
 void printf(PrintfFormat fmt, int x)
          Prints an int in accordance with the supplied PrintfFormat object.
 void printf(PrintfFormat fmt, long x)
          Prints a long in accordance with the supplied PrintfFormat object.
 void printf(PrintfFormat fmt, java.lang.String x)
          Prints a String in accordance with the supplied PrintfFormat object.
 void printf(java.lang.String fs, char x)
          Prints a char in accordance with the supplied format string.
 void printf(java.lang.String fs, double x)
          Prints a double in accordance with the supplied format string.
 void printf(java.lang.String fs, float x)
          Prints a float in accordance with the supplied format string.
 void printf(java.lang.String fs, int x)
          Prints an int in accordance with the supplied format string.
 void printf(java.lang.String fs, long x)
          Prints a long in accordance with the supplied format string.
 void printf(java.lang.String fs, java.lang.String x)
          Prints a String in accordance with the supplied format string.
 
Methods inherited from class java.io.PrintStream
checkError, close, flush, print, print, print, print, print, print, print, print, print, println, println, println, println, println, println, println, println, println, println, write, write
 
Methods inherited from class java.io.FilterOutputStream
write
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PrintfStream

public PrintfStream(java.io.OutputStream out)
Creates a PrintfStream, without automatic line flushing, from an existing OutputStream.

Parameters:
out - An output stream

PrintfStream

public PrintfStream(java.io.OutputStream out,
                    boolean autoFlush)
Creates a PrintfStream from an existing OutputStream.

Parameters:
out - An output stream
autoFlush - If true, specifies that output flushing will automatically occur when the println() methods are called, a byte array is written, or a new line character or byte is encountered in the output.
Method Detail

printf

public void printf(java.lang.String fs,
                   double x)
Prints a double in accordance with the supplied format string.

Parameters:
fs - Format string
x - Double to output
Throws:
java.lang.IllegalArgumentException - Malformed format string

printf

public void printf(java.lang.String fs,
                   float x)
Prints a float in accordance with the supplied format string.

Parameters:
fs - Format string
x - Float to output
Throws:
java.lang.IllegalArgumentException - Malformed format string

printf

public void printf(java.lang.String fs,
                   long x)
Prints a long in accordance with the supplied format string.

Parameters:
fs - Format string
x - Long to output
Throws:
java.lang.IllegalArgumentException - Malformed format string

printf

public void printf(java.lang.String fs,
                   int x)
Prints an int in accordance with the supplied format string.

Parameters:
fs - Format string
x - Int to output
Throws:
java.lang.IllegalArgumentException - Malformed format string

printf

public void printf(java.lang.String fs,
                   java.lang.String x)
Prints a String in accordance with the supplied format string.

Parameters:
fs - Format string
x - String to output
Throws:
java.lang.IllegalArgumentException - Malformed format string

printf

public void printf(java.lang.String fs,
                   char x)
Prints a char in accordance with the supplied format string.

Parameters:
fs - Format string
x - Char to output
Throws:
java.lang.IllegalArgumentException - Malformed format string

printf

public void printf(PrintfFormat fmt,
                   double x)
Prints a double in accordance with the supplied PrintfFormat object.

Parameters:
fmt - Formatting object
x - Double to output
See Also:
PrintfFormat

printf

public void printf(PrintfFormat fmt,
                   float x)
Prints a float in accordance with the supplied PrintfFormat object.

Parameters:
fmt - Formatting object
x - Float to output
See Also:
PrintfFormat

printf

public void printf(PrintfFormat fmt,
                   long x)
Prints a long in accordance with the supplied PrintfFormat object.

Parameters:
fmt - Formatting object
x - Long to output
See Also:
PrintfFormat

printf

public void printf(PrintfFormat fmt,
                   int x)
Prints an int in accordance with the supplied PrintfFormat object.

Parameters:
fmt - Formatting object
x - Int to output
See Also:
PrintfFormat

printf

public void printf(PrintfFormat fmt,
                   java.lang.String x)
Prints a String in accordance with the supplied PrintfFormat object.

Parameters:
fmt - Formatting object
x - String to output
See Also:
PrintfFormat

printf

public void printf(PrintfFormat fmt,
                   char x)
Prints a char in accordance with the supplied PrintfFormat object.

Parameters:
fmt - Formatting object
x - Char to output
See Also:
PrintfFormat