net.aksingh.owmjapis.core

Class OWM

net.aksingh.owmjapis.core.OWM

Direct Known Subclasses:

OWMPro

public class OWM

Starting point for this lib. If you're new to this API, start from this class.

Lets you access data from OpenWeatherMap.org using its Weather APIs (Free).

Sample code in Java: OWM owm = new OWM("your-free-api-key");

Sample code in Kotlin: val owm: OWM = OWM("your-free-api-key")

OpenWeatherMap.org OpenWeatherMap.org APIs

See Also:

OpenWeatherMap.org, OpenWeatherMap.org APIs

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OWM.Companion

Field Summary

Fields

Modifier and Type	Field and Description
static OWM.Companion	Companion

Constructor Summary

Constructors

Constructor and Description
OWM(java.lang.String apiKey) Constructor
OWM(java.lang.String apiKey, java.lang.String baseUrl)

Method Summary

Modifier and Type	Method and Description
AirPollution	airPollutionByCoords(double latitude, double longitude, java.lang.String dateTime)
AirPollution	airPollutionByCoords(double latitude, double longitude, java.util.Date dateTime)
retrofit2.Retrofit	createRetrofit4OthersInstance(java.net.Proxy proxy) Init Retrofit for getting other data from OpenWeatherMap.org
retrofit2.Retrofit	createRetrofit4PollutionInstance(java.net.Proxy proxy) Init Retrofit for getting pollution data from OpenWeatherMap.org
retrofit2.Retrofit	createRetrofit4WeatherInstance(java.net.Proxy proxy) Init Retrofit for getting weather data from OpenWeatherMap.org
AirPollution	currentAirPollutionByCoords(double latitude, double longitude)
CurrentUVIndex	currentUVIndexByCoords(double latitude, double longitude)
CurrentWeather	currentWeatherByCityId(int cityId)
CurrentWeather	currentWeatherByCityName(java.lang.String cityName)
CurrentWeather	currentWeatherByCityName(java.lang.String cityName, OWM.Country countryCode)
CurrentWeather	currentWeatherByCoords(double latitude, double longitude)
CurrentWeather	currentWeatherByZipCode(int zipCode)
CurrentWeather	currentWeatherByZipCode(int zipCode, OWM.Country countryCode)
java.util.List<net.aksingh.owmjapis.model.DailyUVIndexForecast>	dailyUVIndexForecastByCoords(double latitude, double longitude)
DailyWeatherForecast	dailyWeatherForecastByCityId(int cityId)
DailyWeatherForecast	dailyWeatherForecastByCityId(int cityId, int count)
DailyWeatherForecast	dailyWeatherForecastByCityName(java.lang.String cityName)
DailyWeatherForecast	dailyWeatherForecastByCityName(java.lang.String cityName, int count)
DailyWeatherForecast	dailyWeatherForecastByCityName(java.lang.String cityName, OWM.Country countryCode)
DailyWeatherForecast	dailyWeatherForecastByCityName(java.lang.String cityName, OWM.Country countryCode, int count)
DailyWeatherForecast	dailyWeatherForecastByCoords(double latitude, double longitude)
DailyWeatherForecast	dailyWeatherForecastByCoords(double latitude, double longitude, int count)
DailyWeatherForecast	dailyWeatherForecastByZipCode(int zipCode)
DailyWeatherForecast	dailyWeatherForecastByZipCode(int zipCode, int count)
DailyWeatherForecast	dailyWeatherForecastByZipCode(int zipCode, OWM.Country countryCode)
DailyWeatherForecast	dailyWeatherForecastByZipCode(int zipCode, OWM.Country countryCode, int count)
OWM.Accuracy	getAccuracy()
java.lang.String	getApiKey()
java.lang.String	getBaseUrl()
OWM.Language	getLanguage()
java.net.Proxy	getProxy()
retrofit2.Retrofit	getRetrofit4others()
retrofit2.Retrofit	getRetrofit4pollution()
retrofit2.Retrofit	getRetrofit4weather()
OWM.Unit	getUnit()
java.util.List<net.aksingh.owmjapis.model.HistoricalUVIndex>	historicalUVIndexByCoords(double latitude, double longitude, int count, long startTime, long endTime)
java.util.List<net.aksingh.owmjapis.model.HistoricalUVIndex>	historicalUVIndexByCoords(double latitude, double longitude, int count, java.util.Date startTime, java.util.Date endTime)
java.util.List<net.aksingh.owmjapis.model.HistoricalUVIndex>	historicalUVIndexByCoords(double latitude, double longitude, long startTime, long endTime)
java.util.List<net.aksingh.owmjapis.model.HistoricalUVIndex>	historicalUVIndexByCoords(double latitude, double longitude, java.util.Date startTime, java.util.Date endTime)
HourlyWeatherForecast	hourlyWeatherForecastByCityId(int cityId)
HourlyWeatherForecast	hourlyWeatherForecastByCityName(java.lang.String cityName)
HourlyWeatherForecast	hourlyWeatherForecastByCityName(java.lang.String cityName, OWM.Country countryCode)
HourlyWeatherForecast	hourlyWeatherForecastByCoords(double latitude, double longitude)
HourlyWeatherForecast	hourlyWeatherForecastByZipCode(int zipCode)
HourlyWeatherForecast	hourlyWeatherForecastByZipCode(int zipCode, OWM.Country countryCode)
void	resetProxy() Reset proxy to system's proxy for getting data from OpenWeatherMap.org
void	setAccuracy(OWM.Accuracy value)
void	setApiKey(java.lang.String value)
void	setBaseUrl(java.lang.String p)
void	setLanguage(OWM.Language value)
OWM	setNoProxy() Remove proxy (i.e., direct connection) for getting data from OpenWeatherMap.org
void	setProxy(java.net.Proxy value)
OWM	setProxy(java.net.Proxy proxy, java.lang.String user, java.lang.String pass) Set authenticated proxy for getting data from OpenWeatherMap.org
OWM	setProxy(java.lang.String host, int port) Set HTTP proxy for getting data from OpenWeatherMap.org
OWM	setProxy(java.lang.String host, int port, java.net.Proxy.Type type) Set proxy of any type for getting data from OpenWeatherMap.org
OWM	setProxy(java.lang.String host, int port, java.lang.String user, java.lang.String pass) Set authenticated HTTP proxy for getting data from OpenWeatherMap.org
OWM	setProxy(java.lang.String host, int port, java.lang.String user, java.lang.String pass, java.net.Proxy.Type type) Set authenticated proxy of any type for getting data from OpenWeatherMap.org
void	setRetrofit4others(retrofit2.Retrofit p)
void	setRetrofit4pollution(retrofit2.Retrofit p)
void	setRetrofit4weather(retrofit2.Retrofit p)
void	setUnit(OWM.Unit value)

