public interface ChronoDisplay
Represents a view on a set of chronological elements associated with their temporal values.
A ChronoDisplay serves mainly for formatted output.
| Modifier and Type | Method and Description |
|---|---|
boolean |
contains(ChronoElement<?> element)
Queries if the value for given chronological element can be
accessed via
get(element). |
<V> V |
get(ChronoElement<V> element)
Returns the partial value associated with given chronological
element.
|
<V> V |
getMaximum(ChronoElement<V> element)
Yields the maximum value of given chronological element in the
current context of this object.
|
<V> V |
getMinimum(ChronoElement<V> element)
Yields the minimum value of given chronological element in the
current context of this object.
|
TZID |
getTimezone()
Returns the associated timezone ID for display purposes
if available.
|
boolean |
hasTimezone()
Queries if this object contains a timezone for display purposes.
|
boolean contains(ChronoElement<?> element)
Queries if the value for given chronological element can be
accessed via get(element).
If the argument is missing then this method will yield false.
Note: Elements which are not registered but define a suitable rule
are also accessible.
element - chronological element to be asked (optional)true if the method get(ChronoElement) can
be called without exception else falseget(ChronoElement)<V> V get(ChronoElement<V> element)
Returns the partial value associated with given chronological element.
V - generic type of element valueelement - element which has the valuenull)ChronoException - if the element is not registered and there
is no element rule for evaluating the valuecontains(ChronoElement)<V> V getMinimum(ChronoElement<V> element)
Yields the minimum value of given chronological element in the current context of this object.
The definition of a minimum and a maximum does generally not imply that every intermediate value between minimum and maximum is valid in this context. For example in the timezone Europe/Berlin the hour [T02:00] will be invalid if switching to summer time.
In most cases the minimum value is not dependent on this context.
V - generic type of element valueelement - element whose minimum value is to be evaluatedChronoException - if the element is not registered and there
is no element rule for getting the minimum valueChronoElement.getDefaultMinimum(),
getMaximum(ChronoElement)<V> V getMaximum(ChronoElement<V> element)
Yields the maximum value of given chronological element in the current context of this object.
Maximum values are different from minimum case often dependent
on the context. An example is the element SECOND_OF_MINUTE whose
maximum is normally 59 but can differ in UTC-context with
leap seconds. Another more common example is the maximum of the
element DAY_OF_MONTH (28-31) which is dependent on the month and year
of this context (leap years!).
Note: In timezone-related timestamps possible offset jumps inducing gaps on the local timeline will be conserved. That means that minimum and maximum do not guarantee a continuum of valid intermediate values.
V - generic type of element valueelement - element whose maximum value is to be evaluatedChronoException - if the element is not registered and there
is no element rule for getting the maximum valueChronoElement.getDefaultMaximum(),
getMinimum(ChronoElement)boolean hasTimezone()
Queries if this object contains a timezone for display purposes.
true if a timezone is available and can be achieved
with getTimezone() else falseTZID getTimezone()
Returns the associated timezone ID for display purposes if available.
Note: Although global types like Moment indeed have a
timezone reference (namely UTC+00:00), such types will not support
formatted output without explicitly giving a timezone for display
purposes. Therefore calling this method on global types will throw
an exception. This method is not just about any timezone reference
but a timezone designed for display purposes.
ChronoException - if the timezone is not availablehasTimezone()