Skip to content

Commit fc615de

Browse files
committed
Update close() documentation
1 parent b0825b6 commit fc615de

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

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

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,17 @@ public Metadata getMetadata() {
241241
}
242242

243243
/**
244-
* Closes the MaxMind DB and returns resources to the system.
244+
/**
245+
* <p>
246+
* Closes the database.
247+
* </p>
248+
* <p>
249+
* If you are using <code>FileMode.MEMORY_MAPPED</code>, this will
250+
* <em>not</em> unmap the underlying file due to a limitation in Java's
251+
* <code>MappedByteBuffer</code>. It will however set the reference to
252+
* the buffer to <code>null</code>, allowing the garbage collector to
253+
* collect it.
254+
* </p>
245255
*
246256
* @throws IOException if an I/O error occurs.
247257
*/

0 commit comments

Comments
 (0)