Field Detail

Companion

public static OWM.Companion Companion

Constructor Detail

OWM

public OWM(java.lang.String apiKey)

Constructor

Defaults: Search accuracy is set to like Defaults: Unit is set to standard Defaults: Language is set to English Defaults: Proxy is set to system's proxy

OpenWeatherMap.org API key

Parameters:

apiKey - API key (free) from OpenWeatherMap.org

See Also:

OpenWeatherMap.org API key

OWM

public OWM(java.lang.String apiKey,
           java.lang.String baseUrl)

Method Detail

getRetrofit4others

public retrofit2.Retrofit getRetrofit4others()

setRetrofit4others

public void setRetrofit4others(retrofit2.Retrofit p)

getRetrofit4pollution

public retrofit2.Retrofit getRetrofit4pollution()

setRetrofit4pollution

public void setRetrofit4pollution(retrofit2.Retrofit p)

getRetrofit4weather

public retrofit2.Retrofit getRetrofit4weather()

setRetrofit4weather

public void setRetrofit4weather(retrofit2.Retrofit p)

getBaseUrl

public java.lang.String getBaseUrl()

setBaseUrl

public void setBaseUrl(java.lang.String p)

getAccuracy

public OWM.Accuracy getAccuracy()

setAccuracy

public void setAccuracy(OWM.Accuracy value)

