Class BmDateTimeWrapper

java.lang.Object

net.bluemind.core.api.date.BmDateTimeWrapper

public class BmDateTimeWrapper
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
final BmDateTime	bmDateTime

Constructor Summary

Constructors

Constructor	Description
BmDateTimeWrapper(BmDateTime bmDateTime)

Method Summary

Modifier and Type	Method	Description
boolean	containsTimeZone()	Test if BmDateTime.timezone is not null and is a valid identifier according to ZoneId.getAvailableZoneIds()
BmDateTime	copy(long timestamp)	Create a new BmDateTime using BmDateTime.timezone, BmDateTime.precision and timestamp.
static BmDateTime	create(String iso8601)	Creates a BmDateTime based on a string.
static BmDateTime	create(String iso8601, String timezone)	Creates a BmDateTime based on a string and a timezone.
static BmDateTime	create(String iso8601, String timezone, BmDateTime.Precision precision)	Creates a BmDateTime based on a string, a timezone and a precision.
static BmDateTime	create(String iso8601, BmDateTime.Precision precision)	Creates a BmDateTime based on a string and a precision.
static BmDateTime	create(LocalDate date)	Create a new BmDateTime from a LocalDate
static BmDateTime	create(LocalDateTime localDateTime, BmDateTime.Precision precision)	Timezone will be set to UTC.
static BmDateTime	create(ZonedDateTime dateTime, BmDateTime.Precision precision)	Timezone will be set after ZonedDateTime.getZone().
String	format(String format)	Output the BmDateTime using the specified format pattern.
static BmDateTime	fromTimestamp(long timestamp)	Creates a BmDateTime based on a timestamp.
static BmDateTime	fromTimestamp(long timestamp, String timezone)	Creates a BmDateTime based on a timestamp and a timezone.
static BmDateTime	fromTimestamp(long timestamp, String timezone, BmDateTime.Precision precision)	Creates a BmDateTime based on a timestamp, a timezone and a precision.
boolean	isAfter(BmDateTime date)
boolean	isBefore(BmDateTime date)
BmDateTime	minus(TemporalAmount duration)
BmDateTime	plus(TemporalAmount duration)
static boolean	sameRecurId(BmDateTime a, BmDateTime b)	Compares two recurids for occurrence identity.
Date	toDate()	Convert BmDateTime to a Date.
ZonedDateTime	toDateTime()	transform the BmDateTime instance to an ZonedDateTime}.
ZonedDateTime	toDateTime(String timezone)	transform the BmDateTime instance to an ZonedDateTime
String	toIso8601()
static String	toIso8601(long timestamp, String timezone)
long	toTimestamp(String timezone)	If BmDateTime is a representation of a LocalDate or a LocalDateTime, timezone is used as BmDateTime.iso8601 tz
static long	toTimestamp(String iso8601, String timezone)	Gets the milliseconds of the BmDateTime from the Java epoch of 1970-01-01T00:00:00Z.
long	toUTCTimestamp()	Convert BmDateTime.iso8601 to a timestamp.
BmDateTime	withTimeZone(String timezone)	Convert BmDateTime from bmDateTime.timezone to timezone.

Methods inherited from class Object

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

Field Details

bmDateTime

public final BmDateTime bmDateTime

Constructor Details

BmDateTimeWrapper

public BmDateTimeWrapper(BmDateTime bmDateTime)

Method Details

create

public static BmDateTime create(String iso8601,
 String timezone,
 BmDateTime.Precision precision)

Creates a BmDateTime based on a string, a timezone and a precision.

• If precision is a BmDateTime.Precision.Date, timezone parameter ignored and null will be used.
• If timezone is null and precision is a BmDateTime.Precision.DateTime, iso8601 timezone will be used. If there is no timezone in iso8601, null will be used.

To parse iso8601 those rules will be applied in this order. With this rules applied, iso8601 will be parsed this way:

