net.okapia.osid.primordium.calendaring.datetime.civil.JucheUTCDateTime

All Implemented Interfaces:: Serializable, Comparable<DateTime>, DateTime, OsidPrimitive, DateTime, OsidPrimitive

public final class JucheUTCDateTime extends AbstractConfigurableDateTime implements DateTime

A Juche (North Korean) date with a UTC time of day.

The date follows the JucheCalendar; the Gregorian months and leap rule, with years counted from Kim Il-sung's 1912 birth, so Juche year Y is AD Y+1911. The time of day is a UTCTime.

As with the Gregorian implementation, a granularity is valid only when this interface has an element to convey it; the grouping resolutions without an element of their own (DECADE, BLUEMOON, GLACIAL, HALF_HOUR, and QUARTER_HOUR) are rejected at construction.

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

JucheUTCDateTime.JucheUTCDateTimeFactory

The factory used to construct JucheUTCDateTimes.

static class

JucheUTCDateTime.JucheUTCDateTimeSpecifier

The specifier used to construct JucheUTCDateTimes.
Field Summary

Fields

Modifier and Type

Field

Description

protected static final Type

CALENDAR_TYPE

the OSID Type

Fields inherited from class AbstractConfigurableDateTime
GREGORIAN_REFORM, YEARS_PER_BLUEMOON

Modifier and Type

Field

Description

protected static final Instant

GREGORIAN_REFORM

the gregorian reform

static final BigDecimal

YEARS_PER_BLUEMOON

the years per bluemoon
Constructor Summary

Constructors

Constructor

Description

JucheUTCDateTime(JucheUTCDateTime.JucheUTCDateTimeSpecifier specifier)

Constructs a new JucheUTCDateTime.
Method Summary

Modifier and Type

Method

Description

static DateTime

datetime(long year)

Creates a DateTime at year resolution.

static DateTime

datetime(long year, long month)

Creates a DateTime at month resolution.

static DateTime

datetime(long year, long month, long day)

Creates a DateTime at day resolution.

static DateTime

datetime(long year, long month, long day, Time time)

Creates a DateTime at a date and time.

static DateTime

datetime(String iso)

Parses an ISO date string.

static DateTime

infinity()

Gets an infinite date.

static DateTime

iso(String iso)

Creates a DateTime from a strict ISO 8601 string.

static DateTime

unknown()

Gets an unknown date.

static DateTime

valueOf(long year)

Creates a DateTime at year resolution.

static DateTime

valueOf(long year, long month)

Creates a DateTime at month resolution.

static DateTime

valueOf(long year, long month, long day)

Creates a DateTime at day resolution.

static DateTime

valueOf(long year, long month, long day, Time time)

Creates a DateTime at a date and time.

static DateTime

valueOf(String iso)

Parses an ISO date string.

Methods inherited from class AbstractConfigurableDateTime
compare, compareTo, denormalize, equals, formatDigits, formatNumber, formatYear, fromComponents, fromInstant, fromLocalDateTime, fromOffsetDateTime, fromZonedDateTime, getDateTimeFactory, getTime, getWeek, hashCode, isExclusive, isGreater, isInclusive, isLess, minus, minus, parse, parseISO, plus, plus, requireResolution, toLocaleDateString, toLocaleTimeString, toShortLocaleDateString, toString, toTime, toTimeString

Modifier and Type

Method

Description

protected static int

compare(DateTime dt1, DateTime dt2, DateTimeFactory factory)

Compares two normalized finite datetimes.

int

compareTo(DateTime datetime)

Compares this DateTime with the specified DateTime for ordering.

final DateTimeInterval

denormalize()

Returns an interval based on this DateTime derived by its granularity and uncertainty.

final boolean

equals(Object obj)

Determines if the given Time is equal to this one.

protected static String

formatDigits(long num, int n)

Formats a number, zero-padded to a minimum number of digits.

protected static String

formatNumber(long num)

Formats a number as an ordinal (1st, 2nd, 3rd, ...).

protected static String

formatYear(long year)

Formats a year for display, zero-padded to four digits within the common range.

protected static DateTime

fromComponents(DateTimeFactory factory, long year, long month, long day, Time time)

Builds a DateTime from explicit calendar components.

