Package org.shredzone.commons.suncalc

Class SunTimes

java.lang.Object

org.shredzone.commons.suncalc.SunTimes

public class SunTimes
extends Object

Calculates the rise and set times of the sun.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SunTimes.Parameters	Collects all parameters for SunTimes.
static enum	SunTimes.Twilight	Enumeration of predefined twilights.

Method Summary

Modifier and Type	Method	Description
static SunTimes.Parameters	compute()	Starts the computation of SunTimes.
ZonedDateTime	getNadir()	The time when the sun reaches its lowest point.
ZonedDateTime	getNoon()	The time when the sun reaches its highest point.
ZonedDateTime	getRise()	Sunrise time.
ZonedDateTime	getSet()	Sunset time.
boolean	isAlwaysDown()	true if the sun never rises/sets, but is always below the twilight angle.
boolean	isAlwaysUp()	true if the sun never rises/sets, but is always above the twilight angle.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

compute

public static SunTimes.Parameters compute()

Starts the computation of SunTimes.

Returns:

SunTimes.Parameters to set.

getRise

@Nullable
public ZonedDateTime getRise()

Sunrise time. null if the sun does not rise that day.

Always returns a sunrise time if SunTimes.Parameters.fullCycle() was set.

getSet

@Nullable
public ZonedDateTime getSet()

Sunset time. null if the sun does not set that day.

Always returns a sunset time if SunTimes.Parameters.fullCycle() was set.

getNoon

@Nullable
public ZonedDateTime getNoon()

The time when the sun reaches its highest point.

Use isAlwaysDown() to find out if the highest point is still below the twilight angle.

getNadir

@Nullable
public ZonedDateTime getNadir()

The time when the sun reaches its lowest point.

Use isAlwaysUp() to find out if the lowest point is still above the twilight angle.

isAlwaysUp

public boolean isAlwaysUp()

true if the sun never rises/sets, but is always above the twilight angle.

isAlwaysDown

public boolean isAlwaysDown()

true if the sun never rises/sets, but is always below the twilight angle.

toString

public String toString()

Overrides:

toString in class Object