|
| 1 | +<!DOCTYPE HTML> |
| 2 | +<html lang> |
| 3 | +<head> |
| 4 | +<!-- Generated by javadoc (17) on Wed May 28 13:19:39 PDT 2025 --> |
| 5 | +<title>All Classes and Interfaces (MaxMind DB Reader 3.2.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-05-28"> |
| 9 | +<meta name="description" content="class index"> |
| 10 | +<meta name="generator" content="javadoc/AllClassesIndexWriter"> |
| 11 | +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> |
| 12 | +<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style"> |
| 13 | +<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style"> |
| 14 | +<script type="text/javascript" src="script.js"></script> |
| 15 | +<script type="text/javascript" src="script-dir/jquery-3.6.0.min.js"></script> |
| 16 | +<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> |
| 17 | +</head> |
| 18 | +<body class="all-classes-index-page"> |
| 19 | +<script type="text/javascript">var evenRowColor = "even-row-color"; |
| 20 | +var oddRowColor = "odd-row-color"; |
| 21 | +var tableTab = "table-tab"; |
| 22 | +var activeTableTab = "active-table-tab"; |
| 23 | +var pathtoroot = "./"; |
| 24 | +loadScripts(document, 'script');</script> |
| 25 | +<noscript> |
| 26 | +<div>JavaScript is disabled on your browser.</div> |
| 27 | +</noscript> |
| 28 | +<div class="flex-box"> |
| 29 | +<header role="banner" class="flex-header"> |
| 30 | +<nav role="navigation"> |
| 31 | +<!-- ========= START OF TOP NAVBAR ======= --> |
| 32 | +<div class="top-nav" id="navbar-top"> |
| 33 | +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| 34 | +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| 35 | +<li><a href="com.maxmind.db/module-summary.html">Module</a></li> |
| 36 | +<li><a href="com.maxmind.db/com/maxmind/db/package-summary.html">Package</a></li> |
| 37 | +<li>Class</li> |
| 38 | +<li>Use</li> |
| 39 | +<li><a href="com.maxmind.db/com/maxmind/db/package-tree.html">Tree</a></li> |
| 40 | +<li><a href="index-all.html">Index</a></li> |
| 41 | +<li><a href="help-doc.html#all-classes">Help</a></li> |
| 42 | +</ul> |
| 43 | +</div> |
| 44 | +<div class="sub-nav"> |
| 45 | +<div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| 46 | +<input type="text" id="search-input" value="search" disabled="disabled"> |
| 47 | +<input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| 48 | +</div> |
| 49 | +</div> |
| 50 | +<!-- ========= END OF TOP NAVBAR ========= --> |
| 51 | +<span class="skip-nav" id="skip-navbar-top"></span></nav> |
| 52 | +</header> |
| 53 | +<div class="flex-content"> |
| 54 | +<main role="main"> |
| 55 | +<div class="header"> |
| 56 | +<h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1> |
| 57 | +</div> |
| 58 | +<div id="all-classes-table"> |
| 59 | +<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-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">Exceptions</button><button id="all-classes-table-tab7" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab7', 2)" class="table-tab">Annotation Interfaces</button></div> |
| 60 | +<div id="all-classes-table.tabpanel" role="tabpanel"> |
| 61 | +<div class="summary-table two-column-summary" aria-labelledby="all-classes-table-tab0"> |
| 62 | +<div class="table-header col-first">Class</div> |
| 63 | +<div class="table-header col-last">Description</div> |
| 64 | +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com.maxmind.db/com/maxmind/db/CacheKey.html" title="class in com.maxmind.db">CacheKey</a><<a href="com.maxmind.db/com/maxmind/db/CacheKey.html" title="type parameter in CacheKey">T</a>></div> |
| 65 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> |
| 66 | +<div class="block"><code>CacheKey</code> is used as a key in the data-section cache.</div> |
| 67 | +</div> |
| 68 | +<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> |
| 69 | +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> |
| 70 | +<div class="block">A simplistic cache using a <a href="https://docs.oracle.com/en/java/javase/11/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> |
| 71 | +</div> |
| 72 | +<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> |
| 73 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab5"> |
| 74 | +<div class="block">Signals that the underlying database has been closed.</div> |
| 75 | +</div> |
| 76 | +<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> |
| 77 | +<div class="col-last odd-row-color all-classes-table all-classes-table-tab5"> |
| 78 | +<div class="block">Signals that no annotated constructor was found.</div> |
| 79 | +</div> |
| 80 | +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com.maxmind.db/com/maxmind/db/DatabaseRecord.html" title="class in com.maxmind.db">DatabaseRecord</a><<a href="com.maxmind.db/com/maxmind/db/DatabaseRecord.html" title="type parameter in DatabaseRecord">T</a>></div> |
| 81 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> |
| 82 | +<div class="block">DatabaseRecord represents the data and metadata associated with a database |
| 83 | + lookup.</div> |
| 84 | +</div> |
| 85 | +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com.maxmind.db/com/maxmind/db/DecodedValue.html" title="class in com.maxmind.db">DecodedValue</a></div> |
| 86 | +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> |
| 87 | +<div class="block"><code>DecodedValue</code> is a wrapper for the decoded value and the number of bytes used |
| 88 | + to decode it.</div> |
| 89 | +</div> |
| 90 | +<div class="col-first even-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> |
| 91 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab5"> |
| 92 | +<div class="block">Signals that the value could not be deserialized into the type.</div> |
| 93 | +</div> |
| 94 | +<div class="col-first odd-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> |
| 95 | +<div class="col-last odd-row-color all-classes-table all-classes-table-tab5"> |
| 96 | +<div class="block">Signals that there was an issue reading from the MaxMind DB file due to |
| 97 | + unexpected data formatting.</div> |
| 98 | +</div> |
| 99 | +<div class="col-first even-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> |
| 100 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab5"> |
| 101 | +<div class="block">This is a custom exception that is thrown when the user attempts to use an |
| 102 | + IPv6 address in an IPv4-only database.</div> |
| 103 | +</div> |
| 104 | +<div class="col-first odd-row-color all-classes-table all-classes-table-tab7"><a href="com.maxmind.db/com/maxmind/db/MaxMindDbConstructor.html" title="annotation interface in com.maxmind.db">MaxMindDbConstructor</a></div> |
| 105 | +<div class="col-last odd-row-color all-classes-table all-classes-table-tab7"> |
| 106 | +<div class="block"><code>MaxMindDbConstructor</code> is an annotation that can be used to mark a constructor |
| 107 | + that should be used to create an instance of a class when decoding a MaxMind |
| 108 | + DB file.</div> |
| 109 | +</div> |
| 110 | +<div class="col-first even-row-color all-classes-table all-classes-table-tab7"><a href="com.maxmind.db/com/maxmind/db/MaxMindDbParameter.html" title="annotation interface in com.maxmind.db">MaxMindDbParameter</a></div> |
| 111 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab7"> |
| 112 | +<div class="block">Interface for a MaxMind DB parameter.</div> |
| 113 | +</div> |
| 114 | +<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com.maxmind.db/com/maxmind/db/Metadata.html" title="class in com.maxmind.db">Metadata</a></div> |
| 115 | +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> |
| 116 | +<div class="block"><code>Metadata</code> holds data associated with the database itself.</div> |
| 117 | +</div> |
| 118 | +<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com.maxmind.db/com/maxmind/db/Network.html" title="class in com.maxmind.db">Network</a></div> |
| 119 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> |
| 120 | +<div class="block"><code>Network</code> represents an IP network.</div> |
| 121 | +</div> |
| 122 | +<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</a><<a href="com.maxmind.db/com/maxmind/db/Networks.html" title="type parameter in Networks">T</a>></div> |
| 123 | +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> |
| 124 | +<div class="block">Instances of this class provide an iterator over the networks in a database.</div> |
| 125 | +</div> |
| 126 | +<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> |
| 127 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab5"> |
| 128 | +<div class="block"> |
| 129 | + This class represents an error encountered while iterating over the networks.</div> |
| 130 | +</div> |
| 131 | +<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> |
| 132 | +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> |
| 133 | +<div class="block">A no-op cache singleton.</div> |
| 134 | +</div> |
| 135 | +<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> |
| 136 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab1"> |
| 137 | +<div class="block">NodeCache is an interface for a cache that stores decoded values from the |
| 138 | + data section of the database.</div> |
| 139 | +</div> |
| 140 | +<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> |
| 141 | +<div class="col-last odd-row-color all-classes-table all-classes-table-tab1"> |
| 142 | +<div class="block">A loader is used to load a value for a key that is not in the cache.</div> |
| 143 | +</div> |
| 144 | +<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> |
| 145 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab5"> |
| 146 | +<div class="block">Signals that no annotated parameter was found.</div> |
| 147 | +</div> |
| 148 | +<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> |
| 149 | +<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> |
| 150 | +<div class="block">Instances of this class provide a reader for the MaxMind DB format.</div> |
| 151 | +</div> |
| 152 | +<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> |
| 153 | +<div class="col-last even-row-color all-classes-table all-classes-table-tab3"> |
| 154 | +<div class="block">The file mode to use when opening a MaxMind DB.</div> |
| 155 | +</div> |
| 156 | +</div> |
| 157 | +</div> |
| 158 | +</div> |
| 159 | +</main> |
| 160 | +<footer role="contentinfo"> |
| 161 | +<hr> |
| 162 | +<p class="legal-copy"><small>Copyright © 2025 <a href="http://www.maxmind.com/">MaxMind, Inc.</a>. All rights reserved.</small></p> |
| 163 | +</footer> |
| 164 | +</div> |
| 165 | +</div> |
| 166 | +</body> |
| 167 | +</html> |
0 commit comments