• Either iso8601 and timezone contain a tz: iso8601 will be converted to timezone
• timezone do not contain a tz and iso8601 do: tz offset will be stripped from iso8601
• timezone do contain a tz and iso8601 do not: tz offset will be added to iso8601 without conversion
• iso8601 is a BmDateTime.Precision.DateTimeand precision is BmDateTime.Precision.Date : time will be stripped from iso8601
• iso8601 is a BmDateTime.Precision.Dateand precision is BmDateTime.Precision.DateTime : time will be set to 00:00:00 at timezone offset

Parameters:

iso8601 - Iso8601 representation of a ZonedDateTime, LocalDate, LocalDateTime

timezone - ZoneId.getId() for ZonedDateTime, null for Local date or local datetime. If the timezone is not recognized, the timezone will be parsed from iso8601.

precision - BmDateTime.Precision.Date or BmDateTime.Precision.DateTime

create

public static BmDateTime create(String iso8601,
 BmDateTime.Precision precision)

Creates a BmDateTime based on a string and a precision. timezone is parsed from iso8601.

Parameters:

iso8601 - Iso8601 representation of a ZonedDateTime, LocalDate, LocalDateTime

precision - BmDateTime.Precision.Date or BmDateTime.Precision.DateTime

See Also:

• create(String, String, Precision)

create

public static BmDateTime create(String iso8601,
 String timezone)

Creates a BmDateTime based on a string and a timezone. Precision is parsed from iso8601.

Parameters:

iso8601 - Iso8601 representation of a ZonedDateTime, LocalDate, LocalDateTime

timezone - ZoneId.getId() for ZonedDateTime, null for Local date or local datetime. If the timezone is not recognized, null will be used.

See Also:

• create(String, String, Precision)

create

public static BmDateTime create(String iso8601)

Creates a BmDateTime based on a string. Precision and timezone are parsed from iso8601.

Parameters:

iso8601 - Iso8601 representation of a ZonedDateTime, LocalDate, LocalDateTime

See Also:

• create(String, String, Precision)

create

public static BmDateTime create(ZonedDateTime dateTime,
 BmDateTime.Precision precision)

Timezone will be set after ZonedDateTime.getZone().

Parameters:

dateTime -

precision - BmDateTime.Precision.Date or BmDateTime.Precision.DateTime

See Also:

• create(String, String, Precision)

create

public static BmDateTime create(LocalDate date)

Create a new BmDateTime from a LocalDate

Parameters:

date -

create

public static BmDateTime create(LocalDateTime localDateTime,
 BmDateTime.Precision precision)

Timezone will be set to UTC.

Parameters:

localDateTime -

precision - BmDateTime.Precision.Date or BmDateTime.Precision.DateTime

See Also:

• create(String, String, Precision)

copy

public BmDateTime copy(long timestamp)

Create a new BmDateTime using BmDateTime.timezone, BmDateTime.precision and timestamp.

Parameters:

timestamp -

See Also:

• fromTimestamp(long, String, Precision)

fromTimestamp

public static BmDateTime fromTimestamp(long timestamp)

Creates a BmDateTime based on a timestamp. timezone is set to UTC and precision to BmDateTime.Precision.DateTime

Parameters:

timestamp -

fromTimestamp

public static BmDateTime fromTimestamp(long timestamp,
 String timezone)

Creates a BmDateTime based on a timestamp and a timezone. precision to BmDateTime.Precision.DateTime

Parameters:

timestamp -

timezone -

fromTimestamp

public static BmDateTime fromTimestamp(long timestamp,
 String timezone,
 BmDateTime.Precision precision)

Creates a BmDateTime based on a timestamp, a timezone and a precision. timestamp will be print as iso8601 datetime. If timezone is null or timezone is invalid, the iso8601 string will be print with the UTC timezone.

Parameters:

timestamp - the milliseconds from 1970-01-01T00:00:00Z

