Module dev.metaschema.core

Package dev.metaschema.core.metapath.item.atomic

Interface IDateTimeWithTimeZoneItem

All Superinterfaces:

IAnyAtomicItem, IAtomicValuedItem, ICalendarTemporalItem, ICollectionValue, IDateTimeItem, IItem, ITemporalItem

public interface IDateTimeWithTimeZoneItem
extends IDateTimeItem

An atomic Metapath item representing a date/time value in the Metapath system with an explicit time zone.

This interface provides functionality for handling date/time values with time zone information, supporting parsing, casting, and comparison operations. It works in conjunction with ZonedDateTime to eliminate time zone ambiguity.

Method Summary

Modifier and Type	Method	Description
static IDateTimeWithTimeZoneItem	cast(IAnyAtomicItem item)	Cast the provided type to this item type.
default IDateTimeWithTimeZoneItem	castAsType(IAnyAtomicItem item)	Cast the provided item to be the same type as this item.
default IAtomicOrUnionType<IDateTimeWithTimeZoneItem>	getType()	Get the type information for the item.
static IAtomicOrUnionType<IDateTimeWithTimeZoneItem>	type()	Get the type information for this item.
static IDateTimeWithTimeZoneItem	valueOf(String value)	Construct a new date/time item using the provided string value.
static IDateTimeWithTimeZoneItem	valueOf(ZonedDateTime value)	Construct a new date/time item using the provided value.

Methods inherited from interface dev.metaschema.core.metapath.item.atomic.IAnyAtomicItem

accept, asMapKey, asString, asStringItem, atomize, deepEquals, getJavaTypeAdapter, getValue, toAtomicItem

Methods inherited from interface dev.metaschema.core.metapath.item.atomic.ICalendarTemporalItem

asZonedDateTime, getZoneOffset

Methods inherited from interface dev.metaschema.core.metapath.item.ICollectionValue

deepEquals, toSignature

Methods inherited from interface dev.metaschema.core.metapath.item.atomic.IDateTimeItem

asDate, asDateTimeZ, asLocalDate, asLocalDateTime, asLocalTime, asOffsetTime, asTime, getDay, getHour, getMinute, getMonth, getNano, getSecond, getYear, hasDate, hasTime, normalize, replaceTimezone

Methods inherited from interface dev.metaschema.core.metapath.item.IItem

contentsAsSequence, flatten, hasValue, toSequence

Methods inherited from interface dev.metaschema.core.metapath.item.atomic.ITemporalItem

getOffset, hasTimezone

Method Details

type

@NonNull
static IAtomicOrUnionType<IDateTimeWithTimeZoneItem> type()

Get the type information for this item.

Returns:

the type information

getType

default IAtomicOrUnionType<IDateTimeWithTimeZoneItem> getType()

Description copied from interface: IItem

Get the type information for the item.

Specified by:

getType in interface IDateTimeItem

Specified by:

getType in interface IItem

Returns:

the item's type information

valueOf

@NonNull
static IDateTimeWithTimeZoneItem valueOf(@NonNull
 String value)

Construct a new date/time item using the provided string value.

Parameters:

value - a string representing a date/time

Returns:

the new item

valueOf

@NonNull
static IDateTimeWithTimeZoneItem valueOf(@NonNull
 ZonedDateTime value)

Construct a new date/time item using the provided value.

This method handles dates with explicit timezone information using ZonedDateTime. The timezone is preserved as specified in the input and is significant for date/time operations and comparisons.

Parameters:

value - a date/time, with time zone information

Returns:

the new item

cast

@NonNull
static IDateTimeWithTimeZoneItem cast(@NonNull
 IAnyAtomicItem item)

Cast the provided type to this item type.

Parameters:

item - the item to cast

Returns:

the original item if it is already this type, otherwise a new item cast to this type

Throws:

InvalidValueForCastFunctionException - if the provided item cannot be cast to this type

castAsType

default IDateTimeWithTimeZoneItem castAsType(IAnyAtomicItem item)

Description copied from interface: IAnyAtomicItem

Cast the provided item to be the same type as this item.

Specified by:

castAsType in interface IAnyAtomicItem

Specified by:

castAsType in interface IDateTimeItem

Parameters:

item - the item to cast

Returns:

an atomic item of this type