README.md

Lite-Java-Weather-Library

A Java Library for better and easier worldwide Weather data including current condition, forecast, location info etc.

• Lite-Java-Weather-Library
• Install & requirements
  • Apache Maven
  • Gradle Groovy DSL
• How to use
  • All in one
    • Description
    • Example
    • Constructors
  • Current Condition
    • Description
    • Example
  • Forecast
    • Description
      • WeatherForecast constructors:
    • Examples
  • Nearest Area
    • Description
    • Examples
  • Request
    • Description
    • Example
  • Exceptions
• Data source / disclaimer

Install & requirements

• Maven central
• JavaDoc

Requirements

1. Java: 11
2. Internet connection

Apache Maven

<dependency>
  <groupId>cz.krystofcejchan</groupId>
  <artifactId>lite_weather_library</artifactId>
  <version>1.1.3</version>
</dependency>

Gradle Groovy DSL

implementation 'cz.krystofcejchan:lite_weather_library:1.1.3'

How to use

All in one

Description

Create an object of WeatherObject to access all the data! From this object you can access all the functionality of other classes(CurrentCondition, WeatherForecase etc.). This class also contains JSON file from which the weather data are gathered from.

Example

WeatherObject weatherObject = new WeatherObject("Mexico City", DAY.ALL, TIME.AM_6, TIME.AM_9);
System.out.println(weatherObject.getWeatherForecast().getForecastFor(DAY.TOMORROW, TIME.AM_9));
//System.out.println(weatherObject.getJsonAsText());
System.out.println(weatherObject.getCurrentCondition().getVisibility());

Output:

---ForecastAtHour---
day=TOMORROW
time=AM_9
dewPointC=12
dewPointF=53
feelsLikeC=16
feelsLikeF=60
heatIndexC=16
heatIndexF=60
windChillC=16
windChillF=60
windGustKmph=1
windGustMiles=1
chanceOfFog=0
chanceOfFrost=0
chanceOfHighTemperature=0
chanceOfOvercast=45
chanceOfRain=0
chanceOfRemdry=80
chanceOfSnow=0
chanceOfSunshine=73
chanceOfThunder=0
chanceOfWindy=0
cloudCover=31
humidity=77
precipInches=0.0
precipMM=0.0
pressure=1018
pressureInches=30
temperatureC=16
temperatureF=60
timeInHundreds=900
uvIndex=5
visibility=10
visibilityMiles=6
weatherCode=116
weatherDescription='Partly cloudy'
windDir16Point='N'
windDirDegree=1
windSpeedKmph=1
windSpeedMiles=1
10

Constructors

Current Condition

Description

Create an object of CurrentCondition to access all the data for current condition in provided location(set location in contrustor)

Example

CurrentCondition currentCondition = new CurrentCondition("Dublin");
System.out.println(currentCondition);

Output:

--CurrentCondition--
feelsLikeC=25
feelsLikeF=78
cloudCover=25
humidity=57
localObsDateTime=2022-08-13T16:41
observationTime=15:41
precipInches=0.0
precipMM=0.0
pressure=1014
pressureInches=30
temp_C=24
temp_F=75
uvIndex=6
visibility=10
visibilityMiles=6
weatherCode=116
weatherDescription='Partly cloudy'
windDir16Point='ENE'
winDirDegree=60
windSpeedKmph=17
windSpeedMiles=11
---

Forecast

Description

Create an object of WeatherForecast to access all the data for weather forecast for Today, Tomorrow and the day after Tomorrow. Each day can be separated into hours 00:00, 3am, 6am, 9am, 12pm, 3pm, 6pm, 9pm

WeatherForecast constructors:

Examples

//create a WeatherForecast object for City of Denver, for all days and times  
WeatherForecast weatherForecast = new WeatherForecast("Denver", DAY.ALL, TIME.ALL);
//search for forecast for the day after tomorrow at 6 am  
String toString=weatherForecast.getForecastFor(DAY.AFTER_TOMORROW,TIME.AM_6).toString();
//get average temperature for tomorrow in Celsius  
int averageTemperatureCForTomorrow =weatherForecast.getTomorrow().getAverageTemperatureC();
//get temperature for today at 3 pm in Fahrenheit  
int temperatureFTodayAt3pm = weatherForecast.getForecastFor(DAY.TODAY,TIME.PM_3).getTemperatureF();

System.out.println(toString + "\n\n" + "average temperature for tomorrow: " +
        averageTemperatureCForTomorrow + "\n" + "temperature for today at 3 pm: " + temperatureFTodayAt3pm); 

Output:

---ForecastAtHour---
day=AFTER_TOMORROW
time=AM_6
dewPointC=12
dewPointF=53
feelsLikeC=20
feelsLikeF=67
heatIndexC=20
heatIndexF=67
windChillC=20
windChillF=67
windGustKmph=3
windGustMiles=2
chanceOfFog=0
chanceOfFrost=0
chanceOfHighTemperature=0
chanceOfOvercast=0
chanceOfRain=0
chanceOfRemdry=80
chanceOfSnow=0
chanceOfSunshine=92
chanceOfThunder=0
chanceOfWindy=0
cloudCover=11
humidity=61
precipInches=0.0
precipMM=0.0
pressure=1014
pressureInches=30
temperatureC=20
temperatureF=67
timeInHundreds=600
uvIndex=1
visibility=10
visibilityMiles=6
weatherCode=113
weatherDescription='Clear'
windDir16Point='N'
windDirDegree=357
windSpeedKmph=2
windSpeedMiles=1


average temperature for tomorrow: 27
temperature for today at 3 pm: 98

Nearest Area

Description

Create an object of NearestArea to access all the data regarding the city/town/location for which the weather data has been gathered. The NearestArea class has a subclass AreaInfo containing more detailed information. The data may contain name of the town/city, the country where it is located, the population of the city etc.

Examples

NearestArea nearestArea = new NearestArea("Dallas");
System.out.println(nearestArea.getCountry() + ", " + nearestArea.getAreaInfo().region() + ", " + nearestArea.getAreaInfo().name());
System.out.println(nearestArea.toString());

Output:

United States of America, Texas, Dallas
--NearestArea--
country='United States of America
areaInfo=
--AreaInfo--
name=Dallas
latitude=32.783
longitude=-96.800
population=1211704
region=Texas

Request

Description

Create an object Request to get location request data, mainly Latitude and Longitude

Example

Request request = new Request("Oslo");
System.out.println(request.toString());

Output:

Request{query='Lat 59.91 and Lon 10.74', type='LatLon'}

Exceptions

Documentation

Data source / disclaimer

All weather data taken from https://wttr.in/

(c) https://github.com/krystof-cejchan