getApiKey

public java.lang.String getApiKey()

setApiKey

public void setApiKey(java.lang.String value)

getLanguage

public OWM.Language getLanguage()

setLanguage

public void setLanguage(OWM.Language value)

getProxy

public java.net.Proxy getProxy()

setProxy

public void setProxy(java.net.Proxy value)

getUnit

public OWM.Unit getUnit()

setUnit

public void setUnit(OWM.Unit value)

setProxy

public OWM setProxy(java.net.Proxy proxy,
                    java.lang.String user,
                    java.lang.String pass)

Set authenticated proxy for getting data from OpenWeatherMap.org

Parameters:

proxy - Proxy

user - User name for the proxy

pass - Password for the proxy

setProxy

public OWM setProxy(java.lang.String host,
                    int port)

Set HTTP proxy for getting data from OpenWeatherMap.org

Parameters:

host - Host address of the proxy

port - Port address of the proxy

setProxy

public OWM setProxy(java.lang.String host,
                    int port,
                    java.net.Proxy.Type type)

Set proxy of any type for getting data from OpenWeatherMap.org

Parameters:

host - Host address of the proxy

port - Port address of the proxy

type - Type of the proxy

setProxy

public OWM setProxy(java.lang.String host,
                    int port,
                    java.lang.String user,
                    java.lang.String pass)

Set authenticated HTTP proxy for getting data from OpenWeatherMap.org

Parameters:

host - Host address of the proxy

port - Port address of the proxy

user - User name for the proxy if required

pass - Password for the proxy if required

setProxy

public OWM setProxy(java.lang.String host,
                    int port,
                    java.lang.String user,
                    java.lang.String pass,
                    java.net.Proxy.Type type)

Set authenticated proxy of any type for getting data from OpenWeatherMap.org

Parameters:

host - Host address of the proxy

port - Port address of the proxy

user - User name for the proxy if required

pass - Password for the proxy if required

type - Type of the proxy

setNoProxy

public OWM setNoProxy()

Remove proxy (i.e., direct connection) for getting data from OpenWeatherMap.org

resetProxy

public void resetProxy()

Reset proxy to system's proxy for getting data from OpenWeatherMap.org

currentWeatherByCityName

public CurrentWeather currentWeatherByCityName(java.lang.String cityName)

currentWeatherByCityName

public CurrentWeather currentWeatherByCityName(java.lang.String cityName,
                                               OWM.Country countryCode)

currentWeatherByCityId

public CurrentWeather currentWeatherByCityId(int cityId)

currentWeatherByCoords

public CurrentWeather currentWeatherByCoords(double latitude,
                                             double longitude)

currentWeatherByZipCode

public CurrentWeather currentWeatherByZipCode(int zipCode)

currentWeatherByZipCode

public CurrentWeather currentWeatherByZipCode(int zipCode,
                                              OWM.Country countryCode)

hourlyWeatherForecastByCityName

public HourlyWeatherForecast hourlyWeatherForecastByCityName(java.lang.String cityName)

hourlyWeatherForecastByCityName

public HourlyWeatherForecast hourlyWeatherForecastByCityName(java.lang.String cityName,
                                                             OWM.Country countryCode)

hourlyWeatherForecastByCityId

public HourlyWeatherForecast hourlyWeatherForecastByCityId(int cityId)

hourlyWeatherForecastByCoords

public HourlyWeatherForecast hourlyWeatherForecastByCoords(double latitude,
                                                           double longitude)

hourlyWeatherForecastByZipCode

public HourlyWeatherForecast hourlyWeatherForecastByZipCode(int zipCode)

hourlyWeatherForecastByZipCode

public HourlyWeatherForecast hourlyWeatherForecastByZipCode(int zipCode,
                                                            OWM.Country countryCode)

dailyWeatherForecastByCityName

public DailyWeatherForecast dailyWeatherForecastByCityName(java.lang.String cityName)

dailyWeatherForecastByCityName

public DailyWeatherForecast dailyWeatherForecastByCityName(java.lang.String cityName,
                                                           int count)

dailyWeatherForecastByCityName

