Sunrise-Sunset

The SunriseSunset class calculates the sunrise, sunset, and twilight times based on the user's time zone, latitude and longitude.

######Version

Version -> 1.0 -> Design and development of SunriseSunset library

######Build

Build -> Oracle JDK 8.0

######Dependencies

None

###Gradle

Add the following to your build.gradle file:

repositories {
    mavenCentral()
}

dependencies {
    compile group: 'main.java', name: 'SunriseSunset', version: '1.0'
}

###API

The SunriseSunset library is broken down into 4 classes:

• SunriseSunset.java -> Main class of the library where the user will create a new SunriseSunset object with the appropriate time zone, latitude, and longitude.
• SunriseSunsetCalculator.java -> This class provides the underlying implementation point for calculating the correct sunrise and sunset times.
• Twilight.java -> This class holds the relationship of the different phases (astronomical, nautical, civil, and offfical) of sunrise and sunset.
• MathUtility.java -> A simple utility class to hand generic math calculations (cosine, sin, etc.)
• TimeZones -> A complete list of TimeZone identifiers

#####SunriseSunset API

The following methods to create a SunriseSunset object take the following inputs: a time zone identifier, latitude, and longitude (with both latitude and longitude being either BigDecimal, Double, or String).

public SunriseSunset(String timeZoneIdentifier, BigDecimal latitude, BigDecimal longitude);

public SunriseSunset(String timeZoneIdentifier, Double latitude, Double longitude);

public SunriseSunset(String timeZoneIdentifier, String latitude, String longitude);

The following methods to create a SunriseSunset object take the following inputs: a TimeZone object, latitude, and longitude (with both latitude and longitude being either BigDecimal, Double, or String).

public SunriseSunset(TimeZone timeZone, BigDecimal latitude, BigDecimal longitude);

public SunriseSunset(TimeZone timeZone, BigDecimal latitude, BigDecimal longitude);

public SunriseSunset(TimeZone timeZone, BigDecimal latitude, BigDecimal longitude);

The following methods retrieve the official sunrise or sunset from the SunriseSunset object (with one returning a time in a String format and the other returning a Calendar object) based on the date requested:

public String getOfficialSunrise(Calendar date);

public String getOfficialSunset(Calendar date);

public Calendar getOfficialSunriseCalendar(Calendar date);

public String getOfficialSunsetCalendar(Calendar date);

To retrieve the astronomical sunrise or sunset based on the date requested using one of the following methods:

public String getAstronomicalSunrise(Calendar date);

public String getAstronomicalSunset(Calendar date);

public Calendar getAstronomicalSunriseCalendar(Calendar date);

public String getAstronomicalSunsetCalendar(Calendar date);

To retrieve the civil sunrise or sunset based on the date requested using one of the following methods:

public String getCivilSunrise(Calendar date);

public String getCivilSunset(Calendar date);

public Calendar getCivilSunriseCalendar(Calendar date);

public String getCivilSunsetCalendar(Calendar date);

To retrieve the nautical sunrise or sunset based on the date requested using one of the following methods:

public String getNauticalSunrise(Calendar date);

public String getNauticalSunset(Calendar date);

public Calendar getNauticalSunriseCalendar(Calendar date);

public String getNauticalSunsetCalendar(Calendar date);

###Usage

Example (retrieve the sunrise and sunset):

SunriseSunset london = new SunriseSunset("GMT", 51.507351, -0.127758);
String sunrise = london.getOfficialSunrise(Calendar.getInstance());
String sunset = london.getOfficialSunset(Calendar.getInstance());

###License

MIT License --> A short, permissive software license. Basically, you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source. There are many variations of this license in use.