checkError() method.
* Additionally, this stream can be designated as "autoflush" when
* created so that any writes are automatically flushed to the underlying
* output sink when the current line is terminated.
*
* Note that this class is deprecated. It exists for backward
* compatibility only. New code should be written to use
* PrintWriter instead.
*
* This class converts char's into byte's using the system default encoding.
*
* @deprecated
*
* @version 0.0
*
* @author Aaron M. Renn (arenn@urbanophile.com)
*/
public class PrintStream extends FilterOutputStream
{
/*
* Ok, why is this class deprecated? It could easily have been extended
* to support character encodings. In fact, PrintWriter is basically a
* superset of this except for the write() methods. So let's do something
* tricky here and just redirect calls in this class to a hidden PrintWriter
* instance. All the functionality goes there since that is the 'real'
* class. The big win of doing this way is that the default character
* encoding is done automagicially by the PrintWriter tree!
*/
/*************************************************************************/
/*
* Instance Variables
*/
/**
* This boolean indicates whether or not an error has ever occured
* on this stream.
*/
private boolean error_occurred;
/**
* This is true if auto-flush is enabled, false otherwise
*/
private boolean auto_flush;
/**
* The PrintWriter instance this object writes to
*/
private PrintWriter pw;
/**
* Lets us know if the stream is closed
*/
private boolean closed;
/*************************************************************************/
/*
* Constructors
*/
/**
* This method intializes a new PrintStream object to write
* to the specified output sink. Note that this class is deprecated in
* favor of PrintWriter.
*
* @param out The OutputStream to write to.
*
* @deprecated
*/
public
PrintStream(OutputStream out)
{
this(out, false);
}
/*************************************************************************/
/**
* This method intializes a new PrintStream object to write
* to the specified output sink. This constructor also allows "auto-flush"
* functionality to be specified where the stream will be flushed after
* every line is terminated or newline character is written.
*
* Note that this class is deprecated in favor of PrintWriter.
*
* @param out The OutputStream to write to.
* @param auto_flush true to flush the stream after every line, false otherwise
*
* @deprecated
*/
public
PrintStream(OutputStream out, boolean auto_flush)
{
super(out);
pw = new PrintWriter(out, auto_flush);
this.auto_flush = auto_flush;
}
/*************************************************************************/
/*
* Instance Methods
*/
/**
* This method checks to see if an error has occurred on this stream. Note
* that once an error has occurred, this method will continue to report
* true forever for this stream. Before checking for an
* error condition, this method flushes the stream.
*
* @return true if an error has occurred, false otherwise
*/
public boolean
checkError()
{
if (!closed)
pw.flush();
if (pw.checkError() | error_occurred)
return(true);
else
return(false);
}
/*************************************************************************/
/**
* This method can be called by subclasses to indicate that an error
* has occurred and should be reported by checkError.
*/
protected void
setError()
{
error_occurred = true;
}
/*************************************************************************/
/**
* This method closes this stream and all underlying streams.
*/
public synchronized void
close()
{
pw.close();
closed = true;
}
/*************************************************************************/
/**
* This method flushes any buffered bytes to the underlying stream and
* then flushes that stream as well.
*/
public void
flush()
{
pw.flush();
}
/*************************************************************************/
/**
* This methods prints a boolean value to the stream. true
* values are printed as "true" and false values are printed
* as "false".
*
* @param b The boolean value to print
*/
public void
print(boolean b)
{
pw.print(b);
}
/*************************************************************************/
/**
* This method prints a char to the stream. The actual value printed is
* determined by the character encoding in use.
*
* @param c The char value to be printed
*/
public void
print(char c)
{
pw.print(c);
if (auto_flush)
if ((c == '\r') || (c == '\n'))
flush();
}
/*************************************************************************/
/**
* This method prints an integer to the stream. The value printed is
* determined using the String.valueOf() method.
*
* @param i The int value to be printed
*/
public void
print(int i)
{
pw.print(i);
}
/*************************************************************************/
/**
* This method prints a long to the stream. The value printed is
* determined using the String.valueOf() method.
*
* @param l The long value to be printed
*/
public void
print(long l)
{
pw.print(l);
}
/*************************************************************************/
/**
* This method prints a float to the stream. The value printed is
* determined using the String.valueOf() method.
*
* @param f The float value to be printed
*/
public void
print(float f)
{
pw.print(f);
}
/*************************************************************************/
/**
* This method prints a double to the stream. The value printed is
* determined using the String.valueOf() method.
*
* @param d The double value to be printed
*/
public void
print(double d)
{
pw.print(d);
}
/*************************************************************************/
/**
* This method prints an array of characters to the stream. The actual
* value printed depends on the system default encoding.
*
* @param s The array of characters to print.
*/
public void
print(char[] s)
{
pw.print(s);
if (auto_flush)
for (int i = 0; i < s.length; i++)
if ((s[i] == '\r') || (s[i] == '\n'))
{
flush();
break;
}
}
/*************************************************************************/
/**
* This method prints a String to the stream. The actual
* value printed depends on the system default encoding.
*
* @param s The String to print.
*/
public void
print(String s)
{
pw.print(s);
if (auto_flush)
if ((s.indexOf('\r') != -1) || (s.indexOf('\n') != -1))
flush();
}
/*************************************************************************/
/**
* This method prints an Object to the stream. The actual
* value printed is determined by calling the String.valueOf()
* method.
*
* @param obj The Object to print.
*/
public void
print(Object obj)
{
// Don't call pw directly. Convert to String so we scan for newline
// characters on auto-flush;
print(String.valueOf(obj));
}
/*************************************************************************/
/**
* This method prints a line separator sequence to the stream. The value
* printed is determined by the system property
true
* values are printed as "true" and false values are printed
* as "false".
*
* This method prints a line termination sequence after printing the value.
*
* @param b The boolean value to print
*/
public void
println(boolean b)
{
pw.println(b);
}
/*************************************************************************/
/**
* This method prints a char to the stream. The actual value printed is
* determined by the character encoding in use.
*
* This method prints a line termination sequence after printing the value.
*
* @param c The char value to be printed
*/
public void
println(char c)
{
pw.println(c);
}
/*************************************************************************/
/**
* This method prints an integer to the stream. The value printed is
* determined using the String.valueOf() method.
*
* This method prints a line termination sequence after printing the value.
*
* @param i The int value to be printed
*/
public void
println(int i)
{
pw.println(i);
}
/*************************************************************************/
/**
* This method prints a long to the stream. The value printed is
* determined using the String.valueOf() method.
*
* This method prints a line termination sequence after printing the value.
*
* @param l The long value to be printed
*/
public void
println(long l)
{
pw.println(l);
}
/*************************************************************************/
/**
* This method prints a float to the stream. The value printed is
* determined using the String.valueOf() method.
*
* This method prints a line termination sequence after printing the value.
*
* @param f The float value to be printed
*/
public void
println(float f)
{
pw.println(f);
}
/*************************************************************************/
/**
* This method prints a double to the stream. The value printed is
* determined using the String.valueOf() method.
*
* This method prints a line termination sequence after printing the value.
*
* @param d The double value to be printed
*/
public void
println(double d)
{
pw.println(d);
}
/*************************************************************************/
/**
* This method prints an array of characters to the stream. The actual
* value printed depends on the system default encoding.
*
* This method prints a line termination sequence after printing the value.
*
* @param s The array of characters to print.
*/
public void
println(char[] s)
{
pw.println(s);
}
/*************************************************************************/
/**
* This method prints a String to the stream. The actual
* value printed depends on the system default encoding.
*
* This method prints a line termination sequence after printing the value.
*
* @param s The String to print.
*/
public void
println(String s)
{
pw.println(s);
}
/*************************************************************************/
/**
* This method prints an Object to the stream. The actual
* value printed is determined by calling the String.valueOf()
* method.
*
* This method prints a line termination sequence after printing the value.
*
* @param obj The Object to print.
*/
public void
println(Object obj)
{
pw.println(obj);
}
/*************************************************************************/
/**
* This method writes a byte of data to the stream. If auto-flush is
* enabled, printing a newline character will cause the stream to be
* flushed after the character is written.
*
* @param b The byte to be written
*/
public synchronized void
write(int b)
{
// Sigh, we actually have to implement this method. Flush first so that
// things get written in the right order.
flush();
try
{
out.write(b);
if (auto_flush)
if ((b == '\n') || (b == '\n'))
flush();
}
catch(IOException e)
{
error_occurred = true;
}
}
/*************************************************************************/
/**
* This method writes len bytes from the specified array
* starting at index offset into the array.
*
* @param buf The array of bytes to write
* @param offset The index into the array to start writing from
* @param len The number of bytes to write
*/
public synchronized void
write(byte[] buf, int offset, int len)
{
// We actually have to implement this method too. Flush first so that
// things get written in the right order.
flush();
try
{
out.write(buf, offset, len);
if (auto_flush)
for (int i = offset; i < len; i++)
if ((buf[i] == '\r') || (buf[i] == '\n'))
{
flush();
break;
}
}
catch(IOException e)
{
error_occurred = true;
}
}
} // class PrintStream