harmony-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From telli...@apache.org
Subject svn commit: r432335 - /incubator/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/io/FileInputStream.java
Date Thu, 17 Aug 2006 18:49:22 GMT
Author: tellison
Date: Thu Aug 17 11:49:21 2006
New Revision: 432335

URL: http://svn.apache.org/viewvc?rev=432335&view=rev
Log:
Source clean-up / formatting.

Modified:
    incubator/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/io/FileInputStream.java

Modified: incubator/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/io/FileInputStream.java
URL: http://svn.apache.org/viewvc/incubator/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/io/FileInputStream.java?rev=432335&r1=432334&r2=432335&view=diff
==============================================================================
--- incubator/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/io/FileInputStream.java
(original)
+++ incubator/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/io/FileInputStream.java
Thu Aug 17 11:49:21 2006
@@ -15,7 +15,6 @@
 
 package java.io;
 
-
 import java.nio.channels.FileChannel;
 
 import org.apache.harmony.luni.platform.IFileSystem;
@@ -30,105 +29,107 @@
  * 
  * @see FileOutputStream
  */
-public class FileInputStream extends InputStream implements Closeable{
-	/**
-	 * The FileDescriptor representing this FileInputStream.
-	 */
-	FileDescriptor fd;
-
-	// The unique file channel associated with this FileInputStream (lazily
-	// initialized).
-	private FileChannel channel;
+public class FileInputStream extends InputStream implements Closeable {
+    /**
+     * The FileDescriptor representing this FileInputStream.
+     */
+    FileDescriptor fd;
+
+    // The unique file channel associated with this FileInputStream (lazily
+    // initialized).
+    private FileChannel channel;
 
     private IFileSystem fileSystem = Platform.getFileSystem();
 
     private Object repositioningLock = new Object();
 
-	/**
-	 * Constructs a new FileInputStream on the File <code>file</code>. If the
-	 * file does not exist, the <code>FileNotFoundException</code> is thrown.
-	 * 
-	 * @param file
-	 *            the File on which to stream reads.
-	 * 
-	 * @throws FileNotFoundException
-	 *             If the <code>file</code> is not found.
-	 * 
-	 * @see java.lang.SecurityManager#checkRead(FileDescriptor)
-	 * @see java.lang.SecurityManager#checkRead(String)
-	 * @see java.lang.SecurityManager#checkRead(String, Object)
-	 */
-	public FileInputStream(File file) throws FileNotFoundException {
-		super();
-		SecurityManager security = System.getSecurityManager();
-		if (security != null) {
+    /**
+     * Constructs a new FileInputStream on the File <code>file</code>. If the
+     * file does not exist, the <code>FileNotFoundException</code> is thrown.
+     * 
+     * @param file
+     *            the File on which to stream reads.
+     * 
+     * @throws FileNotFoundException
+     *             If the <code>file</code> is not found.
+     * 
+     * @see java.lang.SecurityManager#checkRead(FileDescriptor)
+     * @see java.lang.SecurityManager#checkRead(String)
+     * @see java.lang.SecurityManager#checkRead(String, Object)
+     */
+    public FileInputStream(File file) throws FileNotFoundException {
+        super();
+        SecurityManager security = System.getSecurityManager();
+        if (security != null) {
             String filePath = (null == file ? null : file.getPath());
             security.checkRead(filePath);
         }
-		fd = new FileDescriptor();
-		fd.descriptor = fileSystem.open(file.properPath(true),
+        fd = new FileDescriptor();
+        fd.descriptor = fileSystem.open(file.properPath(true),
                 IFileSystem.O_RDONLY);
         channel = FileChannelFactory.getFileChannel(this, fd.descriptor,
                 IFileSystem.O_RDONLY);
-	}
+    }
 
-	/**
-	 * Constructs a new FileInputStream on the FileDescriptor <code>fd</code>.
-	 * The file must already be open, therefore no
-	 * <code>FileNotFoundException</code> will be thrown.
-	 * 
-	 * @param fd
-	 *            the FileDescriptor on which to stream reads.
-	 * 
-	 * @see java.lang.SecurityManager#checkRead(FileDescriptor)
-	 * @see java.lang.SecurityManager#checkRead(String)
-	 * @see java.lang.SecurityManager#checkRead(String, Object)
-	 */
-	public FileInputStream(FileDescriptor fd) {
-		super();
-		if (fd == null) {
+    /**
+     * Constructs a new FileInputStream on the FileDescriptor <code>fd</code>.
+     * The file must already be open, therefore no
+     * <code>FileNotFoundException</code> will be thrown.
+     * 
+     * @param fd
+     *            the FileDescriptor on which to stream reads.
+     * 
+     * @see java.lang.SecurityManager#checkRead(FileDescriptor)
+     * @see java.lang.SecurityManager#checkRead(String)
+     * @see java.lang.SecurityManager#checkRead(String, Object)
+     */
+    public FileInputStream(FileDescriptor fd) {
+        super();
+        if (fd == null) {
             throw new NullPointerException();
         }
         SecurityManager security = System.getSecurityManager();
-        if (security != null)
+        if (security != null) {
             security.checkRead(fd);
+        }
         this.fd = fd;
         channel = FileChannelFactory.getFileChannel(this, fd.descriptor,
                 IFileSystem.O_RDONLY);
-	}
+    }
 
-	/**
-	 * Constructs a new FileInputStream on the file named <code>fileName</code>.
-	 * If the file does not exist, the <code>FileNotFoundException</code> is
-	 * thrown. The <code>fileName</code> may be absolute or relative to the
-	 * System property <code>"user.dir"</code>.
-	 * 
-	 * @param fileName
-	 *            the file on which to stream reads.
-	 * 
-	 * @throws FileNotFoundException
-	 *             If the <code>fileName</code> is not found.
-	 */
-	public FileInputStream(String fileName) throws FileNotFoundException {
-        this(null == fileName ? (File)null : new File(fileName));
-	}
-
-	/**
-	 * Answers a int representing then number of bytes that are available before
-	 * this InputStream will block. This method always returns the size of the
-	 * file minus the current position.
-	 * 
-	 * @return the number of bytes available before blocking.
-	 * 
-	 * @throws IOException
-	 *             If an error occurs in this stream.
-	 */
-	public int available() throws IOException {
+    /**
+     * Constructs a new FileInputStream on the file named <code>fileName</code>.
+     * If the file does not exist, the <code>FileNotFoundException</code> is
+     * thrown. The <code>fileName</code> may be absolute or relative to the
+     * System property <code>"user.dir"</code>.
+     * 
+     * @param fileName
+     *            the file on which to stream reads.
+     * 
+     * @throws FileNotFoundException
+     *             If the <code>fileName</code> is not found.
+     */
+    public FileInputStream(String fileName) throws FileNotFoundException {
+        this(null == fileName ? (File) null : new File(fileName));
+    }
+
+    /**
+     * Answers a int representing then number of bytes that are available before
+     * this InputStream will block. This method always returns the size of the
+     * file minus the current position.
+     * 
+     * @return the number of bytes available before blocking.
+     * 
+     * @throws IOException
+     *             If an error occurs in this stream.
+     */
+    @Override
+    public int available() throws IOException {
         openCheck();
         synchronized (repositioningLock) {
             // stdin requires special handling
             if (fd == FileDescriptor.in) {
-            	return (int)fileSystem.ttyAvailable();
+                return (int) fileSystem.ttyAvailable();
             }
 
             long currentPosition = fileSystem.seek(fd.descriptor, 0L,
@@ -141,12 +142,13 @@
         }
     }
 
-	/**
-	 * Close the FileInputStream.
-	 * 
-	 * @throws IOException
-	 *             If an error occurs attempting to close this FileInputStream.
-	 */
+    /**
+     * Close the FileInputStream.
+     * 
+     * @throws IOException
+     *             If an error occurs attempting to close this FileInputStream.
+     */
+    @Override
     public void close() throws IOException {
         if (fd == null) {
             // if fd is null, then the underlying file is not opened, so nothing
@@ -181,100 +183,104 @@
         }
     }
 
-	/**
-	 * This method ensures that all resources for this file are released when it
-	 * is about to be garbage collected.
-	 * 
-	 * @throws IOException
-	 *             If an error occurs attempting to finalize this
-	 *             FileInputStream.
-	 */
-	protected void finalize() throws IOException {
-		close();
-	}
-
-	/**
-	 * Answers the FileChannel equivalent to this input stream.
-	 * <p>
-	 * The file channel is read-only and has an initial position within the file
-	 * that is the same as the current position of the FileInputStream within
-	 * the file. All changes made to the underlying file descriptor state via
-	 * the channel are visible by the input stream and vice versa.
-	 * </p>
-	 * 
-	 * @return the file channel representation for this FileInputStream.
-	 */
-	public FileChannel getChannel() {
-		return channel;
-	}
-
-	/**
-	 * Answers the FileDescriptor representing the operating system resource for
-	 * this FileInputStream.
-	 * 
-	 * @return the FileDescriptor for this FileInputStream.
-	 * 
-	 * @throws IOException
-	 *             If an error occurs attempting to get the FileDescriptor of
-	 *             this FileInputStream.
-	 */
-	public final FileDescriptor getFD() throws IOException {
-		return fd;
-	}
-
-	/**
-	 * Reads a single byte from this FileInputStream and returns the result as
-	 * an int. The low-order byte is returned or -1 of the end of stream was
-	 * encountered.
-	 * 
-	 * @return the byte read or -1 if end of stream.
-	 * 
-	 * @throws IOException
-	 *             If the stream is already closed or another IOException
-	 *             occurs.
-	 */
-	public int read() throws IOException {
-		byte[] readed = new byte[1];
+    /**
+     * This method ensures that all resources for this file are released when it
+     * is about to be garbage collected.
+     * 
+     * @throws IOException
+     *             If an error occurs attempting to finalize this
+     *             FileInputStream.
+     */
+    @Override
+    protected void finalize() throws IOException {
+        close();
+    }
+
+    /**
+     * Answers the FileChannel equivalent to this input stream.
+     * <p>
+     * The file channel is read-only and has an initial position within the file
+     * that is the same as the current position of the FileInputStream within
+     * the file. All changes made to the underlying file descriptor state via
+     * the channel are visible by the input stream and vice versa.
+     * </p>
+     * 
+     * @return the file channel representation for this FileInputStream.
+     */
+    public FileChannel getChannel() {
+        return channel;
+    }
+
+    /**
+     * Answers the FileDescriptor representing the operating system resource for
+     * this FileInputStream.
+     * 
+     * @return the FileDescriptor for this FileInputStream.
+     * 
+     * @throws IOException
+     *             If an error occurs attempting to get the FileDescriptor of
+     *             this FileInputStream.
+     */
+    public final FileDescriptor getFD() throws IOException {
+        return fd;
+    }
+
+    /**
+     * Reads a single byte from this FileInputStream and returns the result as
+     * an int. The low-order byte is returned or -1 of the end of stream was
+     * encountered.
+     * 
+     * @return the byte read or -1 if end of stream.
+     * 
+     * @throws IOException
+     *             If the stream is already closed or another IOException
+     *             occurs.
+     */
+    @Override
+    public int read() throws IOException {
+        byte[] readed = new byte[1];
         int result = read(readed, 0, 1);
         return result == -1 ? -1 : readed[0] & 0xff;
-	}
+    }
 
-	/**
-	 * Reads bytes from the FileInputStream and stores them in byte array
-	 * <code>buffer</code>. Answer the number of bytes actually read or -1 if
-	 * no bytes were read and end of stream was encountered.
-	 * 
-	 * @param buffer
-	 *            the byte array in which to store the read bytes.
-	 * @return the number of bytes actually read or -1 if end of stream.
-	 * 
-	 * @throws IOException
-	 *             If the stream is already closed or another IOException
-	 *             occurs.
-	 */
-	public int read(byte[] buffer) throws IOException {
-		return read(buffer, 0, buffer.length);
-	}
-
-	/**
-	 * Reads at most <code>count</code> bytes from the FileInputStream and
-	 * stores them in byte array <code>buffer</code> starting at
-	 * <code>offset</code>. Answer the number of bytes actually read or -1 if
-	 * no bytes were read and end of stream was encountered.
-	 * 
-	 * @param buffer
-	 *            the byte array in which to store the read bytes.
-	 * @param offset
-	 *            the offset in <code>buffer</code> to store the read bytes.
-	 * @param count
-	 *            the maximum number of bytes to store in <code>buffer</code>.
-	 * @return the number of bytes actually read or -1 if end of stream.
-	 * 
-	 * @throws IOException
-	 *             If the stream is already closed or another IOException
-	 *             occurs.
-	 */
-	public int read(byte[] buffer, int offset, int count) throws IOException {
+    /**
+     * Reads bytes from the FileInputStream and stores them in byte array
+     * <code>buffer</code>. Answer the number of bytes actually read or -1 if
+     * no bytes were read and end of stream was encountered.
+     * 
+     * @param buffer
+     *            the byte array in which to store the read bytes.
+     * @return the number of bytes actually read or -1 if end of stream.
+     * 
+     * @throws IOException
+     *             If the stream is already closed or another IOException
+     *             occurs.
+     */
+    @Override
+    public int read(byte[] buffer) throws IOException {
+        return read(buffer, 0, buffer.length);
+    }
+
+    /**
+     * Reads at most <code>count</code> bytes from the FileInputStream and
+     * stores them in byte array <code>buffer</code> starting at
+     * <code>offset</code>. Answer the number of bytes actually read or -1 if
+     * no bytes were read and end of stream was encountered.
+     * 
+     * @param buffer
+     *            the byte array in which to store the read bytes.
+     * @param offset
+     *            the offset in <code>buffer</code> to store the read bytes.
+     * @param count
+     *            the maximum number of bytes to store in <code>buffer</code>.
+     * @return the number of bytes actually read or -1 if end of stream.
+     * 
+     * @throws IOException
+     *             If the stream is already closed or another IOException
+     *             occurs.
+     */
+    @Override
+    public int read(byte[] buffer, int offset, int count) throws IOException {
         if (count > buffer.length - offset || count < 0 || offset < 0) {
             throw new IndexOutOfBoundsException();
         }
@@ -285,52 +291,53 @@
         synchronized (repositioningLock) {
             // stdin requires special handling
             if (fd == FileDescriptor.in) {
-            	return (int)fileSystem.ttyRead(buffer, offset, count);
+                return (int) fileSystem.ttyRead(buffer, offset, count);
             }
             return (int) fileSystem.read(fd.descriptor, buffer, offset, count);
         }
-	}
+    }
 
-	/**
-	 * Skips <code>count</code> number of bytes in this FileInputStream.
-	 * Subsequent <code>read()</code>'s will not return these bytes unless
-	 * <code>reset()</code> is used. This method may perform multiple reads to
-	 * read <code>count</code> bytes.
-	 * 
-	 * @param count
-	 *            the number of bytes to skip.
-	 * @return the number of bytes actually skipped.
-	 * 
-	 * @throws IOException
-	 *             If the stream is already closed or another IOException
-	 *             occurs.
-	 */
+    /**
+     * Skips <code>count</code> number of bytes in this FileInputStream.
+     * Subsequent <code>read()</code>'s will not return these bytes unless
+     * <code>reset()</code> is used. This method may perform multiple reads to
+     * read <code>count</code> bytes.
+     * 
+     * @param count
+     *            the number of bytes to skip.
+     * @return the number of bytes actually skipped.
+     * 
+     * @throws IOException
+     *             If the stream is already closed or another IOException
+     *             occurs.
+     */
+    @Override
     public long skip(long count) throws IOException {
         openCheck();
 
-    	if (count == 0) {
-			return 0;
-		}
-        if (count < 0){
+        if (count == 0) {
+            return 0;
+        }
+        if (count < 0) {
             // KA013=Number of bytes to skip cannot be negative
             throw new IOException(Msg.getString("KA013")); //$NON-NLS-1$
         }
 
-		// stdin requires special handling
-		if (fd == FileDescriptor.in) {
-			// Read and discard count bytes in 8k chunks
-			long skipped = 0, numRead;
-			int chunk = count < 8192 ? (int) count : 8192;
-			byte[] buffer = new byte[chunk];
-			for (long i = count / chunk; i >= 0; i--) {
-				numRead = fileSystem.ttyRead(buffer, 0, chunk);
-				skipped += numRead;
-				if (numRead < chunk) {
-					return skipped;
-				}
-			}
-			return skipped;
-		}
+        // stdin requires special handling
+        if (fd == FileDescriptor.in) {
+            // Read and discard count bytes in 8k chunks
+            long skipped = 0, numRead;
+            int chunk = count < 8192 ? (int) count : 8192;
+            byte[] buffer = new byte[chunk];
+            for (long i = count / chunk; i >= 0; i--) {
+                numRead = fileSystem.ttyRead(buffer, 0, chunk);
+                skipped += numRead;
+                if (numRead < chunk) {
+                    return skipped;
+                }
+            }
+            return skipped;
+        }
 
         synchronized (repositioningLock) {
             final long currentPosition = fileSystem.seek(fd.descriptor, 0L,



Mime
View raw message