public DailyWeatherForecast dailyWeatherForecastByCityName(java.lang.String cityName,
                                                           OWM.Country countryCode)

dailyWeatherForecastByCityName

public DailyWeatherForecast dailyWeatherForecastByCityName(java.lang.String cityName,
                                                           OWM.Country countryCode,
                                                           int count)

dailyWeatherForecastByCityId

public DailyWeatherForecast dailyWeatherForecastByCityId(int cityId)

dailyWeatherForecastByCityId

public DailyWeatherForecast dailyWeatherForecastByCityId(int cityId,
                                                         int count)

dailyWeatherForecastByCoords

public DailyWeatherForecast dailyWeatherForecastByCoords(double latitude,
                                                         double longitude)

dailyWeatherForecastByCoords

public DailyWeatherForecast dailyWeatherForecastByCoords(double latitude,
                                                         double longitude,
                                                         int count)

dailyWeatherForecastByZipCode

public DailyWeatherForecast dailyWeatherForecastByZipCode(int zipCode)

dailyWeatherForecastByZipCode

public DailyWeatherForecast dailyWeatherForecastByZipCode(int zipCode,
                                                          int count)

dailyWeatherForecastByZipCode

public DailyWeatherForecast dailyWeatherForecastByZipCode(int zipCode,
                                                          OWM.Country countryCode)

dailyWeatherForecastByZipCode

public DailyWeatherForecast dailyWeatherForecastByZipCode(int zipCode,
                                                          OWM.Country countryCode,
                                                          int count)

currentUVIndexByCoords

public CurrentUVIndex currentUVIndexByCoords(double latitude,
                                             double longitude)

dailyUVIndexForecastByCoords

public java.util.List<net.aksingh.owmjapis.model.DailyUVIndexForecast> dailyUVIndexForecastByCoords(double latitude,
                                                                                                    double longitude)

historicalUVIndexByCoords

public java.util.List<net.aksingh.owmjapis.model.HistoricalUVIndex> historicalUVIndexByCoords(double latitude,
                                                                                              double longitude,
                                                                                              int count,
                                                                                              long startTime,
                                                                                              long endTime)

historicalUVIndexByCoords

public java.util.List<net.aksingh.owmjapis.model.HistoricalUVIndex> historicalUVIndexByCoords(double latitude,
                                                                                              double longitude,
                                                                                              int count,
                                                                                              java.util.Date startTime,
                                                                                              java.util.Date endTime)

historicalUVIndexByCoords

public java.util.List<net.aksingh.owmjapis.model.HistoricalUVIndex> historicalUVIndexByCoords(double latitude,
                                                                                              double longitude,
                                                                                              long startTime,
                                                                                              long endTime)

historicalUVIndexByCoords

public java.util.List<net.aksingh.owmjapis.model.HistoricalUVIndex> historicalUVIndexByCoords(double latitude,
                                                                                              double longitude,
                                                                                              java.util.Date startTime,
                                                                                              java.util.Date endTime)

airPollutionByCoords

public AirPollution airPollutionByCoords(double latitude,
                                         double longitude,
                                         java.lang.String dateTime)

airPollutionByCoords

public AirPollution airPollutionByCoords(double latitude,
                                         double longitude,
                                         java.util.Date dateTime)

currentAirPollutionByCoords

public AirPollution currentAirPollutionByCoords(double latitude,
                                                double longitude)

createRetrofit4WeatherInstance

public retrofit2.Retrofit createRetrofit4WeatherInstance(java.net.Proxy proxy)

Init Retrofit for getting weather data from OpenWeatherMap.org

Parameters:

proxy - Proxy

createRetrofit4PollutionInstance

public retrofit2.Retrofit createRetrofit4PollutionInstance(java.net.Proxy proxy)

Init Retrofit for getting pollution data from OpenWeatherMap.org

Parameters:

proxy - Proxy

createRetrofit4OthersInstance

public retrofit2.Retrofit createRetrofit4OthersInstance(java.net.Proxy proxy)

Init Retrofit for getting other data from OpenWeatherMap.org

Parameters:

proxy - Proxy