|
| 1 | +<!DOCTYPE HTML> |
| 2 | +<html lang> |
| 3 | +<head> |
| 4 | +<!-- Generated by javadoc (25) on Mon Nov 10 13:36:39 PST 2025 --> |
| 5 | +<title>All Classes and Interfaces (MaxMind DB Reader 4.0.0 API)</title> |
| 6 | +<meta name="viewport" content="width=device-width, initial-scale=1"> |
| 7 | +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 8 | +<meta name="dc.created" content="2025-11-10"> |
| 9 | +<meta name="description" content="class index"> |
| 10 | +<meta name="generator" content="javadoc/AllClassesIndexWriter"> |
| 11 | +<link rel="stylesheet" type="text/css" href="resource-files/jquery-ui.min.css"> |
| 12 | +<link rel="stylesheet" type="text/css" href="resource-files/stylesheet.css"> |
| 13 | +<script type="text/javascript" src="script-files/script.js"></script> |
| 14 | +<script type="text/javascript" src="script-files/jquery-3.7.1.min.js"></script> |
| 15 | +<script type="text/javascript" src="script-files/jquery-ui.min.js"></script> |
| 16 | +</head> |
| 17 | +<body class="all-classes-index-page"> |
| 18 | +<script type="text/javascript">const pathtoroot = "./"; |
| 19 | +loadScripts(document, 'script');</script> |
| 20 | +<noscript> |
| 21 | +<div>JavaScript is disabled on your browser.</div> |
| 22 | +</noscript> |
| 23 | +<header role="banner"> |
| 24 | +<nav role="navigation"> |
| 25 | +<!-- ========= START OF TOP NAVBAR ======= --> |
| 26 | +<div class="top-nav" id="navbar-top"> |
| 27 | +<div class="nav-content"> |
| 28 | +<div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button></div> |
| 29 | +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| 30 | +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| 31 | +<li><a href="com.maxmind.db/module-summary.html">Module</a></li> |
| 32 | +<li><a href="com.maxmind.db/com/maxmind/db/package-tree.html">Tree</a></li> |
| 33 | +<li><a href="index-all.html">Index</a></li> |
| 34 | +<li><a href="search.html">Search</a></li> |
| 35 | +<li><a href="help-doc.html#all-classes">Help</a></li> |
| 36 | +</ul> |
| 37 | +</div> |
| 38 | +</div> |
| 39 | +<div class="sub-nav"> |
| 40 | +<div class="nav-content"> |
| 41 | +<ol class="sub-nav-list"></ol> |
| 42 | +<div class="nav-list-search"><input type="text" id="search-input" disabled placeholder="Search documentation (type /)" aria-label="Search in documentation" autocomplete="off" spellcheck="false"><input type="reset" id="reset-search" disabled value="Reset"></div> |
| 43 | +</div> |
| 44 | +</div> |
| 45 | +<!-- ========= END OF TOP NAVBAR ========= --> |
| 46 | +<span class="skip-nav" id="skip-navbar-top"></span></nav> |
| 47 | +</header> |
| 48 | +<div class="main-grid"> |
| 49 | +<main role="main"> |
| 50 | +<div class="header"> |
| 51 | +<h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1> |
| 52 | +</div> |
| 53 | +<div id="all-classes-table"> |
| 54 | +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="all-classes-table-tab0" role="tab" aria-selected="true" aria-controls="all-classes-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="all-classes-table-tab1" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab1', 2)" class="table-tab">Interfaces</button><button id="all-classes-table-tab2" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab2', 2)" class="table-tab">Classes</button><button id="all-classes-table-tab3" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab3', 2)" class="table-tab">Enum Classes</button><button id="all-classes-table-tab4" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab4', 2)" class="table-tab">Record Classes</button><button id="all-classes-table-tab5" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab5', 2)" class="table-tab">Exception Classes</button><button id="all-classes-table-tab6" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab6', 2)" class="table-tab">Annotation Interfaces</button></div> |
| 55 | +<div id="all-classes-table.tabpanel" role="tabpanel" aria-labelledby="all-classes-table-tab0"> |
| 56 | +<div class="summary-table two-column-summary"> |
| 57 | +<div class="table-header col-first">Class</div> |
| 58 | +<div class="table-header col-last">Description</div> |
| 59 | +<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="com.maxmind.db/com/maxmind/db/CacheKey.html" title="class in com.maxmind.db">CacheKey<T></a></div> |
| 60 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab4"> |
| 61 | +<div class="block"><code>CacheKey</code> is used as a key in the data-section cache.</div> |
| 62 | +</div> |
| 63 | +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com.maxmind.db/com/maxmind/db/CHMCache.html" title="class in com.maxmind.db">CHMCache</a></div> |
| 64 | +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> |
| 65 | +<div class="block">A simplistic cache using a <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/concurrent/ConcurrentHashMap.html" title="class or interface in java.util.concurrent" class="external-link"><code>ConcurrentHashMap</code></a>.</div> |
| 66 | +</div> |
| 67 | +<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="com.maxmind.db/com/maxmind/db/ClosedDatabaseException.html" title="class in com.maxmind.db">ClosedDatabaseException</a></div> |
| 68 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab5"> |
| 69 | +<div class="block">Signals that the underlying database has been closed.</div> |
| 70 | +</div> |
| 71 | +<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="com.maxmind.db/com/maxmind/db/ConstructorNotFoundException.html" title="class in com.maxmind.db">ConstructorNotFoundException</a></div> |
| 72 | +<div class="col-last odd-row-color all-classes-table all-classes-table-tab5"> |
| 73 | +<div class="block">Signals that no annotated constructor was found.</div> |
| 74 | +</div> |
| 75 | +<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="com.maxmind.db/com/maxmind/db/DatabaseRecord.html" title="class in com.maxmind.db">DatabaseRecord<T></a></div> |
| 76 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab4"> |
| 77 | +<div class="block">DatabaseRecord represents the data and metadata associated with a database |
| 78 | +lookup.</div> |
| 79 | +</div> |
| 80 | +<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="com.maxmind.db/com/maxmind/db/DeserializationException.html" title="class in com.maxmind.db">DeserializationException</a></div> |
| 81 | +<div class="col-last odd-row-color all-classes-table all-classes-table-tab5"> |
| 82 | +<div class="block">Signals that the value could not be deserialized into the type.</div> |
| 83 | +</div> |
| 84 | +<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="com.maxmind.db/com/maxmind/db/InvalidDatabaseException.html" title="class in com.maxmind.db">InvalidDatabaseException</a></div> |
| 85 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab5"> |
| 86 | +<div class="block">Signals that there was an issue reading from the MaxMind DB file due to |
| 87 | +unexpected data formatting.</div> |
| 88 | +</div> |
| 89 | +<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="com.maxmind.db/com/maxmind/db/InvalidNetworkException.html" title="class in com.maxmind.db">InvalidNetworkException</a></div> |
| 90 | +<div class="col-last odd-row-color all-classes-table all-classes-table-tab5"> |
| 91 | +<div class="block">This is a custom exception that is thrown when the user attempts to use an |
| 92 | +IPv6 address in an IPv4-only database.</div> |
| 93 | +</div> |
| 94 | +<div class="col-first even-row-color all-classes-table all-classes-table-tab6"><a href="com.maxmind.db/com/maxmind/db/MaxMindDbConstructor.html" title="annotation interface in com.maxmind.db">MaxMindDbConstructor</a></div> |
| 95 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab6"> |
| 96 | +<div class="block"><code>MaxMindDbConstructor</code> is an annotation that can be used to mark a constructor |
| 97 | +that should be used to create an instance of a class when decoding a MaxMind |
| 98 | +DB file.</div> |
| 99 | +</div> |
| 100 | +<div class="col-first odd-row-color all-classes-table all-classes-table-tab6"><a href="com.maxmind.db/com/maxmind/db/MaxMindDbCreator.html" title="annotation interface in com.maxmind.db">MaxMindDbCreator</a></div> |
| 101 | +<div class="col-last odd-row-color all-classes-table all-classes-table-tab6"> |
| 102 | +<div class="block"><code>MaxMindDbCreator</code> is an annotation that can be used to mark a static factory |
| 103 | +method or constructor that should be used to create an instance of a class from a |
| 104 | +decoded value when decoding a MaxMind DB file.</div> |
| 105 | +</div> |
| 106 | +<div class="col-first even-row-color all-classes-table all-classes-table-tab6"><a href="com.maxmind.db/com/maxmind/db/MaxMindDbIpAddress.html" title="annotation interface in com.maxmind.db">MaxMindDbIpAddress</a></div> |
| 107 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab6"> |
| 108 | +<div class="block">Marks a constructor parameter that should receive the IP address used |
| 109 | +for the lookup.</div> |
| 110 | +</div> |
| 111 | +<div class="col-first odd-row-color all-classes-table all-classes-table-tab6"><a href="com.maxmind.db/com/maxmind/db/MaxMindDbNetwork.html" title="annotation interface in com.maxmind.db">MaxMindDbNetwork</a></div> |
| 112 | +<div class="col-last odd-row-color all-classes-table all-classes-table-tab6"> |
| 113 | +<div class="block">Marks a constructor parameter that should receive the network associated |
| 114 | +with the record returned by the lookup.</div> |
| 115 | +</div> |
| 116 | +<div class="col-first even-row-color all-classes-table all-classes-table-tab6"><a href="com.maxmind.db/com/maxmind/db/MaxMindDbParameter.html" title="annotation interface in com.maxmind.db">MaxMindDbParameter</a></div> |
| 117 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab6"> |
| 118 | +<div class="block">Interface for a MaxMind DB parameter.</div> |
| 119 | +</div> |
| 120 | +<div class="col-first odd-row-color all-classes-table all-classes-table-tab4"><a href="com.maxmind.db/com/maxmind/db/Metadata.html" title="class in com.maxmind.db">Metadata</a></div> |
| 121 | +<div class="col-last odd-row-color all-classes-table all-classes-table-tab4"> |
| 122 | +<div class="block"><code>Metadata</code> holds data associated with the database itself.</div> |
| 123 | +</div> |
| 124 | +<div class="col-first even-row-color all-classes-table all-classes-table-tab4"><a href="com.maxmind.db/com/maxmind/db/Network.html" title="class in com.maxmind.db">Network</a></div> |
| 125 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab4"> |
| 126 | +<div class="block"><code>Network</code> represents an IP network.</div> |
| 127 | +</div> |
| 128 | +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com.maxmind.db/com/maxmind/db/Networks.html" title="class in com.maxmind.db">Networks<T></a></div> |
| 129 | +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> |
| 130 | +<div class="block">Instances of this class provide an iterator over the networks in a database.</div> |
| 131 | +</div> |
| 132 | +<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="com.maxmind.db/com/maxmind/db/NetworksIterationException.html" title="class in com.maxmind.db">NetworksIterationException</a></div> |
| 133 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab5"> |
| 134 | +<div class="block"> |
| 135 | +This class represents an error encountered while iterating over the networks.</div> |
| 136 | +</div> |
| 137 | +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com.maxmind.db/com/maxmind/db/NoCache.html" title="class in com.maxmind.db">NoCache</a></div> |
| 138 | +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> |
| 139 | +<div class="block">A no-op cache singleton.</div> |
| 140 | +</div> |
| 141 | +<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="com.maxmind.db/com/maxmind/db/NodeCache.html" title="interface in com.maxmind.db">NodeCache</a></div> |
| 142 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab1"> |
| 143 | +<div class="block">NodeCache is an interface for a cache that stores decoded values from the |
| 144 | +data section of the database.</div> |
| 145 | +</div> |
| 146 | +<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com.maxmind.db/com/maxmind/db/NodeCache.Loader.html" title="interface in com.maxmind.db">NodeCache.Loader</a></div> |
| 147 | +<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> |
| 148 | +<div class="block">A loader is used to load a value for a key that is not in the cache.</div> |
| 149 | +</div> |
| 150 | +<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="com.maxmind.db/com/maxmind/db/ParameterNotFoundException.html" title="class in com.maxmind.db">ParameterNotFoundException</a></div> |
| 151 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab5"> |
| 152 | +<div class="block">Signals that no annotated parameter was found.</div> |
| 153 | +</div> |
| 154 | +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com.maxmind.db/com/maxmind/db/Reader.html" title="class in com.maxmind.db">Reader</a></div> |
| 155 | +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> |
| 156 | +<div class="block">Instances of this class provide a reader for the MaxMind DB format.</div> |
| 157 | +</div> |
| 158 | +<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="com.maxmind.db/com/maxmind/db/Reader.FileMode.html" title="enum class in com.maxmind.db">Reader.FileMode</a></div> |
| 159 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab3"> |
| 160 | +<div class="block">The file mode to use when opening a MaxMind DB.</div> |
| 161 | +</div> |
| 162 | +</div> |
| 163 | +</div> |
| 164 | +</div> |
| 165 | +<footer role="contentinfo"> |
| 166 | +<hr> |
| 167 | +<p class="legal-copy"><small>Copyright © 2025 <a href="http://www.maxmind.com/">MaxMind, Inc.</a>. All rights reserved.</small></p> |
| 168 | +</footer> |
| 169 | +</main> |
| 170 | +</div> |
| 171 | +</body> |
| 172 | +</html> |
0 commit comments