From eefd952131779ed7aab9c437ab3417bb49c98d5f Mon Sep 17 00:00:00 2001 From: mkoch Date: Mon, 31 Mar 2003 10:15:48 +0000 Subject: 2003-03-31 Michael Koch * java/io/File.java (separator): Merged documentation from classpath. (separatorChar): Merged documentation from classpath. (pathSeparator): Merged documentation from classpath. (pathSeparatorChar): Merged documentation from classpath. (path): Merged documentation from classpath. (canRead): Merged documentation from classpath. (canWrite): Merged documentation from classpath. (createNewFile): Merged documentation from classpath. (delete): Merged documentation from classpath. (equals): Merged documentation from classpath. (exists): Merged documentation from classpath. (File): Renamed p to name to match classpath, merged documentation from classpath. (getAbsolutePath): Merged documentation from classpath. (getCanonicalPath): Merged documentation from classpath. (getCanonicalFile): Merged documentation from classpath. (getName): Merged documentation from classpath. (getParent): Merged documentation from classpath. (getParentFile): Merged documentation from classpath. (getPath): Merged documentation from classpath. (hashCode): Merged documentation from classpath. (isAbsolute): Merged documentation from classpath. (isDirectory): Merged documentation from classpath. (isFile): Merged documentation from classpath. (isHidden): Merged documentation from classpath. (lastModified): Merged documentation from classpath. (length): Merged documentation from classpath. (list): Merged documentation from classpath. (listFiles): Merged documentation from classpath. (toString): Merged documentation from classpath. (toURL): Merged documentation from classpath. (mkdir): Merged documentation from classpath. (mkdirs): Merged documentation from classpath. (createTempFile): Merged documentation from classpath. (setReadOnly): Merged documentation from classpath. (listRoots): Merged documentation from classpath. (compareTo): Merged documentation from classpath. (renameTo): Merged documentation from classpath. (setLastModified): Merged documentation from classpath. * java/io/PrintStream.java (auto_flush): Merged documentation from classpath. (PrintStream): Merged documentation from classpath. (checkError): Merged documentation from classpath. (setError): Merged documentation from classpath. (close): Merged documentation from classpath. (flush): Merged documentation from classpath. (print): Merged documentation from classpath. (println): Merged documentation from classpath. (write): Renamed count to len to match classpath, merged documentation from classpath. * java/io/RandomAccessFile.java (readShort): Merged documentation from classpath. (readUnsignedByte): Merged documentation from classpath. (readUnsignedShort): Merged documentation from classpath. (readUTF): Merged documentation from classpath. (seek): Reformatted, merged documentation from classpath. (skipBytes): Renamed some variables to match classpath, reformatted, merged documentation from classpath. (write): Merged documentation from classpath. (writeBoolean): Merged documentation from classpath. (writeByte): Merged documentation from classpath. (writeShort): Merged documentation from classpath. (writeChar): Merged documentation from classpath. (writeInt): Merged documentation from classpath. (writeLong): Merged documentation from classpath. (writeFloat): Merged documentation from classpath. (writeDouble): Merged documentation from classpath. (writeBytes): Merged documentation from classpath. (writeChars): Merged documentation from classpath. (writeUTF): Reformatted. (getChannel): Reformatted. git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@65081 138bc75d-0d04-0410-961f-82ee72b054a4 --- libjava/java/io/PrintStream.java | 206 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 203 insertions(+), 3 deletions(-) (limited to 'libjava/java/io/PrintStream.java') diff --git a/libjava/java/io/PrintStream.java b/libjava/java/io/PrintStream.java index 9563305969d..418d7f2cbd5 100644 --- a/libjava/java/io/PrintStream.java +++ b/libjava/java/io/PrintStream.java @@ -84,32 +84,76 @@ public class PrintStream extends FilterOutputStream // True if error occurred. private boolean error; // True if auto-flush. + /** + * This is true if auto-flush is enabled, + * false otherwise + */ private boolean auto_flush; + /** + * 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); + converter = UnicodeToBytes.getDefaultEncoder(); error = false; this.auto_flush = auto_flush; } + /** + * 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 () { flush(); return error; } + /** + * This method can be called by subclasses to indicate that an error + * has occurred and should be reported by checkError. + */ protected void setError () { error = true; } + /** + * This method closes this stream and all underlying streams. + */ public void close () { try @@ -127,6 +171,10 @@ public class PrintStream extends FilterOutputStream } } + /** + * This method flushes any buffered bytes to the underlying stream and + * then flushes that stream as well. + */ public void flush () { try @@ -210,103 +258,245 @@ public class PrintStream extends FilterOutputStream } } + /** + * 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 bool) { print(String.valueOf(bool), false); } + /** + * This method prints an integer to the stream. The value printed is + * determined using the String.valueOf() method. + * + * @param inum The int value to be printed + */ public void print (int inum) { print(String.valueOf(inum), false); } + /** + * This method prints a long to the stream. The value printed is + * determined using the String.valueOf() method. + * + * @param lnum The long value to be printed + */ public void print (long lnum) { print(String.valueOf(lnum), false); } + /** + * This method prints a float to the stream. The value printed is + * determined using the String.valueOf() method. + * + * @param fnum The float value to be printed + */ public void print (float fnum) { print(String.valueOf(fnum), false); } + /** + * This method prints a double to the stream. The value printed is + * determined using the String.valueOf() method. + * + * @param dnum The double value to be printed + */ public void print (double dnum) { print(String.valueOf(dnum), false); } + /** + * 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) { print(obj == null ? "null" : obj.toString(), false); } + /** + * This method prints a String to the stream. The actual + * value printed depends on the system default encoding. + * + * @param str The String to print. + */ public void print (String str) { print(str == null ? "null" : str, false); } + /** + * This method prints a char to the stream. The actual value printed is + * determined by the character encoding in use. + * + * @param ch The char value to be printed + */ public synchronized void print (char ch) { work[0] = ch; print(work, 0, 1, false); } + /** + * 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[] charArray) { print(charArray, 0, charArray.length, false); } + /** + * This method prints a line separator sequence to the stream. The value + * printed is determined by the system property