protected static DateTime

fromInstant(DateTimeFactory factory, Instant instant, DateTimeResolution granularity)

Converts a Java Instant to a DateTime.

protected static DateTime

fromLocalDateTime(DateTimeFactory factory, LocalDateTime ldt, DateTimeResolution granularity)

Converts a Java LocalDateTime to a DateTime, treating the value as already in UTC.

protected static DateTime

fromOffsetDateTime(DateTimeFactory factory, OffsetDateTime odt, DateTimeResolution granularity)

Converts a Java OffsetDateTime to a DateTime, adjusting to UTC.

protected static DateTime

fromZonedDateTime(DateTimeFactory factory, ZonedDateTime zdt, DateTimeResolution granularity)

Converts a Java ZonedDateTime to a DateTime, adjusting to UTC.

protected DateTimeFactory

getDateTimeFactory()

Gets the datetime factory.

protected Time

getTime()

Gets the time component.

final long

getWeek()

Gets the week of the year, counting from one.

final int

hashCode()

Returns a hash code value for this Time based on the type, granularity and values.

final boolean

isExclusive(DateTime datetime)

Tests if the range of this DateTime, as specified by its granularity and uncertainty, does not overlap with the given DateTime.

boolean

isGreater(DateTime datetime)

Tests if this DateTime is greater than the given DateTime.

final boolean

isInclusive(DateTime datetime)

Tests if the range of this DateTime, as specified by its granularity and uncertainty, includes the given DateTime ranged by its grabularity and uncertainty.

final boolean

isLess(DateTime datetime)

Tests if this DateTime is less than the given DateTime.

DateTime

minus(long amount, DateTimeResolution unit)

Subtracts a number of a resolution's units from this datetime.

DateTime

minus(Duration duration)

Subtracts a duration from this datetime.

protected static DateTime

parse(DateTimeFactory factory, String string)

Parses the okapia-extended datetime form: a strict ISO datetime optionally trailed by an uncertainty (" ±n unit" / " +p -m unit", with an optional "exclusive"), or the standalone "?" (unknown) and "infinity".

protected static DateTime

parseISO(DateTimeFactory factory, String iso)

Parses an ISO date string.

DateTime

plus(long amount, DateTimeResolution unit)

Adds a number of a resolution's units to this datetime, in its own calendar.

DateTime

plus(Duration duration)

Adds a duration to this datetime, applying its calendar components (years, months, weeks, days) and clock components (hours, minutes, seconds) in this datetime's own calendar.

protected static void

requireResolution(DateTimeResolution granularity, DateTimeResolution floor, String source)

Verifies that a requested resolution is no finer than the source's own precision, so a conversion does not fabricate digits the source cannot supply -- e.g.

DisplayText

toLocaleDateString()

Renders the date in a long locale form using the calendar's own month names -- the Gregorian form, for example, is "January 31, 2020", and at month granularity "January 2020".

DisplayText

toLocaleTimeString()

Renders the time in a locale form.

DisplayText

toShortLocaleDateString()

Renders the date in a short locale form, abbreviating the month name -- the Gregorian form is "31 Jan 2020", and at month granularity "Jan 2020".

String

toString()

Returns a string representation of this DateTime.

Time

toTime()

Gets the time of day as a Time.

DisplayText

toTimeString()

Renders the time of day, or the empty string when this datetime has no time component (a granularity of a day or coarser).

Methods inherited from class AbstractDateTime
coarsePeriodYears, definesUncertainty, getAeon, getAttoseconds, getCalendarType, getCentury, getDay, getEpoch, getFemtoseconds, getGranularity, getGranularityMultiplier, getHour, getMicroquectoseconds, getMicroseconds, getMillennium, getMilliquectoseconds, getMilliseconds, getMinute, getMonth, getNanoseconds, getPicoseconds, getPlanckseconds, getQuectoseconds, getRontoseconds, getSecond, getTimeType, getUncertaintyMinus, getUncertaintyPlus, getUncertaintyUnits, getYear, getYoctoseconds, getZeptoseconds, isUncertaintyDateInclusive, rawDay, referenceYear

Modifier and Type

Method

Description

protected long[]

coarsePeriodYears()

Gets the first and last year of this value's coarse period.

final boolean

