From ffe4ebba87d78d4da242adb6e95d2976bd796d91 Mon Sep 17 00:00:00 2001 From: Michael Koch Date: Mon, 24 Mar 2003 08:27:28 +0000 Subject: DataInputStream.java (): Wrapped documentation line. 2003-03-24 Michael Koch * java/io/DataInputStream.java (): Wrapped documentation line. (): Fixed @return tag. * java/io/DataOutputStream.java (written): Moved to top of class. (all methods): Merged documentation from classpath. * java/io/File.java: Merged copyright year with classpath. * java/io/FileInputStream.java (all methods): Merged documentation from classpath. * java/io/LineNumberReader.java (getLineNumber): Fixed @return tag. * java/io/ObjectInputStream.java. Reformatted. * java/io/ObjectOutputStream.java: Reformatted, fixed some @see tags. * java/io/OutputStreamWriter.java: Deleted empty line. * java/io/Writer.java: Reformatted. From-SVN: r64780 --- libjava/java/io/Writer.java | 190 +++++++++++++++++++------------------------- 1 file changed, 82 insertions(+), 108 deletions(-) (limited to 'libjava/java/io/Writer.java') diff --git a/libjava/java/io/Writer.java b/libjava/java/io/Writer.java index 3b2cf79ffdc..f3d6eaa7392 100644 --- a/libjava/java/io/Writer.java +++ b/libjava/java/io/Writer.java @@ -44,93 +44,75 @@ package java.io; */ /** - * This abstract class forms the base of the hierarchy of classes that - * write output as a stream of chars. It provides a common set of methods - * for writing chars to stream. Subclasses implement and/or extend these - * methods to write chars in a particular manner or to a particular - * destination such as a file on disk or network connection. - * - * @author Aaron M. Renn (arenn@urbanophile.com) - * @author Per Bothner - */ + * This abstract class forms the base of the hierarchy of classes that + * write output as a stream of chars. It provides a common set of methods + * for writing chars to stream. Subclasses implement and/or extend these + * methods to write chars in a particular manner or to a particular + * destination such as a file on disk or network connection. + * + * @author Aaron M. Renn (arenn@urbanophile.com) + * @author Per Bothner + */ public abstract class Writer { /** - * This is the object used to synchronize criticial code sections for - * thread safety. Subclasses should use this field instead of using - * synchronized methods or explicity synchronizations on this - */ - protected Object lock; - - /*************************************************************************/ - - /* - * Constructors + * This is the object used to synchronize criticial code sections for + * thread safety. Subclasses should use this field instead of using + * synchronized methods or explicity synchronizations on this */ + protected Object lock; /** - * This is the default no-argument constructor for this class. This method - * will set up the class to synchronize criticial sections on itself. - */ + * This is the default no-argument constructor for this class. This method + * will set up the class to synchronize criticial sections on itself. + */ protected Writer() { lock = this; } - /*************************************************************************/ - /** - * This method initializes a Writer that will synchronize - * on the specified Object. - * - * @param obj The Object to use for synchronizing critical - * sections - */ + * This method initializes a Writer that will synchronize + * on the specified Object. + * + * @param obj The Object to use for synchronizing critical + * sections + */ protected Writer(Object lock) { this.lock = lock; } - /*************************************************************************/ - - /* - * Instance Methods - */ - /** - * This method forces any data that may have been buffered to be written - * to the underlying output device. Please note that the host environment - * might perform its own buffering unbeknowst to Java. In that case, a - * write made (for example, to a disk drive) might be cached in OS - * buffers instead of actually being written to disk. - * - * @exception IOException If an error occurs - */ + * This method forces any data that may have been buffered to be written + * to the underlying output device. Please note that the host environment + * might perform its own buffering unbeknowst to Java. In that case, a + * write made (for example, to a disk drive) might be cached in OS + * buffers instead of actually being written to disk. + * + * @exception IOException If an error occurs + */ public abstract void flush() throws IOException; - /*************************************************************************/ - /** - * This method closes the stream. Any internal or native resources - * associated - * with this stream are freed. Any subsequent attempt to access the stream - * might throw an exception. - *

- * This method in this class does nothing. - * - * @exception IOException If an error occurs - */ + * This method closes the stream. Any internal or native resources + * associated + * with this stream are freed. Any subsequent attempt to access the stream + * might throw an exception. + *

+ * This method in this class does nothing. + * + * @exception IOException If an error occurs + */ public abstract void close() throws IOException; - /*************************************************************************/ - /** - * This method writes a single char to the output stream. - * - * @param b The char to be written to the output stream, passed as an int - * - * @exception IOException If an error occurs - */ + * This method writes a single char to the output stream. + * + * @param b The char to be written to the output stream, passed as an int + * + * @exception IOException If an error occurs + */ public void write(int b) throws IOException { char[] buf = new char[1]; @@ -139,68 +121,60 @@ public abstract class Writer write(buf, 0, buf.length); } - /*************************************************************************/ - /** - * This method all the writes char from the passed array to the output - * stream. This method is equivalent to - * write(buf, 0, buf.length) which - * is exactly how it is implemented in this class. - * - * @param buf The array of char to write - * - * @exception IOException If an error occurs - */ + * This method all the writes char from the passed array to the output + * stream. This method is equivalent to + * write(buf, 0, buf.length) which + * is exactly how it is implemented in this class. + * + * @param buf The array of char to write + * + * @exception IOException If an error occurs + */ public void write(char[] buf) throws IOException { write(buf, 0, buf.length); } - /*************************************************************************/ - /** - * This method writes len char from the specified array - * buf starting at index offset into the array. - *

- * Subclasses must provide an implementation of this abstract method. - * - * @param buf The array of char to write from - * @param offset The index into the array to start writing from - * @param len The number of char to write - * - * @exception IOException If an error occurs - */ + * This method writes len char from the specified array + * buf starting at index offset into the array. + *

+ * Subclasses must provide an implementation of this abstract method. + * + * @param buf The array of char to write from + * @param offset The index into the array to start writing from + * @param len The number of char to write + * + * @exception IOException If an error occurs + */ public abstract void write(char[] buf, int offset, int len) throws IOException; - /*************************************************************************/ - /** - * This method writes all the characters in a String to the - * output. - * - * @param str The String whose chars are to be written. - * - * @param IOException If an error occurs - */ + * This method writes all the characters in a String to the + * output. + * + * @param str The String whose chars are to be written. + * + * @param IOException If an error occurs + */ public void write(String str) throws IOException { write(str, 0, str.length()); } - /*************************************************************************/ - /** - * This method writes len chars from the String - * starting at position offset. - * - * @param str The String that is to be written - * @param offset The character offset into the String to start - * writing from - * @param len The number of chars to write - * - * @exception IOException If an error occurs - */ + * This method writes len chars from the String + * starting at position offset. + * + * @param str The String that is to be written + * @param offset The character offset into the String to start + * writing from + * @param len The number of chars to write + * + * @exception IOException If an error occurs + */ public void write(String str, int offset, int len) throws IOException { // FIXME - for libgcj re-write using native code to not require -- cgit v1.2.3