Module dev.metaschema.core

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

Interface IDateWithTimeZoneItem

All Superinterfaces:

IAnyAtomicItem, IAtomicValuedItem, ICalendarTemporalItem, ICollectionValue, IDateItem, IItem, ITemporalItem

public interface IDateWithTimeZoneItem
extends IDateItem

An atomic Metapath item containing a date data value that has an explicit timezone.

Method Summary

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

getZoneOffset

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

deepEquals, toSignature

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

asDateTime, asLocalDate, asZonedDateTime, getDay, getHour, getMinute, getMonth, getNano, getSecond, getYear, hasDate, hasTime, 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<IDateWithTimeZoneItem> type()

Get the type information for this item.

Returns:

the type information

getType

default IAtomicOrUnionType<IDateWithTimeZoneItem> getType()

Description copied from interface: IItem

Get the type information for the item.

Specified by:

getType in interface IDateItem

Specified by:

getType in interface IItem

Returns:

the item's type information

valueOf

@NonNull
static IDateWithTimeZoneItem valueOf(@NonNull
 String value)

Construct a new date item using the provided string value.

Parameters:

value - a string representing a date

Returns:

the new item

valueOf

@NonNull
static IDateWithTimeZoneItem valueOf(@NonNull
 ZonedDateTime value)

Construct a new date item using the provided value.

Parameters:

value - a date, with time zone information

Returns:

the new item

cast

@NonNull
static IDateWithTimeZoneItem 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 IDateWithTimeZoneItem 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 IDateItem

Parameters:

item - the item to cast

Returns:

an atomic item of this type