You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ti...@apache.org on 2015/01/17 17:19:50 UTC

svn commit: r1652635 - /pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/

Author: tilman
Date: Sat Jan 17 16:19:50 2015
New Revision: 1652635

URL: http://svn.apache.org/r1652635
Log:
PDFBOX-2576: remove "_" prefix in parameters, remove unneeded exception throws, remove public from interface, make fields final

Modified:
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/PushBackInputStream.java
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccess.java
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessBufferedFileInputStream.java
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessFile.java
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessFileInputStream.java
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessFileOutputStream.java
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessRead.java
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/SequentialRead.java

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/PushBackInputStream.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/PushBackInputStream.java?rev=1652635&r1=1652634&r2=1652635&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/PushBackInputStream.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/PushBackInputStream.java Sat Jan 17 16:19:50 2015
@@ -85,6 +85,7 @@ public class PushBackInputStream extends
     /**
      * {@inheritDoc} 
      */
+    @Override
     public int read() throws IOException
     {
         int retval = super.read();
@@ -98,6 +99,7 @@ public class PushBackInputStream extends
     /**
      * {@inheritDoc} 
      */
+    @Override
     public int read(byte[] b) throws IOException
     {
         return this.read(b, 0, b.length);
@@ -105,6 +107,7 @@ public class PushBackInputStream extends
     /**
      * {@inheritDoc} 
      */
+    @Override
     public int read(byte[] b, int off, int len) throws IOException
     {
         int retval = super.read(b, off, len);
@@ -118,6 +121,7 @@ public class PushBackInputStream extends
     /**
      * {@inheritDoc} 
      */
+    @Override
     public void unread(int b) throws IOException
     {
         offset--;
@@ -127,6 +131,7 @@ public class PushBackInputStream extends
     /**
      * {@inheritDoc} 
      */
+    @Override
     public void unread(byte[] b) throws IOException
     {
         this.unread(b, 0, b.length);
@@ -135,6 +140,7 @@ public class PushBackInputStream extends
     /**
      * {@inheritDoc} 
      */
+    @Override
     public void unread(byte[] b, int off, int len) throws IOException
     {
         if (len > 0)

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccess.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccess.java?rev=1652635&r1=1652634&r2=1652635&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccess.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccess.java Sat Jan 17 16:19:50 2015
@@ -34,7 +34,7 @@ public interface RandomAccess extends Ra
      * @param b The byte to write.
      * @throws IOException If there is an IO error while writing.
      */
-    public void write(int b) throws IOException;
+    void write(int b) throws IOException;
 
     /**
      * Write a buffer of data to the stream.
@@ -44,6 +44,6 @@ public interface RandomAccess extends Ra
      * @param length The length of data to write.
      * @throws IOException If there is an error while writing the data.
      */
-    public void write(byte[] b, int offset, int length) throws IOException;
+    void write(byte[] b, int offset, int length) throws IOException;
 
 }

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessBufferedFileInputStream.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessBufferedFileInputStream.java?rev=1652635&r1=1652634&r2=1652635&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessBufferedFileInputStream.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessBufferedFileInputStream.java Sat Jan 17 16:19:50 2015
@@ -17,7 +17,6 @@
 package org.apache.pdfbox.io;
 
 import java.io.File;
-import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.RandomAccessFile;
@@ -52,12 +51,12 @@ extends InputStream implements RandomAcc
         private static final long serialVersionUID = -6302488539257741101L;
 
         @Override
-        protected boolean removeEldestEntry( Map.Entry<Long, byte[]> _eldest )
+        protected boolean removeEldestEntry( Map.Entry<Long, byte[]> eldest )
         {
             final boolean doRemove = size() > maxCachedPages;
             if (doRemove)
             {
-                lastRemovedCachePage = _eldest.getValue();
+                lastRemovedCachePage = eldest.getValue();
             }
             return doRemove;
         }
@@ -73,11 +72,10 @@ extends InputStream implements RandomAcc
     private boolean isClosed;
     
     /** Create input stream instance for given file. */
-    public RandomAccessBufferedFileInputStream( File _file )
-    throws FileNotFoundException, IOException
+    public RandomAccessBufferedFileInputStream( File file ) throws IOException 
     {
-        raFile = new RandomAccessFile(_file, "r");
-        fileLength = _file.length();
+        raFile = new RandomAccessFile(file, "r");
+        fileLength = file.length();
 
         seek(0);
     }
@@ -190,7 +188,9 @@ extends InputStream implements RandomAcc
 
         int commonLen = Math.min( pageSize - offsetWithinPage, len );
         if ( ( fileLength - fileOffset ) < pageSize )
+        {
             commonLen = Math.min( commonLen, (int) ( fileLength - fileOffset ) );
+        }
 
         System.arraycopy( curPage, offsetWithinPage, b, off, commonLen );
 

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessFile.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessFile.java?rev=1652635&r1=1652634&r2=1652635&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessFile.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessFile.java Sat Jan 17 16:19:50 2015
@@ -30,7 +30,7 @@ import java.io.IOException;
  */
 public class RandomAccessFile implements RandomAccess, Closeable
 {
-    private java.io.RandomAccessFile ras;
+    private final java.io.RandomAccessFile ras;
     private boolean isClosed;
 
     /**

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessFileInputStream.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessFileInputStream.java?rev=1652635&r1=1652634&r2=1652635&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessFileInputStream.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessFileInputStream.java Sat Jan 17 16:19:50 2015
@@ -28,9 +28,9 @@ import java.io.IOException;
  */
 public class RandomAccessFileInputStream extends InputStream
 {
-    private RandomAccess file;
+    private final RandomAccess file;
     private long currentPosition;
-    private long endPosition;
+    private final long endPosition;
 
     /**
      * Constructor.
@@ -48,6 +48,7 @@ public class RandomAccessFileInputStream
     /**
      * {@inheritDoc}
      */
+    @Override
     public int available()
     {
         return (int)(endPosition - currentPosition);
@@ -55,6 +56,7 @@ public class RandomAccessFileInputStream
     /**
      * {@inheritDoc}
      */
+    @Override
     public void close()
     {
         //do nothing because we want to leave the random access file open.
@@ -62,6 +64,7 @@ public class RandomAccessFileInputStream
     /**
      * {@inheritDoc}
      */
+    @Override
     public int read() throws IOException
     {
         synchronized(file)
@@ -79,6 +82,7 @@ public class RandomAccessFileInputStream
     /**
      * {@inheritDoc}
      */
+    @Override
     public int read( byte[] b, int offset, int length ) throws IOException
     {
         //only allow a read of the amount available.
@@ -108,6 +112,7 @@ public class RandomAccessFileInputStream
     /**
      * {@inheritDoc}
      */
+    @Override
     public long skip( long amountToSkip )
     {
         long amountSkipped = Math.min( amountToSkip, available() );

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessFileOutputStream.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessFileOutputStream.java?rev=1652635&r1=1652634&r2=1652635&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessFileOutputStream.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessFileOutputStream.java Sat Jan 17 16:19:50 2015
@@ -32,8 +32,8 @@ import org.apache.pdfbox.cos.COSNumber;
  */
 public class RandomAccessFileOutputStream extends OutputStream
 {
-    private RandomAccess file;
-    private long position;
+    private final RandomAccess file;
+    private final long position;
     private long lengthWritten = 0;
     private COSBase expectedLength = null;
 
@@ -103,6 +103,7 @@ public class RandomAccessFileOutputStrea
     /**
      * {@inheritDoc}
      */
+    @Override
     public void write( byte[] b, int offset, int length ) throws IOException
     {
         file.seek( position+lengthWritten );
@@ -113,6 +114,7 @@ public class RandomAccessFileOutputStrea
     /**
      * {@inheritDoc}
      */
+    @Override
     public void write( int b ) throws IOException
     {
         file.seek( position+lengthWritten );

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessRead.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessRead.java?rev=1652635&r1=1652634&r2=1652635&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessRead.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/RandomAccessRead.java Sat Jan 17 16:19:50 2015
@@ -32,7 +32,7 @@ public interface RandomAccessRead extend
      *         
      * @throws IOException 
      */
-    public long getPosition() throws IOException;
+    long getPosition() throws IOException;
     
     /**
      * Seek to a position in the data.
@@ -40,7 +40,7 @@ public interface RandomAccessRead extend
      * @param position The position to seek to.
      * @throws IOException If there is an error while seeking.
      */
-    public void seek(long position) throws IOException;
+    void seek(long position) throws IOException;
 
     /**
      * The total number of bytes that are available.
@@ -50,10 +50,10 @@ public interface RandomAccessRead extend
      * @throws IOException If there is an IO error while determining the
      * length of the data stream.
      */
-    public long length() throws IOException;
+    long length() throws IOException;
 
     /**
      * Returns true if this stream has been closed.
      */
-    public boolean isClosed();
+    boolean isClosed();
 }

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/SequentialRead.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/SequentialRead.java?rev=1652635&r1=1652634&r2=1652635&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/SequentialRead.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/io/SequentialRead.java Sat Jan 17 16:19:50 2015
@@ -29,7 +29,7 @@ public interface SequentialRead
      *
      * @throws IOException If there is an error closing this resource.
      */
-    public void close() throws IOException;
+    void close() throws IOException;
 
     /**
      * Read a single byte of data.
@@ -38,7 +38,7 @@ public interface SequentialRead
      *
      * @throws IOException If there is an error while reading the data.
      */
-    public int read() throws IOException;
+    int read() throws IOException;
 
     /**
      * Read a buffer of data.
@@ -49,6 +49,6 @@ public interface SequentialRead
      * @return The number of bytes that were actually read.
      * @throws IOException If there was an error while reading the data.
      */
-    public int read(byte[] b, int offset, int length) throws IOException;
+    int read(byte[] b, int offset, int length) throws IOException;
 
 }