net.aksingh.java.api.owm

Class AbstractWeatherData.Weather

java.lang.Object

net.aksingh.java.api.owm.AbstractWeatherData.Weather

Direct Known Subclasses:

CurrentWeatherData.Weather, DailyForecastData.Forecast.Weather, ForecastWeatherData.Forecast.Weather

Enclosing class:

AbstractWeatherData

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

This class provides default implementations for Weather. Standard behaviors like the has and the get methods for information about weather (for example, id, name, description, icon, etc.) are defined here.

Since:

2.5.0.1

Version:

2013/07/28

Author:

Ashutosh Kumar Singh

Constructor Summary

Constructors

Constructor and Description
AbstractWeatherData.Weather() Non-parameterized constructor
AbstractWeatherData.Weather(org.json.JSONObject jsonObj) Parameterized constructor

Method Summary

Methods

Modifier and Type	Method and Description
int	getWeatherCode() Returns data for code for weather of the city.
java.lang.String	getWeatherDescription() Returns data for description for weather of the city.
java.lang.String	getWeatherIconName() Returns data for name of icon for weather of the city.
java.lang.String	getWeatherName() Returns data for name for weather of the city.
boolean	hasWeatherCode() Tells if the data for weather's code is available or not.
boolean	hasWeatherDescription() Tells if the data for weather's description is available or not.
boolean	hasWeatherIconName() Tells if the data for name of weather's icon is available or not.
boolean	hasWeatherName() Tells if the data for weather's name is available or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractWeatherData.Weather

public AbstractWeatherData.Weather()

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.Weather

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

Parameterized constructor

Initializes variables from values from the given JSON object.

Parameters:

jsonObj - JSON object containing data about weather id, name, etc.

Method Detail

hasWeatherCode

public boolean hasWeatherCode()

Tells if the data for weather's code is available or not.

Returns:

true if data available, otherwise false

hasWeatherName

public boolean hasWeatherName()

Tells if the data for weather's name is available or not.

Returns:

true if data available, otherwise false

hasWeatherDescription

public boolean hasWeatherDescription()

Tells if the data for weather's description is available or not.

Returns:

true if data available, otherwise false

hasWeatherIconName

public boolean hasWeatherIconName()

Tells if the data for name of weather's icon is available or not.

Returns:

true if data available, otherwise false

getWeatherCode

public int getWeatherCode()

Returns data for code for weather of the city.

Returns:

Code for weather of the city if available, otherwise Integer.MIN_VALUE

getWeatherName

public java.lang.String getWeatherName()

Returns data for name for weather of the city.

Returns:

Name for weather of the city if available, otherwise null

getWeatherDescription

public java.lang.String getWeatherDescription()

Returns data for description for weather of the city.

Returns:

Description for weather of the city if available, otherwise null

getWeatherIconName

public java.lang.String getWeatherIconName()

Returns data for name of icon for weather of the city.

Returns:

Name of icon for weather of the city if available, otherwise null