|
| 1 | +<!DOCTYPE HTML> |
| 2 | +<html lang> |
| 3 | +<head> |
| 4 | +<!-- Generated by javadoc (17) on Wed May 28 14:27:13 PDT 2025 --> |
| 5 | +<title>GeoIp2Provider (MaxMind GeoIP2 API 4.3.1 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="declaration: module: com.maxmind.geoip2, package: com.maxmind.geoip2, interface: GeoIp2Provider"> |
| 10 | +<meta name="generator" content="javadoc/ClassWriterImpl"> |
| 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="class-declaration-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="../../../module-summary.html">Module</a></li> |
| 36 | +<li><a href="package-summary.html">Package</a></li> |
| 37 | +<li class="nav-bar-cell1-rev">Class</li> |
| 38 | +<li><a href="class-use/GeoIp2Provider.html">Use</a></li> |
| 39 | +<li><a href="package-tree.html">Tree</a></li> |
| 40 | +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| 41 | +<li><a href="../../../../index-all.html">Index</a></li> |
| 42 | +<li><a href="../../../../help-doc.html#class">Help</a></li> |
| 43 | +</ul> |
| 44 | +</div> |
| 45 | +<div class="sub-nav"> |
| 46 | +<div> |
| 47 | +<ul class="sub-nav-list"> |
| 48 | +<li>Summary: </li> |
| 49 | +<li>Nested | </li> |
| 50 | +<li>Field | </li> |
| 51 | +<li>Constr | </li> |
| 52 | +<li><a href="#method-summary">Method</a></li> |
| 53 | +</ul> |
| 54 | +<ul class="sub-nav-list"> |
| 55 | +<li>Detail: </li> |
| 56 | +<li>Field | </li> |
| 57 | +<li>Constr | </li> |
| 58 | +<li><a href="#method-detail">Method</a></li> |
| 59 | +</ul> |
| 60 | +</div> |
| 61 | +<div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| 62 | +<input type="text" id="search-input" value="search" disabled="disabled"> |
| 63 | +<input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| 64 | +</div> |
| 65 | +</div> |
| 66 | +<!-- ========= END OF TOP NAVBAR ========= --> |
| 67 | +<span class="skip-nav" id="skip-navbar-top"></span></nav> |
| 68 | +</header> |
| 69 | +<div class="flex-content"> |
| 70 | +<main role="main"> |
| 71 | +<!-- ======== START OF CLASS DATA ======== --> |
| 72 | +<div class="header"> |
| 73 | +<div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../module-summary.html">com.maxmind.geoip2</a></div> |
| 74 | +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.maxmind.geoip2</a></div> |
| 75 | +<h1 title="Interface GeoIp2Provider" class="title">Interface GeoIp2Provider</h1> |
| 76 | +</div> |
| 77 | +<section class="class-description" id="class-description"> |
| 78 | +<dl class="notes"> |
| 79 | +<dt>All Known Subinterfaces:</dt> |
| 80 | +<dd><code><a href="DatabaseProvider.html" title="interface in com.maxmind.geoip2">DatabaseProvider</a></code>, <code><a href="WebServiceProvider.html" title="interface in com.maxmind.geoip2">WebServiceProvider</a></code></dd> |
| 81 | +</dl> |
| 82 | +<dl class="notes"> |
| 83 | +<dt>All Known Implementing Classes:</dt> |
| 84 | +<dd><code><a href="DatabaseReader.html" title="class in com.maxmind.geoip2">DatabaseReader</a></code>, <code><a href="WebServiceClient.html" title="class in com.maxmind.geoip2">WebServiceClient</a></code></dd> |
| 85 | +</dl> |
| 86 | +<hr> |
| 87 | +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">GeoIp2Provider</span></div> |
| 88 | +<div class="block">Interface for GeoIP2 providers.</div> |
| 89 | +</section> |
| 90 | +<section class="summary"> |
| 91 | +<ul class="summary-list"> |
| 92 | +<!-- ========== METHOD SUMMARY =========== --> |
| 93 | +<li> |
| 94 | +<section class="method-summary" id="method-summary"> |
| 95 | +<h2>Method Summary</h2> |
| 96 | +<div id="method-summary-table"> |
| 97 | +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| 98 | +<div id="method-summary-table.tabpanel" role="tabpanel"> |
| 99 | +<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| 100 | +<div class="table-header col-first">Modifier and Type</div> |
| 101 | +<div class="table-header col-second">Method</div> |
| 102 | +<div class="table-header col-last">Description</div> |
| 103 | +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="model/CityResponse.html" title="class in com.maxmind.geoip2.model">CityResponse</a></code></div> |
| 104 | +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#city(java.net.InetAddress)" class="member-name-link">city</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/InetAddress.html" title="class or interface in java.net" class="external-link">InetAddress</a> ipAddress)</code></div> |
| 105 | +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| 106 | +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="model/CountryResponse.html" title="class in com.maxmind.geoip2.model">CountryResponse</a></code></div> |
| 107 | +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#country(java.net.InetAddress)" class="member-name-link">country</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/InetAddress.html" title="class or interface in java.net" class="external-link">InetAddress</a> ipAddress)</code></div> |
| 108 | +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| 109 | +</div> |
| 110 | +</div> |
| 111 | +</div> |
| 112 | +</section> |
| 113 | +</li> |
| 114 | +</ul> |
| 115 | +</section> |
| 116 | +<section class="details"> |
| 117 | +<ul class="details-list"> |
| 118 | +<!-- ============ METHOD DETAIL ========== --> |
| 119 | +<li> |
| 120 | +<section class="method-details" id="method-detail"> |
| 121 | +<h2>Method Details</h2> |
| 122 | +<ul class="member-list"> |
| 123 | +<li> |
| 124 | +<section class="detail" id="country(java.net.InetAddress)"> |
| 125 | +<h3>country</h3> |
| 126 | +<div class="member-signature"><span class="return-type"><a href="model/CountryResponse.html" title="class in com.maxmind.geoip2.model">CountryResponse</a></span> <span class="element-name">country</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/InetAddress.html" title="class or interface in java.net" class="external-link">InetAddress</a> ipAddress)</span> |
| 127 | + throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a>, |
| 128 | +<a href="exception/GeoIp2Exception.html" title="class in com.maxmind.geoip2.exception">GeoIp2Exception</a></span></div> |
| 129 | +<dl class="notes"> |
| 130 | +<dt>Parameters:</dt> |
| 131 | +<dd><code>ipAddress</code> - IPv4 or IPv6 address to lookup.</dd> |
| 132 | +<dt>Returns:</dt> |
| 133 | +<dd>A Country model for the requested IP address.</dd> |
| 134 | +<dt>Throws:</dt> |
| 135 | +<dd><code><a href="exception/GeoIp2Exception.html" title="class in com.maxmind.geoip2.exception">GeoIp2Exception</a></code> - if there is an error looking up the IP</dd> |
| 136 | +<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if there is an IO error</dd> |
| 137 | +</dl> |
| 138 | +</section> |
| 139 | +</li> |
| 140 | +<li> |
| 141 | +<section class="detail" id="city(java.net.InetAddress)"> |
| 142 | +<h3>city</h3> |
| 143 | +<div class="member-signature"><span class="return-type"><a href="model/CityResponse.html" title="class in com.maxmind.geoip2.model">CityResponse</a></span> <span class="element-name">city</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/InetAddress.html" title="class or interface in java.net" class="external-link">InetAddress</a> ipAddress)</span> |
| 144 | + throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a>, |
| 145 | +<a href="exception/GeoIp2Exception.html" title="class in com.maxmind.geoip2.exception">GeoIp2Exception</a></span></div> |
| 146 | +<dl class="notes"> |
| 147 | +<dt>Parameters:</dt> |
| 148 | +<dd><code>ipAddress</code> - IPv4 or IPv6 address to lookup.</dd> |
| 149 | +<dt>Returns:</dt> |
| 150 | +<dd>A City model for the requested IP address.</dd> |
| 151 | +<dt>Throws:</dt> |
| 152 | +<dd><code><a href="exception/GeoIp2Exception.html" title="class in com.maxmind.geoip2.exception">GeoIp2Exception</a></code> - if there is an error looking up the IP</dd> |
| 153 | +<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if there is an IO error</dd> |
| 154 | +</dl> |
| 155 | +</section> |
| 156 | +</li> |
| 157 | +</ul> |
| 158 | +</section> |
| 159 | +</li> |
| 160 | +</ul> |
| 161 | +</section> |
| 162 | +<!-- ========= END OF CLASS DATA ========= --> |
| 163 | +</main> |
| 164 | +<footer role="contentinfo"> |
| 165 | +<hr> |
| 166 | +<p class="legal-copy"><small>Copyright © 2025 <a href="https://www.maxmind.com/">MaxMind, Inc.</a>. All rights reserved.</small></p> |
| 167 | +</footer> |
| 168 | +</div> |
| 169 | +</div> |
| 170 | +</body> |
| 171 | +</html> |
0 commit comments