net.aksingh.java.api.owm

Class AbstractWeatherData.Clouds

java.lang.Object

net.aksingh.java.api.owm.AbstractWeatherData.Clouds

Direct Known Subclasses:

CurrentWeatherData.Clouds, ForecastWeatherData.Forecast.Clouds

Enclosing class:

AbstractWeatherData

public abstract static class AbstractWeatherData.Clouds
extends java.lang.Object

This class provides default implementations for Clouds. Standard behaviors like the has and the get methods for information about clouds (for example, percentage of clouds, etc.) are defined here.

Since:

2.5.0.1

Version:

2013/07/27

Author:

Ashutosh Kumar Singh

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	JSON_CLOUDS_ALL Key for JSON variable Clouds -> All (percentage of all clouds)
private float	percentOfClouds Percentage of all clouds

Constructor Summary

Constructors

Constructor and Description
AbstractWeatherData.Clouds() Non-parameterized constructor
AbstractWeatherData.Clouds(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	getPercentageOfClouds() Returns data for percentage of all clouds.
boolean	hasPercentageOfClouds() Tells if the data for percentage of all clouds is available or not.

Methods inherited from class java.lang.Object

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

Field Detail

JSON_CLOUDS_ALL

private final java.lang.String JSON_CLOUDS_ALL

Key for JSON variable Clouds -> All (percentage of all clouds)

See Also:

Constant Field Values

percentOfClouds

private final float percentOfClouds

Percentage of all clouds

Constructor Detail

AbstractWeatherData.Clouds

public AbstractWeatherData.Clouds()

Non-parameterized constructor

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

AbstractWeatherData.Clouds

public AbstractWeatherData.Clouds(org.json.JSONObject jsonObj)

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

Parameters:

jsonObj - JSON object containing data about clouds

Method Detail

hasPercentageOfClouds

public boolean hasPercentageOfClouds()

Tells if the data for percentage of all clouds is available or not.

Returns:

true if data available, otherwise false

getPercentageOfClouds

public float getPercentageOfClouds()

Returns data for percentage of all clouds.

Returns:

Percentage of all clouds if available, otherwise Float.NaN, i.e., Not a Number.