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>, TimeResultParameter<T>

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

A base implementation of LocationParameter and TimeParameter.

For internal use only.

Nested Class Summary

Nested classes/interfaces inherited from interface org.shredzone.commons.suncalc.param.TimeResultParameter

TimeResultParameter.Unit

Constructor Summary

Constructors

Constructor	Description
BaseBuilder()

Method Summary

Modifier and Type	Method	Description
T	at(double[] coords)	Sets the geolocation.
T	at(double lat, double lng)	Sets the geolocation.
protected Object	clone()
T	copy()	Creates a copy of the current parameters.
protected Calendar	createCalendar()	Creates a new Calendar instance containing the current instant.
double	getHeight()	Returns the height, 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.
TimeResultParameter.Unit	getTruncatedTo()	Returns the TimeResultParameter.Unit to truncate to.
T	height(double h)	Sets the height.
T	latitude(double lat)	Sets the latitude.
T	latitude(int d, int m, double s)	Sets the latitude.
T	localTime()	Sets the system's TimeZone.
T	longitude(double lng)	Sets the longitude.
T	longitude(int d, int m, double s)	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)	Sets midnight of the year, month and date.
T	on(int year, int month, int date, int hour, int minute, int second)	Sets date and time.
T	on(Calendar calendar)	Uses the given Calendar instance.
T	on(Date date)	Uses the given Date instance.
T	plusDays(int days)	Adds a number of days to the current date.
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	timezone(String id)	Sets the given TimeZone.
T	timezone(TimeZone tz)	Sets the given TimeZone.
T	today()	Sets today, midnight.
T	tomorrow()	Sets tomorrow, midnight.
T	truncatedTo(TimeResultParameter.Unit unit)	Time unit to truncate the result to.
T	utc()	Sets the time zone to UTC.

Methods inherited from class java.lang.Object

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

Constructor Details

BaseBuilder

public BaseBuilder()

Method Details

on

public T on(int year,
 int month,
 int date)

Description copied from interface: TimeParameter

Sets midnight of the year, month and date. Uses the system's time zone unless a different time zone is given.

Specified by:

on in interface TimeParameter<T>

Parameters:

year - Year

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

date - Day of month

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. Uses the system's time zone unless a different time zone is given.

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

on

public T on(Date date)

Description copied from interface: TimeParameter

Uses the given Date instance. Uses the system's time zone unless a different time zone is given.

Specified by:

on in interface TimeParameter<T>

Parameters:

date - Date. A copy of the date is used. The Date instance may be reused after that.

Returns:

itself

on

public T on(Calendar calendar)

Description copied from interface: TimeParameter

Uses the given Calendar instance.

Specified by:

on in interface TimeParameter<T>

Parameters:

calendar - Calendar. A copy of the date, time, and time zone is used. The Calendar instance may be reused after that.

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

today

public T today()

Description copied from interface: TimeParameter

Sets today, midnight.

It is the same as now().midnight().

Specified by:

today in interface TimeParameter<T>

Returns:

itself

tomorrow

public T tomorrow()

Description copied from interface: TimeParameter

Sets tomorrow, midnight.

It is the same as now().midnight().plusDays(1).

Specified by:

tomorrow in interface TimeParameter<T>

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

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(TimeZone tz)

Description copied from interface: TimeParameter

Sets the given TimeZone.

Specified by:

timezone in interface TimeParameter<T>

Parameters:

tz - TimeZone to be used.

Returns:

itself

timezone

public T timezone(String id)

Description copied from interface: TimeParameter

Sets the given TimeZone. This is a convenience method that just invokes TimeZone.getTimeZone(String).

Specified by:

timezone in interface TimeParameter<T>

Parameters:

id - ID of the time zone. "GMT" is used if the time zone ID was not understood.

Returns:

itself

See Also:

• TimeZone.getTimeZone(String)

utc

public T utc()

Description copied from interface: TimeParameter

Sets the time zone to UTC.

Specified by:

utc in interface TimeParameter<T>

Returns:

itself

localTime

public T localTime()

Description copied from interface: TimeParameter

Sets the system's TimeZone. This is the default.

Specified by:

localTime in interface TimeParameter<T>

Returns:

itself

at

public T at(double lat,
 double lng)

Description copied from interface: LocationParameter

Sets the geolocation.

Specified by:

at in interface LocationParameter<T>

Parameters:

lat - Latitude, in degrees.

lng - Longitude, in degrees.

Returns:

itself

at

public T at(double[] coords)

Description copied from interface: LocationParameter

Sets the geolocation. In the given array, index 0 must contain the latitude, and index 1 must contain the longitude. An optional index 2 may contain the height, in meters.

This call is meant to be used for coordinates stored in constants.

Specified by:

at in interface LocationParameter<T>

Parameters:

coords - Array containing the latitude and longitude, in degrees.

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

latitude

public T latitude(int d,
 int m,
 double s)

Description copied from interface: LocationParameter

Sets the latitude.

Specified by:

latitude in interface LocationParameter<T>

Parameters:

d - Degrees

m - Minutes

s - Seconds (and fraction of seconds)

Returns:

itself

longitude

public T longitude(int d,
 int m,
 double s)

Description copied from interface: LocationParameter

Sets the longitude.

Specified by:

longitude in interface LocationParameter<T>

Parameters:

d - Degrees

m - Minutes

s - Seconds (and fraction of seconds)

Returns:

itself

height

public T height(double h)

Description copied from interface: LocationParameter

Sets the height.

Specified by:

height in interface LocationParameter<T>

Parameters:

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

Returns:

itself

truncatedTo

public T truncatedTo(TimeResultParameter.Unit unit)

Description copied from interface: TimeResultParameter

Time unit to truncate the result to.

Specified by:

truncatedTo in interface TimeResultParameter<T>

Parameters:

unit - TimeResultParameter.Unit to use. By default, TimeResultParameter.Unit.MINUTES is used.

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

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.

getHeight

public double getHeight()

Returns the height, in meters above sea level.

Returns:

Height, meters above sea level

getJulianDate

public JulianDate getJulianDate()

Returns the JulianDate to be used.

Returns:

JulianDate

getTruncatedTo

public TimeResultParameter.Unit getTruncatedTo()

Returns the TimeResultParameter.Unit to truncate to.

Returns:

TimeResultParameter.Unit

Since:

2.3

createCalendar

protected Calendar createCalendar()

Creates a new Calendar instance containing the current instant.

This method can be overriden on unit tests.

Returns:

Calendar instance

clone

protected Object clone()
                throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException