Formatting. Changed static factory method to constructor.

Author: oschwald

src/main/java/com/maxmind/db/Metadata.java

@@ -36,7 +36,7 @@ public Metadata(JsonNode metadata) {
 
     /*
      * (non-Javadoc)
-     * 
+     *
      * @see java.lang.Object#toString()
      */
     @Override

src/main/java/com/maxmind/db/Reader.java

@@ -43,7 +43,7 @@ public enum FileMode {
     /**
      * Constructs a Reader for the MaxMind DB format. The file passed to it must
      * be a valid MaxMind DB file such as a GeoIP2 database file.
-     * 
+     *
      * @param database
      *            the MaxMind DB file to use.
      * @throws IOException
@@ -56,18 +56,20 @@ public Reader(File database) throws IOException {
     /**
      * Constructs a Reader as if in mode {@link FileMode#MEMORY}, without using
      * a <code>File</code> instance.
-     * @param source the InputStream that contains the MaxMind DB file.
+     *
+     * @param source
+     *            the InputStream that contains the MaxMind DB file.
      * @throws IOException
      *             if there is an error reading from the Stream.
      */
     public Reader(InputStream source) throws IOException {
-        this(ThreadBuffer.newInstance(source), "an InputStream");
+        this(new ThreadBuffer(source), "<InputStream>");
     }
 
     /**
      * Constructs a Reader for the MaxMind DB format. The file passed to it must
      * be a valid MaxMind DB file such as a GeoIP2 database file.
-     * 
+     *
      * @param database
      *            the MaxMind DB file to use.
      * @param fileMode
@@ -91,7 +93,7 @@ private Reader(ThreadBuffer buffer, String name) throws IOException {
 
     /**
      * Looks up the <code>address</code> in the MaxMind DB.
-     * 
+     *
      * @param ipAddress
      *            the IP address to look up.
      * @return the record for the IP address.
@@ -206,7 +208,7 @@ private JsonNode resolveDataPointer(int pointer) throws IOException {
     /*
      * Apparently searching a file for a sequence is not a solved problem in
      * Java. This searches from the end of the file for metadata start.
-     * 
+     *
      * This is an extremely naive but reasonably readable implementation. There
      * are much faster algorithms (e.g., Boyer-Moore) for this if speed is ever
      * an issue, but I suspect it won't be.
@@ -237,7 +239,7 @@ Metadata getMetadata() {
 
     /**
      * Closes the MaxMind DB and returns resources to the system.
-     * 
+     *
      * @throws IOException
      *             if an I/O error occurs.
      */

src/main/java/com/maxmind/db/ThreadBuffer.java

@@ -3,8 +3,8 @@
 import java.io.ByteArrayOutputStream;
 import java.io.Closeable;
 import java.io.File;
-import java.io.InputStream;
 import java.io.IOException;
+import java.io.InputStream;
 import java.io.RandomAccessFile;
 import java.nio.ByteBuffer;
 import java.nio.channels.FileChannel;
@@ -13,27 +13,6 @@
 import com.maxmind.db.Reader.FileMode;
 
 final class ThreadBuffer extends ThreadLocal<ByteBuffer> implements Closeable {
-    /**
-     * Construct a ThreadBuffer from the provided URL.
-     * @param stream the source of my bytes.
-     * @return a newly constructed instance based on the contents of your URL.
-     * @throws IOException if unable to read from your source.
-     * @throws NullPointerException if you provide a NULL InputStream
-     */
-    public static ThreadBuffer newInstance(InputStream stream) throws IOException {
-        if (null == stream) {
-            throw new NullPointerException("Unable to use a NULL InputStream");
-        }
-        final ByteArrayOutputStream baos = new ByteArrayOutputStream();
-        final byte[] buffer = new byte[16 * 1024];
-        int br;
-        while (-1 != (br = stream.read(buffer))) {
-            baos.write(buffer, 0, br);
-        }
-        final ByteBuffer bBuffer = ByteBuffer.wrap(baos.toByteArray());
-        return new ThreadBuffer(bBuffer);
-    }
-
     // DO NOT PASS THESE OUTSIDE THIS CLASS. Doing so will remove thread
     // safety.
     private final ByteBuffer buffer;
@@ -51,6 +30,32 @@ public static ThreadBuffer newInstance(InputStream stream) throws IOException {
         }
     }
 
+    /**
+     * Construct a ThreadBuffer from the provided URL.
+     *
+     * @param stream
+     *            the source of my bytes.
+     * @return a newly constructed instance based on the contents of your URL.
+     * @throws IOException
+     *             if unable to read from your source.
+     * @throws NullPointerException
+     *             if you provide a NULL InputStream
+     */
+    ThreadBuffer(InputStream stream) throws IOException {
+        if (null == stream) {
+            throw new NullPointerException("Unable to use a NULL InputStream");
+        }
+        final ByteArrayOutputStream baos = new ByteArrayOutputStream();
+        final byte[] bytes = new byte[16 * 1024];
+        int br;
+        while (-1 != (br = stream.read(bytes))) {
+            baos.write(bytes, 0, br);
+        }
+        this.buffer = ByteBuffer.wrap(baos.toByteArray());
+        this.raf = null;
+        this.fc = null;
+    }
+
     // This is just to ease unit testing
     ThreadBuffer(ByteBuffer buffer) {
         this.buffer = buffer;

src/test/java/com/maxmind/db/ReaderTest.java

@@ -28,8 +28,7 @@ public class ReaderTest {
     private final ObjectMapper om = new ObjectMapper();
 
     @Test
-    public void test() throws IOException,
-            URISyntaxException {
+    public void test() throws IOException, URISyntaxException {
         for (long recordSize : new long[] { 24, 28, 32 }) {
             for (int ipVersion : new int[] { 4, 6 }) {
                 URI file = ReaderTest.class.getResource(
@@ -52,24 +51,28 @@ public void test() throws IOException,
     }
 
     @Test
-    public void testNoIpV4SearchTreeFile() throws IOException, URISyntaxException {
+    public void testNoIpV4SearchTreeFile() throws IOException,
+            URISyntaxException {
         URI file = ReaderTest.class.getResource(
                 "/maxmind-db/test-data/MaxMind-DB-no-ipv4-search-tree.mmdb")
                 .toURI();
 
         Reader reader = new Reader(new File(file));
-        testNoIpV4SearchTree(reader);
+        this.testNoIpV4SearchTree(reader);
     }
+
     @Test
-    public void testNoIpV4SearchTreeURL() throws IOException, URISyntaxException {
+    public void testNoIpV4SearchTreeURL() throws IOException,
+            URISyntaxException {
         InputStream stream = ReaderTest.class.getResource(
                 "/maxmind-db/test-data/MaxMind-DB-no-ipv4-search-tree.mmdb")
                 .openStream();
         Reader reader = new Reader(stream);
-        testNoIpV4SearchTree(reader);
+        this.testNoIpV4SearchTree(reader);
     }
-    private void testNoIpV4SearchTree(Reader reader) throws IOException, URISyntaxException {
 
+    private void testNoIpV4SearchTree(Reader reader) throws IOException,
+            URISyntaxException {
 
         assertEquals("::/64", reader.get(InetAddress.getByName("1.1.1.1"))
                 .textValue());
@@ -83,18 +86,21 @@ public void testDecodingTypesFile() throws URISyntaxException, IOException {
                 "/maxmind-db/test-data/MaxMind-DB-test-decoder.mmdb").toURI();
 
         Reader reader = new Reader(new File(file));
-        testDecodingTypes(reader);
+        this.testDecodingTypes(reader);
     }
+
     @Test
     public void testDecodingTypesURL() throws URISyntaxException, IOException {
         InputStream stream = ReaderTest.class.getResource(
                 "/maxmind-db/test-data/MaxMind-DB-test-decoder.mmdb")
                 .openStream();
 
         Reader reader = new Reader(stream);
-        testDecodingTypes(reader);
+        this.testDecodingTypes(reader);
     }
-    private void testDecodingTypes(Reader reader) throws URISyntaxException, IOException {
+
+    private void testDecodingTypes(Reader reader) throws URISyntaxException,
+            IOException {
         JsonNode record = reader.get(InetAddress.getByName("::1.1.1.0"));
 
         assertEquals(true, record.get("boolean").booleanValue());
@@ -143,18 +149,21 @@ public void testZerosFile() throws URISyntaxException, IOException {
                 "/maxmind-db/test-data/MaxMind-DB-test-decoder.mmdb").toURI();
 
         Reader reader = new Reader(new File(file));
-        testZeros(reader);
+        this.testZeros(reader);
     }
+
     @Test
     public void testZerosURL() throws URISyntaxException, IOException {
         InputStream stream = ReaderTest.class.getResource(
                 "/maxmind-db/test-data/MaxMind-DB-test-decoder.mmdb")
                 .openStream();
 
         Reader reader = new Reader(stream);
-        testZeros(reader);
+        this.testZeros(reader);
     }
-    private void testZeros(Reader reader) throws URISyntaxException, IOException {
+
+    private void testZeros(Reader reader) throws URISyntaxException,
+            IOException {
         JsonNode record = reader.get(InetAddress.getByName("::"));
 
         assertEquals(false, record.get("boolean").booleanValue());
@@ -189,8 +198,9 @@ public void testBrokenDatabaseFile() throws URISyntaxException, IOException {
                 .toURI();
 
         Reader reader = new Reader(new File(file));
-        testBrokenDatabase(reader);
+        this.testBrokenDatabase(reader);
     }
+
     @Test
     public void testBrokenDatabaseURL() throws URISyntaxException, IOException {
         InputStream stream = ReaderTest.class
@@ -199,9 +209,11 @@ public void testBrokenDatabaseURL() throws URISyntaxException, IOException {
                 .openStream();
 
         Reader reader = new Reader(stream);
-        testBrokenDatabase(reader);
+        this.testBrokenDatabase(reader);
     }
-    private void testBrokenDatabase(Reader reader) throws URISyntaxException, IOException {
+
+    private void testBrokenDatabase(Reader reader) throws URISyntaxException,
+            IOException {
 
         this.thrown.expect(InvalidDatabaseException.class);
         this.thrown
@@ -219,8 +231,9 @@ public void testBrokenSearchTreePointerFile() throws URISyntaxException,
                 .toURI();
 
         Reader reader = new Reader(new File(file));
-        testBrokenSearchTreePointer(reader);
+        this.testBrokenSearchTreePointer(reader);
     }
+
     @Test
     public void testBrokenSearchTreePointerURL() throws URISyntaxException,
             IOException {
@@ -230,10 +243,11 @@ public void testBrokenSearchTreePointerURL() throws URISyntaxException,
                 .openStream();
 
         Reader reader = new Reader(stream);
-        testBrokenSearchTreePointer(reader);
+        this.testBrokenSearchTreePointer(reader);
     }
-    private void testBrokenSearchTreePointer(Reader reader) throws URISyntaxException,
-                IOException {
+
+    private void testBrokenSearchTreePointer(Reader reader)
+            throws URISyntaxException, IOException {
 
         this.thrown.expect(InvalidDatabaseException.class);
         this.thrown
@@ -243,26 +257,31 @@ private void testBrokenSearchTreePointer(Reader reader) throws URISyntaxExceptio
     }
 
     @Test
-    public void testBrokenDataPointerFile() throws IOException, URISyntaxException {
+    public void testBrokenDataPointerFile() throws IOException,
+            URISyntaxException {
         URI file = ReaderTest.class
                 .getResource(
                         "/maxmind-db/test-data/MaxMind-DB-test-broken-pointers-24.mmdb")
                 .toURI();
 
         Reader reader = new Reader(new File(file));
-        testBrokenDataPointer(reader);
+        this.testBrokenDataPointer(reader);
     }
+
     @Test
-    public void testBrokenDataPointerURL() throws IOException, URISyntaxException {
+    public void testBrokenDataPointerURL() throws IOException,
+            URISyntaxException {
         InputStream stream = ReaderTest.class
                 .getResource(
-                    "/maxmind-db/test-data/MaxMind-DB-test-broken-pointers-24.mmdb")
+                        "/maxmind-db/test-data/MaxMind-DB-test-broken-pointers-24.mmdb")
                 .openStream();
 
         Reader reader = new Reader(stream);
-        testBrokenDataPointer(reader);
+        this.testBrokenDataPointer(reader);
     }
-    private void testBrokenDataPointer(Reader reader) throws IOException, URISyntaxException {
+
+    private void testBrokenDataPointer(Reader reader) throws IOException,
+            URISyntaxException {
 
         this.thrown.expect(InvalidDatabaseException.class);
         this.thrown
@@ -271,8 +290,7 @@ private void testBrokenDataPointer(Reader reader) throws IOException, URISyntaxE
         reader.get(InetAddress.getByName("1.1.1.16"));
     }
 
-    private void testMetadata(Reader reader, int ipVersion,
-            long recordSize) {
+    private void testMetadata(Reader reader, int ipVersion, long recordSize) {
 
         Metadata metadata = reader.getMetadata();
 
@@ -291,8 +309,7 @@ private void testMetadata(Reader reader, int ipVersion,
         assertEquals(recordSize, metadata.recordSize);
     }
 
-    private void testIpV4(Reader reader, URI file)
-            throws IOException {
+    private void testIpV4(Reader reader, URI file) throws IOException {
 
         for (int i = 0; i <= 5; i++) {
             String address = "1.1.1." + (int) Math.pow(2, i);
@@ -325,8 +342,7 @@ private void testIpV4(Reader reader, URI file)
     }
 
     // XXX - logic could be combined with above
-    private void testIpV6(Reader reader, URI file)
-            throws IOException {
+    private void testIpV6(Reader reader, URI file) throws IOException {
         String[] subnets = new String[] { "::1:ffff:ffff", "::2:0:0",
                 "::2:0:40", "::2:0:50", "::2:0:58" };