Skip to content

Commit dbe1e8f

Browse files
committed
Edit description about nodes and deserialization
1 parent e5500b4 commit dbe1e8f

File tree

3 files changed

+7
-6
lines changed

3 files changed

+7
-6
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
package com.maxmind.db;
22

33
/**
4-
* {@code CacheKey} is used as a key in the node cache. It contains the offset of the
5-
* node in the database file, the class of the data at that node, and the type
6-
* of the data at that node.
4+
* {@code CacheKey} is used as a key in the data-section cache. It contains the offset of the
5+
* value in the database file, the class of the value, and the type
6+
* of the value.
77
*
8-
* @param <T> the type of data stored at the node
8+
* @param <T> the type of value
99
*/
1010
public final class CacheKey<T> {
1111
private final int offset;

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
* DatabaseRecord represents the data and metadata associated with a database
77
* lookup.
88
*
9-
* @param <T> the type of data stored at the node
9+
* @param <T> the type to deserialize the returned value to
1010
*/
1111
public final class DatabaseRecord<T> {
1212
private final T data;

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
import java.io.IOException;
44

55
/**
6-
* NodeCache is an interface for a cache that stores decoded nodes.
6+
* NodeCache is an interface for a cache that stores decoded values from the
7+
* data section of the database.
78
*/
89
public interface NodeCache {
910
/**

0 commit comments

Comments
 (0)