line.separator + * and is not necessarily the Unix '\n' newline character. + */ public void println () { print(line_separator, 0, line_separator.length, false); } + /** + * This methods prints a boolean value to the stream. 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 bool) { print(String.valueOf(bool), true); } + /** + * 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 inum The int value to be printed + */ public void println (int inum) { print(String.valueOf(inum), true); } + /** + * 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 lnum The long value to be printed + */ public void println (long lnum) { print(String.valueOf(lnum), true); } + /** + * 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 fnum The float value to be printed + */ public void println (float fnum) { print(String.valueOf(fnum), true); } + /** + * 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 dnum The double value to be printed + */ public void println (double dnum) { print(String.valueOf(dnum), true); } + /** + * 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) { print(obj == null ? "null" : obj.toString(), true); } + /** + * 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 str The String to print. + */ public void println (String str) { print (str == null ? "null" : str, true); } + /** + * 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 ch The char value to be printed + */ public synchronized void println (char ch) { work[0] = ch; print(work, 0, 1, true); } + /** + * 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[] charArray) { print(charArray, 0, charArray.length, true); } + /** + * 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 void write (int oneByte) { try @@ -325,11 +515,20 @@ public class PrintStream extends FilterOutputStream } } - public void write (byte[] buffer, int offset, int count) + /** + * This method writes len bytes from the specified array + * starting at index offset into the array. + * + * @param buffer 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 void write (byte[] buffer, int offset, int len) { try { - out.write(buffer, offset, count); + out.write (buffer, offset, len); + if (auto_flush) flush(); } @@ -343,4 +542,5 @@ public class PrintStream extends FilterOutputStream } } -} +} // class PrintStream + -- cgit v1.2.1