erik/owm-japis
erik/owm-japis
1
0
Fork 0
mirror of https://bitbucket.org/akapribot/owm-japis.git synced 2025-04-25 07:17:11 -07:00
Code Activity

2.5.0.2 is ready! There is always room for corrections. :-)

Browse source
This commit is contained in:
Ashutosh Kumar Singh 2014-07-03 01:08:06 +05:30
parent 135ff2bf74
commit c295549579
106 changed files with 2060 additions and 7535 deletions
Download patch file Download diff file Expand all files Collapse all files

367
javadoc/net/aksingh/java/api/owm/CurrentWeatherData.html
View file

@ -2,16 +2,16 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_17) on Sat Aug 10 23:46:35 IST 2013 -->
<!-- Generated by javadoc (version 1.7.0_51) on Thu Jul 03 01:05:54 IST 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>CurrentWeatherData (OpenWeatherMap.org JAPIs)</title>
<meta name="date" content="2013-08-10">
<title>CurrentWeatherData (OWM JAPIs Docs)</title>
<meta name="date" content="2014-07-03">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CurrentWeatherData (OpenWeatherMap.org JAPIs)";
parent.document.title="CurrentWeatherData (OWM JAPIs Docs)";
}
//-->
</script>
@ -62,13 +62,13 @@
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#fields_inherited_from_class_net.aksingh.java.api.owm.AbstractWeatherData">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
@ -103,22 +103,23 @@
<br>
<pre>public class <span class="strong">CurrentWeatherData</span>
extends <a href="../../../../../net/aksingh/java/api/owm/AbstractWeatherData.html" title="class in net.aksingh.java.api.owm">AbstractWeatherData</a></pre>
<div class="block">Parses current weather data (from the JSON data) and provides methods
to get/access the information about current weather.
This class provides <code>has</code> and <code>get</code> methods
to access the information.
<p><code>has</code> methods can be used to check
if the data exists, i.e., if the data was available (successfully
downloaded) and was parsed correctly.
<p><code>get</code> methods can be used to access the data, if the data
exists, otherwise <code>get</code> methods will give value as per
following basis:<br>
<div class="block">Parses current weather data (from the JSON data) and provides methods to
get/access the information about current weather. This class provides
<code>has</code> and <code>get</code> methods to access the information.
<p>
<p>
<code>has</code> methods can be used to check if the data exists, i.e., if
the data was available (successfully downloaded) and was parsed correctly.
<p>
<p>
<code>get</code> methods can be used to access the data, if the data exists,
otherwise <code>get</code> methods will give value as per following
basis:<br>
Boolean: <code>false</code><br>
Integral: Minimum value (MIN_VALUE)<br>
Floating point: Not a number (NaN)<br>
Others: <code>null</code><br></div>
Others: <code>null</code><br>
<p></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>2.5.0.1</dd>
<dt><span class="strong">Version:</span></dt>
@ -146,36 +147,36 @@ extends <a href="../../../../../net/aksingh/java/api/owm/AbstractWeatherData.htm
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.Clouds.html" title="class in net.aksingh.java.api.owm">CurrentWeatherData.Clouds</a></strong></code>
<div class="block">Parses data about clouds (from the JSON data) and provides methods
to get/access the information.</div>
<div class="block">Parses data about clouds (from the JSON data) and provides methods to
get/access the information.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.Coord.html" title="class in net.aksingh.java.api.owm">CurrentWeatherData.Coord</a></strong></code>
<div class="block">Parses data about geographic coordinates (from the JSON data)
and provides methods to get/access the information.</div>
<div class="block">Parses data about geographic coordinates (from the JSON data) and
provides methods to get/access the information.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.Main.html" title="class in net.aksingh.java.api.owm">CurrentWeatherData.Main</a></strong></code>
<div class="block">Parses data about main weather elements (from the JSON data) and
provides methods to get/access the information.</div>
<div class="block">Parses data about main weather elements (from the JSON data) and provides
methods to get/access the information.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.Rain.html" title="class in net.aksingh.java.api.owm">CurrentWeatherData.Rain</a></strong></code>
<div class="block">Parses data about rain (from the JSON data) and provides methods
to get/access the information.</div>
<div class="block">Parses data about rain (from the JSON data) and provides methods to
get/access the information.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.Sys.html" title="class in net.aksingh.java.api.owm">CurrentWeatherData.Sys</a></strong></code>
<div class="block">Parses data about country, sunrise, and sunset (from the JSON data)
and provides methods to get/access the information.</div>
<div class="block">Parses data about country, sunrise, and sunset (from the JSON data) and
provides methods to get/access the information.</div>
</td>
</tr>
<tr class="rowColor">
@ -187,8 +188,8 @@ extends <a href="../../../../../net/aksingh/java/api/owm/AbstractWeatherData.htm
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.Wind.html" title="class in net.aksingh.java.api.owm">CurrentWeatherData.Wind</a></strong></code>
<div class="block">Parses data about winds (from the JSON data) and provides methods
to get/access the information.</div>
<div class="block">Parses data about winds (from the JSON data) and provides methods to
get/access the information.</div>
</td>
</tr>
</table>
@ -200,109 +201,6 @@ extends <a href="../../../../../net/aksingh/java/api/owm/AbstractWeatherData.htm
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.html#base">base</a></strong></code>
<div class="block">Base</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private long</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.html#cityID">cityID</a></strong></code>
<div class="block">City code (ID)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.html#cityName">cityName</a></strong></code>
<div class="block">City name</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.Clouds.html" title="class in net.aksingh.java.api.owm">CurrentWeatherData.Clouds</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.html#clouds">clouds</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.Coord.html" title="class in net.aksingh.java.api.owm">CurrentWeatherData.Coord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.html#coord">coord</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.html#JSON_BASE">JSON_BASE</a></strong></code>
<div class="block">Key for JSON variable <code>Base</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.html#JSON_CITY_ID">JSON_CITY_ID</a></strong></code>
<div class="block">Key for JSON variable <code>City code (ID)</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.html#JSON_CITY_NAME">JSON_CITY_NAME</a></strong></code>
<div class="block">Key for JSON variable <code>City name</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.html#JSON_RAIN">JSON_RAIN</a></strong></code>
<div class="block">Key for JSON object - Rain</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.html#JSON_RESPONSE_CODE">JSON_RESPONSE_CODE</a></strong></code>
<div class="block">Key for JSON variable <code>Response code</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.html#JSON_SYS">JSON_SYS</a></strong></code>
<div class="block">Key for JSON object - Sys</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.Main.html" title="class in net.aksingh.java.api.owm">CurrentWeatherData.Main</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.html#main">main</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.Rain.html" title="class in net.aksingh.java.api.owm">CurrentWeatherData.Rain</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.html#rain">rain</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private int</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.html#responseCode">responseCode</a></strong></code>
<div class="block">Response code</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.Sys.html" title="class in net.aksingh.java.api.owm">CurrentWeatherData.Sys</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.html#sys">sys</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private java.util.List&lt;<a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.Weather.html" title="class in net.aksingh.java.api.owm">CurrentWeatherData.Weather</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.html#weatherList">weatherList</a></strong></code>
<div class="block">List of weather information (code, name, etc.)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private int</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.html#weatherListCount">weatherListCount</a></strong></code>
<div class="block">Count (number) of elements in list of weather information</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.Wind.html" title="class in net.aksingh.java.api.owm">CurrentWeatherData.Wind</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.html#wind">wind</a></strong></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_net.aksingh.java.api.owm.AbstractWeatherData">
<!-- -->
@ -325,9 +223,7 @@ extends <a href="../../../../../net/aksingh/java/api/owm/AbstractWeatherData.htm
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.html#CurrentWeatherData(org.json.JSONObject)">CurrentWeatherData</a></strong>(org.json.JSONObject&nbsp;jsonObj)</code>
<div class="block">Parameterized constructor
Initializes variables from values from the given JSON object.</div>
<div class="block">Parameterized constructor</div>
</td>
</tr>
</table>
@ -436,194 +332,6 @@ extends <a href="../../../../../net/aksingh/java/api/owm/AbstractWeatherData.htm
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="JSON_RAIN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JSON_RAIN</h4>
<pre>private final&nbsp;java.lang.String JSON_RAIN</pre>
<div class="block">Key for JSON object - Rain</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#net.aksingh.java.api.owm.CurrentWeatherData.JSON_RAIN">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="JSON_SYS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JSON_SYS</h4>
<pre>private final&nbsp;java.lang.String JSON_SYS</pre>
<div class="block">Key for JSON object - Sys</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#net.aksingh.java.api.owm.CurrentWeatherData.JSON_SYS">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="JSON_BASE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JSON_BASE</h4>
<pre>private final&nbsp;java.lang.String JSON_BASE</pre>
<div class="block">Key for JSON variable <code>Base</code></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#net.aksingh.java.api.owm.CurrentWeatherData.JSON_BASE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="JSON_CITY_ID">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JSON_CITY_ID</h4>
<pre>private final&nbsp;java.lang.String JSON_CITY_ID</pre>
<div class="block">Key for JSON variable <code>City code (ID)</code></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#net.aksingh.java.api.owm.CurrentWeatherData.JSON_CITY_ID">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="JSON_CITY_NAME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JSON_CITY_NAME</h4>
<pre>private final&nbsp;java.lang.String JSON_CITY_NAME</pre>
<div class="block">Key for JSON variable <code>City name</code></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#net.aksingh.java.api.owm.CurrentWeatherData.JSON_CITY_NAME">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="JSON_RESPONSE_CODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JSON_RESPONSE_CODE</h4>
<pre>private final&nbsp;java.lang.String JSON_RESPONSE_CODE</pre>
<div class="block">Key for JSON variable <code>Response code</code></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#net.aksingh.java.api.owm.CurrentWeatherData.JSON_RESPONSE_CODE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="base">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>base</h4>
<pre>private final&nbsp;java.lang.String base</pre>
<div class="block">Base</div>
</li>
</ul>
<a name="cityID">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cityID</h4>
<pre>private final&nbsp;long cityID</pre>
<div class="block">City code (ID)</div>
</li>
</ul>
<a name="cityName">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cityName</h4>
<pre>private final&nbsp;java.lang.String cityName</pre>
<div class="block">City name</div>
</li>
</ul>
<a name="responseCode">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>responseCode</h4>
<pre>private final&nbsp;int responseCode</pre>
<div class="block">Response code</div>
</li>
</ul>
<a name="clouds">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clouds</h4>
<pre>private final&nbsp;<a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.Clouds.html" title="class in net.aksingh.java.api.owm">CurrentWeatherData.Clouds</a> clouds</pre>
</li>
</ul>
<a name="coord">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>coord</h4>
<pre>private final&nbsp;<a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.Coord.html" title="class in net.aksingh.java.api.owm">CurrentWeatherData.Coord</a> coord</pre>
</li>
</ul>
<a name="main">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>main</h4>
<pre>private final&nbsp;<a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.Main.html" title="class in net.aksingh.java.api.owm">CurrentWeatherData.Main</a> main</pre>
</li>
</ul>
<a name="rain">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rain</h4>
<pre>private final&nbsp;<a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.Rain.html" title="class in net.aksingh.java.api.owm">CurrentWeatherData.Rain</a> rain</pre>
</li>
</ul>
<a name="sys">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sys</h4>
<pre>private final&nbsp;<a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.Sys.html" title="class in net.aksingh.java.api.owm">CurrentWeatherData.Sys</a> sys</pre>
</li>
</ul>
<a name="wind">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wind</h4>
<pre>private final&nbsp;<a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.Wind.html" title="class in net.aksingh.java.api.owm">CurrentWeatherData.Wind</a> wind</pre>
</li>
</ul>
<a name="weatherList">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>weatherList</h4>
<pre>private final&nbsp;java.util.List&lt;<a href="../../../../../net/aksingh/java/api/owm/CurrentWeatherData.Weather.html" title="class in net.aksingh.java.api.owm">CurrentWeatherData.Weather</a>&gt; weatherList</pre>
<div class="block">List of weather information (code, name, etc.)</div>
</li>
</ul>
<a name="weatherListCount">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>weatherListCount</h4>
<pre>private final&nbsp;int weatherListCount</pre>
<div class="block">Count (number) of elements in list of weather information</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
@ -638,8 +346,9 @@ extends <a href="../../../../../net/aksingh/java/api/owm/AbstractWeatherData.htm
<h4>CurrentWeatherData</h4>
<pre>public&nbsp;CurrentWeatherData(org.json.JSONObject&nbsp;jsonObj)</pre>
<div class="block">Parameterized constructor
Initializes variables from values from the given JSON object.</div>
<p>
Initializes variables from values from the given JSON object.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>jsonObj</code> - JSON object containing current weather data</dd></dl>
</li>
</ul>
@ -855,13 +564,13 @@ extends <a href="../../../../../net/aksingh/java/api/owm/AbstractWeatherData.htm
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#fields_inherited_from_class_net.aksingh.java.api.owm.AbstractWeatherData">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>