net.aksingh.java.api.owm

Class CurrentWeatherData.Rain

java.lang.Object

net.aksingh.java.api.owm.CurrentWeatherData.Rain

Enclosing class:

CurrentWeatherData

public static class CurrentWeatherData.Rain
extends java.lang.Object

Parses data about rain (from the JSON data) and provides methods to get/access the information. This class provides has and get methods to access the information.

has methods can be used to check if the data exists, i.e., if the data was available (successfully downloaded) and was parsed correctly.

get methods can be used to access the data, if the data exists, otherwise get methods will give value as per following basis:
Boolean: false
Integral: Minimum value (MIN_VALUE)
Floating point: Not a number (NaN)
Others: null

Since:

2.5.0.1

Version:

2013/08/07

Author:

Ashutosh Kumar Singh

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	JSON_RAIN_3HOURS Key for JSON variable Rain -> Rain per 3 hours
private float	rain3h Rain per 3 hours

Constructor Summary

Constructors

Constructor and Description
CurrentWeatherData.Rain() Non-parameterized constructor
CurrentWeatherData.Rain(org.json.JSONObject jsonObj) Parameterized constructor Initializes variables from values from the given JSON object.

Method Summary

Methods

Modifier and Type	Method and Description
float	getRain3Hours()
boolean	hasRain3Hours()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JSON_RAIN_3HOURS

private final java.lang.String JSON_RAIN_3HOURS

Key for JSON variable Rain -> Rain per 3 hours

See Also:

Constant Field Values

rain3h

private final float rain3h

Rain per 3 hours

Constructor Detail

CurrentWeatherData.Rain

public CurrentWeatherData.Rain()

Non-parameterized constructor

Initializes variables as per following basis:
Boolean: false
Integral: Minimum value (MIN_VALUE)
Floating point: Not a number (NaN)
Others: null

CurrentWeatherData.Rain

public CurrentWeatherData.Rain(org.json.JSONObject jsonObj)

Parameterized constructor Initializes variables from values from the given JSON object.

Parameters:

jsonObj - JSON object containing data about rain

Method Detail

hasRain3Hours

public boolean hasRain3Hours()

getRain3Hours

public float getRain3Hours()