org.rvpf.base

Class DateTime.Context

Object

DateTime.Context

Enclosing class:

DateTime

public static class DateTime.Context
extends Object

Context.

Constructor Summary

Constructors

Constructor and Description
Context() Constructs an instance.
Context(TimeZone timeZone) Constructs an instance.
Context(ZoneId zoneId) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
DateTime	fromFields(DateTime.Fields fields) Returns a DateTime built from fields.
DateTime	fromString(String timeString) Returns a DateTime decoded from a time string.
DateTime	fromString(String timeString, Optional<DateTime> reference) Returns a DateTime decoded from a time string.
int	getDayOfWeek(DateTime dateTime) Gets the day of week for a DateTime.
int	getDaysInMonth(DateTime dateTime) Gets the number of days in the month of a DateTime.
TimeZone	getTimeZone() Gets the time zone.
ZoneId	getZoneId() Gets the ZoneId.
DateTime	midnight(DateTime dateTime) Returns a DateTime from a DateTime at midnight.
DateTime	nextDay(DateTime dateTime) Returns a DateTime from a DateTime at midnight on the next day.
DateTime	noon(DateTime dateTime) Returns a DateTime from a DateTime at noon.
DateTime	previousDay(DateTime dateTime) Returns a DateTime from a DateTime at midnight on the previous day.
String	toBaseString(DateTime dateTime) Provides a base string representation of a DateTime.
DateTime.Fields	toFields(DateTime dateTime) Returns the fields from a DateTime.
String	toFullString(DateTime dateTime) Provides a full extended string representation of a DateTime.
String	toOrdinalString(DateTime dateTime) Provides an ordinal string representation of a DateTime.
String	toString()
String	toString(DateTime dateTime) Provides a string representation of a DateTime.
String	toURLString(DateTime dateTime) Provides a URL compatible representation of a DateTime.
ZonedDateTime	toZonedDateTime(DateTime dateTime) Returns a ZonedDateTime for a DateTime.

Methods inherited from class Object

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

Constructor Detail

Context

public Context()

Constructs an instance.

Context

public Context(@Nonnull
               TimeZone timeZone)

Constructs an instance.

Parameters:

timeZone - The TimeZone.

Context

public Context(@Nonnull
               ZoneId zoneId)

Constructs an instance.

Parameters:

zoneId - The ZoneId.

Method Detail

fromFields

@Nonnull
 @CheckReturnValue
public DateTime fromFields(@Nonnull
                                                         DateTime.Fields fields)

Returns a DateTime built from fields.

Parameters:

fields - The fields.

Returns:

The DateTime.

fromString

@Nonnull
 @CheckReturnValue
public DateTime fromString(@Nonnull
                                                         String timeString)

Returns a DateTime decoded from a time string.

It accepts as input the output of toString(), DateTime.toFullString(), DateTime.toHexString() or Timestamp.toString().

Parameters:

timeString - The required and not empty time String.

Returns:

The DateTime.

Throws:

IllegalArgumentException - When the time String is invalid.

fromString

@Nonnull
 @CheckReturnValue
public DateTime fromString(@Nonnull
                                                         String timeString,
                                                         @Nonnull
                                                         Optional<DateTime> reference)
                                                  throws IllegalArgumentException

Returns a DateTime decoded from a time string.

It accepts as input the output of toString(), DateTime.toFullString(), DateTime.toHexString() or Timestamp.toString(). It will return null for a null input.

Parameters:

timeString - The required and not empty time String.

reference - An optional reference date to use when the year is missing.

Returns:

The DateTime.

Throws:

IllegalArgumentException - When the time String is invalid.

getDayOfWeek

@CheckReturnValue
public int getDayOfWeek(@Nonnull
                                           DateTime dateTime)

Gets the day of week for a DateTime.

Parameters:

dateTime - The DateTime.

Returns:

The day of week (0 - 6 where 0 is Sunday).