definesUncertainty()

Tests if uncertainty is defined for this time.

final long

getAeon()

Gets the aeon.

final long

getAttoseconds()

Gets the number of attoseconds of the femtoseconds 0-999.

final Type

getCalendarType()

Gets the calendar type.

final long

getCentury()

Gets the century.

final long

getDay()

Gets the day of the month.

final long

getEpoch()

Gets the epoch.

final long

getFemtoseconds()

Gets the number of femtoseconds of the picosecond 0-999.

final DateTimeResolution

getGranularity()

Gets the granularity of this time.

final long

getGranularityMultiplier()

If the granularity of the time equals getGranularity(), then the multiplier is 1.

final long

getHour()

Gets the hour of the day.

final long

getMicroquectoseconds()

Gets the number of undaseconds of the vatosecond 0-999.

final long

getMicroseconds()

Gets the number of microseconds of the second 0-999.

final long

getMillennium()

Gets the millennium.

final long

getMilliquectoseconds()

Gets the number of vatoseconds of the xoxxosecond 0-999.

final long

getMilliseconds()

Gets the number of milliseconds in this second 0-999.

final long

getMinute()

Gets the minute of the hour.

final long

getMonth()

Gets the month.

final long

getNanoseconds()

Gets the number of nanoseconds of the microsecond 0-999.

final long

getPicoseconds()

Gets the number of picoseconds of the nanosecond 0-999.

final long

getPlanckseconds()

Gets the number of Plancks of the vatoseconds.

final long

getQuectoseconds()

Gets the number of weebleseconds of the xoxxosecond 0-999.

final long

getRontoseconds()

Gets the number of xoxxoseconds of the yoctosecond 0-999.

final long

getSecond()

Gets the second of the minute.

final Type

getTimeType()

Gets the time type.

final long

getUncertaintyMinus()

Gets the uncertainty of this time in the negative direction.

final long

getUncertaintyPlus()

Gets the uncertainty of this time in the positive direction.

final DateTimeResolution

getUncertaintyUnits()

Gets the units of the uncertainty.

final long

getYear()

Gets the year.

final long

getYoctoseconds()

Gets the number of yoctoseconds of the picosecond 0-999.

final long

getZeptoseconds()

Gets the number of zeptoseconds of the attosecond 0-999.

boolean

isUncertaintyDateInclusive()

Tests if the uncertainty is inclusive of all dates.

protected final long

rawDay()

Gets the stored day of the month, ungated by granularity.

protected long

referenceYear()

Gets a year within this value's period, from which the coarser fields are derived.

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details
- CALENDAR_TYPE
  
  protected static final Type CALENDAR_TYPE
  
  the OSID Type
Constructor Details
- JucheUTCDateTime
  
  public JucheUTCDateTime(JucheUTCDateTime.JucheUTCDateTimeSpecifier specifier)
  
  Constructs a new JucheUTCDateTime.
  
  Parameters:
  
  specifier - a datetime specifier
  
  Throws:
  
  NullArgumentException - specifier is null
Method Details
- valueOf
  public static DateTime valueOf(String iso)
  
  Parses an ISO date string.
  
  Parameters:
  
  iso - the iso formatted string
  
  Returns:
  
  a Juche/UTC DateTime
  
  Throws:
  
  InvalidArgumentException - could not parse iso
  
  NullArgumentException - iso is null
  
  See Also:
  
  datetime(String)
- iso
  
  public static DateTime iso(String iso)
  
  Creates a DateTime from a strict ISO 8601 string. Unlike valueOf(String), an uncertainty suffix or the "?"/"infinity" forms are not accepted.
  
  Parameters:
  
  iso - a strict ISO 8601 datetime string
  
  Returns:
  
  a Juche/UTC DateTime
  
  Throws:
  
  InvalidArgumentException - cannot parse iso as a strict ISO datetime
  
  NullArgumentException - iso is null
- datetime
  public static DateTime datetime(String iso)
  
  Parses an ISO date string. Equivalent to valueOf(String).
  
  Parameters:
  
  iso - the iso formatted string
  
  Returns:
  
  a Juche/UTC DateTime
  
  Throws:
  
  InvalidArgumentException - could not parse iso
  
  NullArgumentException - iso is null
  
  See Also:
  
  valueOf(String)
