Package org.shredzone.commons.suncalc.util

Class BaseBuilder<T>

java.lang.Object

org.shredzone.commons.suncalc.util.BaseBuilder<T>

Type Parameters:

T - Type of the final builder

All Implemented Interfaces:

Cloneable, GenericParameter<T>, LocationParameter<T>, TimeParameter<T>, WindowParameter<T>

public class BaseBuilder<T>
extends Object
implements GenericParameter<T>, LocationParameter<T>, TimeParameter<T>, WindowParameter<T>, Cloneable

A base implementation of LocationParameter, TimeParameter, and WindowParameter.

For internal use only.

Constructor Summary

Constructors

Constructor	Description
BaseBuilder()

Method Summary

Modifier and Type	Method	Description
void	clearLocation()	Unset the geolocation.
T	copy()	Creates a copy of the current parameters.
T	elevation(double h)	Sets the elevation.
T	forward()	Sets a forward calculation window.
Duration	getDuration()	Returns the duration of the time window.
double	getElevation()	Returns the elevation, in meters above sea level.
JulianDate	getJulianDate()	Returns the JulianDate to be used.
double	getLatitude()	Returns the latitude.
double	getLatitudeRad()	Returns the latitude.
double	getLongitude()	Returns the longitude.
double	getLongitudeRad()	Returns the longitude.
boolean	hasLocation()	Returns true if a geolocation has been set.
T	latitude(double lat)	Sets the latitude.
T	limit(Duration duration)	Limits the calculation window to the given Duration.
T	longitude(double lng)	Sets the longitude.
T	midnight()	Sets the time to the start of the current date ("last midnight").
T	now()	Sets the current date and time.
T	on(int year, int month, int date, int hour, int minute, int second)	Sets date and time.
T	on(Instant instant)	Uses the given Instant instance.
T	on(LocalDate date)	Uses the given LocalDate instance, and assumes midnight.
T	on(LocalDateTime dateTime)	Uses the given LocalDateTime instance.
T	on(ZonedDateTime dateTime)	Uses the given ZonedDateTime instance.
T	plusDays(int days)	Adds a number of days to the current date.
T	reverse()	Sets a reverse calculation window.
T	sameLocationAs(LocationParameter<?> l)	Uses the same location as given in the LocationParameter at this moment.
T	sameTimeAs(TimeParameter<?> t)	Uses the same time as given in the TimeParameter.
T	sameWindowAs(WindowParameter<?> w)	Uses the same window as given in the WindowParameter.
T	timezone(ZoneId tz)	Sets the given ZoneId.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.shredzone.commons.suncalc.param.LocationParameter

at, at, elevationFt, height, heightFt, latitude, longitude

Methods inherited from interface org.shredzone.commons.suncalc.param.TimeParameter

localTime, on, on, on, timezone, timezone, today, tomorrow, utc

Methods inherited from interface org.shredzone.commons.suncalc.param.WindowParameter

fullCycle, oneDay

Constructor Details

BaseBuilder

public BaseBuilder()

Method Details

on

public T on(ZonedDateTime dateTime)

Description copied from interface: TimeParameter

Uses the given ZonedDateTime instance.

Specified by:

on in interface TimeParameter<T>

Parameters:

dateTime - ZonedDateTime to be used.

Returns:

itself

on

public T on(LocalDateTime dateTime)

Description copied from interface: TimeParameter

Uses the given LocalDateTime instance.

Specified by:

on in interface TimeParameter<T>

Parameters:

dateTime - LocalDateTime to be used.

Returns:

itself

on

public T on(LocalDate date)

Description copied from interface: TimeParameter

Uses the given LocalDate instance, and assumes midnight.

Specified by:

on in interface TimeParameter<T>

Parameters:

date - LocalDate to be used.

Returns:

itself

on

public T on(Instant instant)

Description copied from interface: TimeParameter

Uses the given Instant instance.

Specified by:

on in interface TimeParameter<T>

Parameters:

instant - Instant to be used.

Returns:

itself

on

public T on(int year,
 int month,
 int date,
 int hour,
 int minute,
 int second)

Description copied from interface: TimeParameter

Sets date and time. Note that also seconds can be passed in for convenience, but the results are not that accurate.

Specified by:

on in interface TimeParameter<T>

Parameters:

year - Year

month - Month (1 = January, 2 = February, ...)

date - Day of month

hour - Hour of day

minute - Minute

second - Second

Returns:

itself

now

public T now()

Description copied from interface: TimeParameter