getDaysInMonth

@CheckReturnValue
public int getDaysInMonth(@Nonnull
                                             DateTime dateTime)

Gets the number of days in the month of a DateTime.

Parameters:

dateTime - The DateTime.

Returns:

The number of days (28 - 31).

getTimeZone

@Nonnull
 @CheckReturnValue
public TimeZone getTimeZone()

Gets the time zone.

Returns:

The time zone.

getZoneId

@Nonnull
 @CheckReturnValue
public ZoneId getZoneId()

Gets the ZoneId.

Returns:

The ZoneId.

midnight

@Nonnull
 @CheckReturnValue
public DateTime midnight(@Nonnull
                                                       DateTime dateTime)

Returns a DateTime from a DateTime at midnight.

Parameters:

dateTime - The original DateTime.

Returns:

The new DateTime.

nextDay

@Nonnull
 @CheckReturnValue
public DateTime nextDay(@Nonnull
                                                      DateTime dateTime)

Returns a DateTime from a DateTime at midnight on the next day.

Parameters:

dateTime - The original DateTime.

Returns:

The new DateTime.

noon

@Nonnull
 @CheckReturnValue
public DateTime noon(@Nonnull
                                                   DateTime dateTime)

Returns a DateTime from a DateTime at noon.

Parameters:

dateTime - The original DateTime.

Returns:

The new DateTime.

previousDay

@Nonnull
 @CheckReturnValue
public DateTime previousDay(@Nonnull
                                                          DateTime dateTime)

Returns a DateTime from a DateTime at midnight on the previous day.

Parameters:

dateTime - The original DateTime.

Returns:

The new DateTime.

toBaseString

@Nonnull
 @CheckReturnValue
public String toBaseString(@Nonnull
                                                         DateTime dateTime)

Provides a base string representation of a DateTime.

Generates a base string in ISO 8601 format adjusted to astronomical conventions.

Parameters:

dateTime - The DateTime.

Returns:

The base string representation of the DateTime.

toFields

@Nonnull
 @CheckReturnValue
public DateTime.Fields toFields(@Nonnull
                                                              DateTime dateTime)

Returns the fields from a DateTime.

Parameters:

dateTime - The DateTime.

Returns:

The fields.

toFullString

@Nonnull
 @CheckReturnValue
public String toFullString(@Nonnull
                                                         DateTime dateTime)

Provides a full extended string representation of a DateTime.

Generates an extended string in ISO 8601 format adjusted to astronomical conventions.

Parameters:

dateTime - The DateTime.

Returns:

The full extended string representation of the DateTime.

toOrdinalString

@Nonnull
 @CheckReturnValue
public String toOrdinalString(@Nonnull
                                                            DateTime dateTime)

Provides an ordinal string representation of a DateTime.

Generates a string in ISO 8601 format adjusted to astronomical conventions with the date in ordinal (yyyy-ddd) representation.

Parameters:

dateTime - The DateTime.

Returns:

The string representation of the DateTime.

toString

public String toString()

Overrides:

toString in class Object

toString

@Nonnull
 @CheckReturnValue
public String toString(@Nonnull
                                                     DateTime dateTime)

Provides a string representation of a DateTime.

Generates a string in ISO 8601 format adjusted to astronomical conventions.

Parameters:

dateTime - The DateTime.

Returns:

The string representation of the DateTime.

toURLString

@Nonnull
 @CheckReturnValue
public String toURLString(@Nonnull
                                                        DateTime dateTime)

Provides a URL compatible representation of a DateTime.

Parameters:

dateTime - The DateTime.

Returns:

The URL compatible representation of the DateTime.

toZonedDateTime

@Nonnull
 @CheckReturnValue
public ZonedDateTime toZonedDateTime(@Nonnull
                                                                   DateTime dateTime)

Returns a ZonedDateTime for a DateTime.

Parameters:

dateTime - The DateTime.

Returns:

The ZonedDateTime.