- valueOf
  public static DateTime valueOf(long year)
  
  Creates a DateTime at year resolution.
  
  Parameters:
  
  year - the year
  
  Returns:
  
  a Juche/UTC DateTime
  
  Throws:
  
  InvalidArgumentException - year is invalid
  
  See Also:
  
  datetime(long)
- datetime
  public static DateTime datetime(long year)
  
  Creates a DateTime at year resolution.
  
  Parameters:
  
  year - the year
  
  Returns:
  
  a Juche/UTC DateTime
  
  Throws:
  
  InvalidArgumentException - year is invalid
  
  See Also:
  
  valueOf(long)
- valueOf
  public static DateTime valueOf(long year, long month)
  
  Creates a DateTime at month resolution.
  
  Parameters:
  
  year - the year
  
  month - the month, from 1
  
  Returns:
  
  a Juche/UTC DateTime
  
  Throws:
  
  InvalidArgumentException - a component is out of range
  
  See Also:
  
  datetime(long, long)
- datetime
  public static DateTime datetime(long year, long month)
  
  Creates a DateTime at month resolution.
  
  Parameters:
  
  year - the year
  
  month - the month, from 1
  
  Returns:
  
  a Juche/UTC DateTime
  
  Throws:
  
  InvalidArgumentException - a component is out of range
  
  See Also:
  
  valueOf(long, long)
- valueOf
  public static DateTime valueOf(long year, long month, long day)
  
  Creates a DateTime at day resolution.
  
  Parameters:
  
  year - the year
  
  month - the month, from 1
  
  day - the day, from 1
  
  Returns:
  
  a Juche/UTC DateTime
  
  Throws:
  
  InvalidArgumentException - a component is out of range
  
  See Also:
  
  datetime(long, long, long)
- datetime
  public static DateTime datetime(long year, long month, long day)
  
  Creates a DateTime at day resolution.
  
  Parameters:
  
  year - the year
  
  month - the month, from 1
  
  day - the day, from 1
  
  Returns:
  
  a Juche/UTC DateTime
  
  Throws:
  
  InvalidArgumentException - a component is out of range
  
  See Also:
  
  valueOf(long, long, long)
- valueOf
  public static DateTime valueOf(long year, long month, long day, Time time)
  
  Creates a DateTime at a date and time. The time's resolution sets the datetime's resolution.
  
  Parameters:
  
  year - the year
  
  month - the month, from 1
  
  day - the day, from 1
  
  time - the time of day (a UTC time)
  
  Returns:
  
  a Juche/UTC DateTime
  
  Throws:
  
  InvalidArgumentException - a component is out of range
  
  UnsupportedException - time is not a UTC time
  
  NullArgumentException - time is null
  
  See Also:
  
  datetime(long, long, long, org.osid.calendaring.Time)
- datetime
  public static DateTime datetime(long year, long month, long day, Time time)
  
  Creates a DateTime at a date and time. The time's resolution sets the datetime's resolution.
  
  Parameters:
  
  year - the year
  
  month - the month, from 1
  
  day - the day, from 1
  
  time - the time of day (a UTC time)
  
  Returns:
  
  a Juche/UTC DateTime
  
  Throws:
  
  InvalidArgumentException - a component is out of range
  
  UnsupportedException - time is not a UTC time
  
  NullArgumentException - time is null
  
  See Also:
  
  valueOf(long, long, long, org.osid.calendaring.Time)
- infinity
  
  public static DateTime infinity()
  
  Gets an infinite date.
  
  Returns:
  
  an infinite date
- unknown
  
  public static DateTime unknown()
  
  Gets an unknown date.
  
  Returns:
  
  an unknown date

Class JucheUTCDateTime

Nested Class Summary

Field Summary

Fields inherited from class AbstractConfigurableDateTime

Constructor Summary

Method Summary

Methods inherited from class AbstractConfigurableDateTime

Methods inherited from class AbstractDateTime

Methods inherited from class Object

Field Details

CALENDAR_TYPE

Constructor Details

JucheUTCDateTime

Method Details

valueOf

iso

datetime

valueOf

datetime

valueOf

datetime

valueOf

datetime

valueOf

datetime

infinity

unknown