timezone - ZoneId.getId() for ZonedDateTime, null for Local date or local datetime. If the timezone is not recognized UTC will be used.

precision - If precision is BmDateTime.Precision.Date : No timezone nor time will be printed in the iso string

See Also:

• create(String, String, Precision)

withTimeZone

public BmDateTime withTimeZone(String timezone)

Convert BmDateTime from bmDateTime.timezone to timezone. If bmDateTime.timezone is null timezone will be used without conversion. If bmDateTime.timezone is not null, bmDateTime will be converted to timezone.

Parameters:

timezone - ZoneId.getId() for ZonedDateTime, null for Local date or local datetime. If the timezone is not recognized, the default timezone ID will be used (UTC).

format

public String format(String format)

Output the BmDateTime using the specified format pattern.

Parameters:

format - the pattern specification, null means use toString

Returns:

the formatted string, not null

toIso8601

public String toIso8601()

toIso8601

public static String toIso8601(long timestamp,
 String timezone)

toDateTime

public ZonedDateTime toDateTime(String timezone)

transform the BmDateTime instance to an ZonedDateTime

Parameters:

timezone - a Fallback timezone which is used if either the instance is of precision Date, the instance contains no timezone or the timezone contained in the ISO8601 value is not valid

Returns:

the ZonedDateTime corresponding to the BmDateTime

toDateTime

public ZonedDateTime toDateTime()

transform the BmDateTime instance to an ZonedDateTime}. Uses the timezone GMT as fallback.

Returns:

the ZonedDateTime corresponding to the BmDateTime

isBefore

public boolean isBefore(BmDateTime date)

isAfter

public boolean isAfter(BmDateTime date)

containsTimeZone

public boolean containsTimeZone()

Test if BmDateTime.timezone is not null and is a valid identifier according to ZoneId.getAvailableZoneIds()

Returns:

True if BmDateTime.timezone is valid

toTimestamp

public long toTimestamp(String timezone)

If BmDateTime is a representation of a LocalDate or a LocalDateTime, timezone is used as BmDateTime.iso8601 tz

Parameters:

timezone -

Returns:

Gets the milliseconds of the BmDateTime from the Java epoch

See Also:

• toTimestamp(String, String)

toUTCTimestamp

public long toUTCTimestamp()

Convert BmDateTime.iso8601 to a timestamp. If BmDateTime is a LocalDate or a LocalDateTime, UTC timezone will be used.

Returns:

Gets the milliseconds of the BmDateTime from the Java epoch.

minus

public BmDateTime minus(TemporalAmount duration)

plus

public BmDateTime plus(TemporalAmount duration)

toTimestamp

public static long toTimestamp(String iso8601,
 String timezone)

Gets the milliseconds of the BmDateTime from the Java epoch of 1970-01-01T00:00:00Z. If BmDateTime is a LocalDate or a LocalDateTime, timezone is used for the timestamp offset. Otherwise it is ignored.

Parameters:

iso8601 - Iso8601 representation of a ZonedDateTime, LocalDate, LocalDateTime

timezone - ZoneId.getId() for ZonedDateTime. If the timezone is not recognized, the UTC timezone will be used.

toDate

public Date toDate()

Convert BmDateTime to a Date. If BmDateTime is a LocalDate or a LocalDateTime, UTC timezone will be used.

See Also:

• toUTCTimestamp()

sameRecurId

public static boolean sameRecurId(BmDateTime a,
 BmDateTime b)

Compares two recurids for occurrence identity. The timezone label is not compared: it can legitimately differ between two representations of the same occurrence (a named timezone from DB deserialization, a numeric offset extracted from an x-bm-event email header, or no timezone at all for a UTC value), while the offset actually used to resolve the instant is always embedded in BmDateTime.iso8601. Comparing the resolved instant, as toUTCTimestamp() does, is therefore correct regardless of the timezone label on either side.