Sets the current date and time. This is the default.

Specified by:

now in interface TimeParameter<T>

Returns:

itself

plusDays

public T plusDays(int days)

Description copied from interface: TimeParameter

Adds a number of days to the current date.

Specified by:

plusDays in interface TimeParameter<T>

Parameters:

days - Number of days to add

Returns:

itself

midnight

public T midnight()

Description copied from interface: TimeParameter

Sets the time to the start of the current date ("last midnight").

Specified by:

midnight in interface TimeParameter<T>

Returns:

itself

timezone

public T timezone(ZoneId tz)

Description copied from interface: TimeParameter

Sets the given ZoneId. The local time is retained, so the parameter order is not important.

Specified by:

timezone in interface TimeParameter<T>

Parameters:

tz - ZoneId to be used.

Returns:

itself

latitude

public T latitude(double lat)

Description copied from interface: LocationParameter

Sets the latitude.

Specified by:

latitude in interface LocationParameter<T>

Parameters:

lat - Latitude, in degrees.

Returns:

itself

longitude

public T longitude(double lng)

Description copied from interface: LocationParameter

Sets the longitude.

Specified by:

longitude in interface LocationParameter<T>

Parameters:

lng - Longitude, in degrees.

Returns:

itself

elevation

public T elevation(double h)

Description copied from interface: LocationParameter

Sets the elevation.

Specified by:

elevation in interface LocationParameter<T>

Parameters:

h - Elevation, in meters above sea level. Default: 0.0 m. Negative values are silently changed to the acceptable minimum of 0.0 m.

Returns:

itself

See Also:

• LocationParameter.elevationFt(double)

limit

public T limit(Duration duration)

Description copied from interface: WindowParameter

Limits the calculation window to the given Duration.

Specified by:

limit in interface WindowParameter<T>

Parameters:

duration - Duration of the calculation window. A negative duration sets a reverse time window, giving result times in the past.

Returns:

itself

reverse

public T reverse()

Description copied from interface: WindowParameter

Sets a reverse calculation window. It will end at the given date.

Specified by:

reverse in interface WindowParameter<T>

Returns:

itself

forward

public T forward()

Description copied from interface: WindowParameter

Sets a forward calculation window. It will start at the given date.

This is the default.

Specified by:

forward in interface WindowParameter<T>

Returns:

itself

sameTimeAs

public T sameTimeAs(TimeParameter<?> t)

Description copied from interface: TimeParameter

Uses the same time as given in the TimeParameter.

Changes to the source parameter will not affect this parameter, though.

Specified by:

sameTimeAs in interface TimeParameter<T>

Parameters:

t - TimeParameter to be used.

Returns:

itself

sameLocationAs

public T sameLocationAs(LocationParameter<?> l)

Description copied from interface: LocationParameter

Uses the same location as given in the LocationParameter at this moment.

Changes to the source parameter will not affect this parameter, though.

Specified by:

sameLocationAs in interface LocationParameter<T>

Parameters:

l - LocationParameter to be used.

Returns:

itself

sameWindowAs

public T sameWindowAs(WindowParameter<?> w)

Description copied from interface: WindowParameter

Uses the same window as given in the WindowParameter.

Changes to the source parameter will not affect this parameter, though.

Specified by:

sameWindowAs in interface WindowParameter<T>

Parameters:

w - WindowParameter to be used.

Returns:

itself

copy

public T copy()

Description copied from interface: GenericParameter

Creates a copy of the current parameters. The copy can be changed independently.

Specified by:

copy in interface GenericParameter<T>

getLongitude

public double getLongitude()

Returns the longitude.

Returns:

Longitude, in degrees.

getLatitude

public double getLatitude()

Returns the latitude.

Returns:

Latitude, in degrees.

getLongitudeRad

public double getLongitudeRad()

Returns the longitude.

Returns:

Longitude, in radians.

getLatitudeRad

public double getLatitudeRad()

Returns the latitude.

Returns:

Latitude, in radians.

getElevation

public double getElevation()

Returns the elevation, in meters above sea level.

Returns:

Elevation, meters above sea level

getJulianDate

public JulianDate getJulianDate()

Returns the JulianDate to be used.

Returns:

JulianDate

hasLocation

public boolean hasLocation()

Returns true if a geolocation has been set.

Since:

3.9

clearLocation

public void clearLocation()

Unset the geolocation.

Since:

3.9

getDuration

public Duration getDuration()

Returns the duration of the time window.

Since:

3.11