ca.uhn.fhir.model.primitive

Class DateTimeDt

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.api.BasePrimitive<Date>

ca.uhn.fhir.model.primitive.BaseDateTimeDt

ca.uhn.fhir.model.primitive.DateTimeDt

All Implemented Interfaces:

IDatatype, IElement, IIdentifiableElement, IPrimitiveDatatype<Date>, ISupportsUndeclaredExtensions, Externalizable, Serializable, IBase, IBaseDatatype, IPrimitiveType<Date>

public class DateTimeDt
extends BaseDateTimeDt

Represents a FHIR dateTime datatype. Valid precisions values for this type are:

• TemporalPrecisionEnum.YEAR
• TemporalPrecisionEnum.MONTH
• TemporalPrecisionEnum.DAY
• TemporalPrecisionEnum.SECOND
• TemporalPrecisionEnum.MILLI

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static TemporalPrecisionEnum	DEFAULT_PRECISION The default precision for this type

Constructor Summary

Constructors

Constructor and Description
DateTimeDt() Constructor
DateTimeDt(Date theDate) Create a new DateTimeDt with seconds precision and the local time zone
DateTimeDt(Date theDate, TemporalPrecisionEnum thePrecision) Constructor which accepts a date value and a precision value.
DateTimeDt(Date theDate, TemporalPrecisionEnum thePrecision, TimeZone theTimezone) Constructor which accepts a date value, precision value, and time zone.
DateTimeDt(String theValue) Create a new instance using a string date/time

Method Summary

Modifier and Type	Method and Description
protected TemporalPrecisionEnum	getDefaultPrecisionForDatatype() Returns the default precision for this datatype
protected boolean	isPrecisionAllowed(TemporalPrecisionEnum thePrecision) To be implemented by subclasses to indicate whether the given precision is allowed by this type
static DateTimeDt	withCurrentTime() Returns a new instance of DateTimeDt with the current system time and SECOND precision and the system local time zone

Methods inherited from class ca.uhn.fhir.model.primitive.BaseDateTimeDt

encode, getDay, getHour, getMillis, getMinute, getMonth, getNanos, getPrecision, getSecond, getTimeZone, getValueAsCalendar, getYear, isTimeZoneZulu, isToday, parse, setDay, setHour, setMillis, setMinute, setMonth, setNanos, setPrecision, setSecond, setTimeZone, setTimeZoneZulu, setValue, setValue, setValueAsString, setYear, toHumanDisplay, toHumanDisplayLocalTimezone

Methods inherited from class ca.uhn.fhir.model.api.BasePrimitive

equals, getValue, getValueAsString, hashCode, hasValue, isEmpty, readExternal, toString, updateStringValue, writeExternal

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

getElementSpecificId, getId, setElementSpecificId, setId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, hasFormatComment, isBaseEmpty

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

fhirType, getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Field Detail

DEFAULT_PRECISION

public static final TemporalPrecisionEnum DEFAULT_PRECISION

The default precision for this type

Constructor Detail

DateTimeDt

public DateTimeDt()

Constructor

DateTimeDt

public DateTimeDt(Date theDate)

Create a new DateTimeDt with seconds precision and the local time zone

DateTimeDt

public DateTimeDt(Date theDate,
                  TemporalPrecisionEnum thePrecision)

Constructor which accepts a date value and a precision value. Valid precisions values for this type are:

• TemporalPrecisionEnum.YEAR
• TemporalPrecisionEnum.MONTH
• TemporalPrecisionEnum.DAY
• TemporalPrecisionEnum.SECOND
• TemporalPrecisionEnum.MILLI

Throws:

DataFormatException - If the specified precision is not allowed for this type

DateTimeDt

public DateTimeDt(String theValue)

Create a new instance using a string date/time

Throws:

DataFormatException - If the specified precision is not allowed for this type

DateTimeDt

public DateTimeDt(Date theDate,
                  TemporalPrecisionEnum thePrecision,
                  TimeZone theTimezone)

Constructor which accepts a date value, precision value, and time zone. Valid precisions values for this type are:

• TemporalPrecisionEnum.YEAR
• TemporalPrecisionEnum.MONTH
• TemporalPrecisionEnum.DAY
• TemporalPrecisionEnum.SECOND
• TemporalPrecisionEnum.MILLI

Method Detail

isPrecisionAllowed

protected boolean isPrecisionAllowed(TemporalPrecisionEnum thePrecision)

Description copied from class: BaseDateTimeDt

To be implemented by subclasses to indicate whether the given precision is allowed by this type

Specified by:

isPrecisionAllowed in class BaseDateTimeDt

withCurrentTime

public static DateTimeDt withCurrentTime()

Returns a new instance of DateTimeDt with the current system time and SECOND precision and the system local time zone

getDefaultPrecisionForDatatype

protected TemporalPrecisionEnum getDefaultPrecisionForDatatype()

Returns the default precision for this datatype

Specified by:

getDefaultPrecisionForDatatype in class BaseDateTimeDt

See Also:

DEFAULT_PRECISION