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

All Implemented Interfaces:

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

Direct Known Subclasses:

DateDt, DateParam.DateParamDateTimeHolder, DateTimeDt, InstantDt
```
public abstract class BaseDateTimeDt
extends BasePrimitive<Date>
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static String NOW_DATE_CONSTANT

static String TODAY_DATE_CONSTANT

Constructor Summary

Constructors
Constructor	Description
`BaseDateTimeDt()`	Constructor
`BaseDateTimeDt(String theString)`	Constructor
`BaseDateTimeDt(Date theDate, TemporalPrecisionEnum thePrecision)`	Constructor
`BaseDateTimeDt(Date theDate, TemporalPrecisionEnum thePrecision, TimeZone theTimeZone)`	Constructor

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`encode(Date theValue)`	Subclasses must override to convert a "coerced" value into an encoded one.
`Integer`	`getDay()`	Returns the month with 1-index, e.g.
`protected abstract TemporalPrecisionEnum`	`getDefaultPrecisionForDatatype()`	Returns the default precision for the given datatype
`Integer`	`getHour()`	Returns the hour of the day in a 24h clock, e.g.
`Integer`	`getMillis()`	Returns the milliseconds within the current second.
`Integer`	`getMinute()`	Returns the minute of the hour in the range 0-59
`Integer`	`getMonth()`	Returns the month with 0-index, e.g.
`Long`	`getNanos()`	Returns the nanoseconds within the current second
`TemporalPrecisionEnum`	`getPrecision()`	Gets the precision for this datatype (using the default for the given type if not set)
`Integer`	`getSecond()`	Returns the second of the minute in the range 0-59
`TimeZone`	`getTimeZone()`	Returns the TimeZone associated with this dateTime's value.
`GregorianCalendar`	`getValueAsCalendar()`	Returns the value of this object as a `GregorianCalendar`
`Integer`	`getYear()`	Returns the year, e.g.
`protected abstract boolean`	`isPrecisionAllowed(TemporalPrecisionEnum thePrecision)`	To be implemented by subclasses to indicate whether the given precision is allowed by this type
`boolean`	`isTimeZoneZulu()`	Returns true if the timezone is set to GMT-0:00 (Z)
`boolean`	`isToday()`	Returns `true` if this object represents a date that is today's date
`protected Date`	`parse(String theValue)`	Subclasses must override to convert an encoded representation of this datatype into a "coerced" one
`BaseDateTimeDt`	`setDay(int theDay)`	Sets the month with 1-index, e.g.
`BaseDateTimeDt`	`setHour(int theHour)`	Sets the hour of the day in a 24h clock, e.g.
`BaseDateTimeDt`	`setMillis(int theMillis)`	Sets the milliseconds within the current second.
`BaseDateTimeDt`	`setMinute(int theMinute)`	Sets the minute of the hour in the range 0-59
`BaseDateTimeDt`	`setMonth(int theMonth)`	Sets the month with 0-index, e.g.
`BaseDateTimeDt`	`setNanos(long theNanos)`	Sets the nanoseconds within the current second
`BaseDateTimeDt`	`setPrecision(TemporalPrecisionEnum thePrecision)`	Sets the precision for this datatype
`BaseDateTimeDt`	`setSecond(int theSecond)`	Sets the second of the minute in the range 0-59
`BaseDateTimeDt`	`setTimeZone(TimeZone theTimeZone)`
`BaseDateTimeDt`	`setTimeZoneZulu(boolean theTimeZoneZulu)`
`BaseDateTimeDt`	`setValue(Date theValue)`	Sets the value for this type using the given Java Date object as the time, and using the default precision for this datatype (unless the precision is already set), as well as the local timezone as determined by the local operating system.
`void`	`setValue(Date theValue, TemporalPrecisionEnum thePrecision)`	Sets the value for this type using the given Java Date object as the time, and using the specified precision, as well as the local timezone as determined by the local operating system.
`void`	`setValueAsString(String theValue)`
`BaseDateTimeDt`	`setYear(int theYear)`	Sets the year, e.g.
`String`	`toHumanDisplay()`	Returns a human readable version of this date/time using the system local format.
`String`	`toHumanDisplayLocalTimezone()`	Returns a human readable version of this date/time using the system local format, converted to the local timezone if neccesary.

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, getUserData, hasFormatComment, isBaseEmpty, setUserData

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, getUserData, hasFormatComment, setUserData

- Field Detail
  - NOW_DATE_CONSTANT
```
public static final String NOW_DATE_CONSTANT
```
    See Also:
    
    Constant Field Values
  - TODAY_DATE_CONSTANT
```
public static final String TODAY_DATE_CONSTANT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BaseDateTimeDt
```
public BaseDateTimeDt()
```
    Constructor
  - BaseDateTimeDt
```
public BaseDateTimeDt(Date theDate,
                      TemporalPrecisionEnum thePrecision)
```
    Constructor
    
    Throws:
    
    DataFormatException - If the specified precision is not allowed for this type
  - BaseDateTimeDt
```
public BaseDateTimeDt(Date theDate,
                      TemporalPrecisionEnum thePrecision,
                      TimeZone theTimeZone)
```
    Constructor
  - BaseDateTimeDt
```
public BaseDateTimeDt(String theString)
```
    Constructor
    
    Throws:
    
    DataFormatException - If the specified precision is not allowed for this type
- Method Detail
  - encode
```
protected String encode(Date theValue)
```
    Description copied from class: BasePrimitive
    
    Subclasses must override to convert a "coerced" value into an encoded one.
    
    Specified by:
    
    encode in class BasePrimitive<Date>
    
    Parameters:
    
    theValue - Will not be null
    
    Returns:
    
    May return null if the value does not correspond to anything
  - getDay
```
public Integer getDay()
```
    Returns the month with 1-index, e.g. 1=the first day of the month
  - getDefaultPrecisionForDatatype
```
protected abstract TemporalPrecisionEnum getDefaultPrecisionForDatatype()
```
    Returns the default precision for the given datatype
  - getHour
```
public Integer getHour()
```
    Returns the hour of the day in a 24h clock, e.g. 13=1pm
  - getMillis
```
public Integer getMillis()
```
    Returns the milliseconds within the current second.
    Note that this method returns the same value as getNanos() but with less precision.
  - getMinute
```
public Integer getMinute()
```
    Returns the minute of the hour in the range 0-59
  - getMonth
```
public Integer getMonth()
```
    Returns the month with 0-index, e.g. 0=January
  - getNanos
```
public Long getNanos()
```
    Returns the nanoseconds within the current second
    Note that this method returns the same value as getMillis() but with more precision.
  - getPrecision
```
public TemporalPrecisionEnum getPrecision()
```
    Gets the precision for this datatype (using the default for the given type if not set)
    
    See Also:
    
    setPrecision(TemporalPrecisionEnum)
  - getSecond
```
public Integer getSecond()
```
    Returns the second of the minute in the range 0-59
  - getTimeZone
```
public TimeZone getTimeZone()
```
    Returns the TimeZone associated with this dateTime's value. May return null if no timezone was supplied.
  - getValueAsCalendar
```
public GregorianCalendar getValueAsCalendar()
```
    Returns the value of this object as a GregorianCalendar
  - getYear
```
public Integer getYear()
```
    Returns the year, e.g. 2015
  - isPrecisionAllowed
```
protected abstract boolean isPrecisionAllowed(TemporalPrecisionEnum thePrecision)
```
    To be implemented by subclasses to indicate whether the given precision is allowed by this type
  - isTimeZoneZulu
```
public boolean isTimeZoneZulu()
```
    Returns true if the timezone is set to GMT-0:00 (Z)
  - isToday
```
public boolean isToday()
```
    Returns true if this object represents a date that is today's date
    
    Throws:
    
    NullPointerException - if BasePrimitive.getValue() returns null
  - parse
```
protected Date parse(String theValue)
              throws DataFormatException
```
    Description copied from class: BasePrimitive
    
    Subclasses must override to convert an encoded representation of this datatype into a "coerced" one
    
    Specified by:
    
    parse in class BasePrimitive<Date>
    
    Parameters:
    
    theValue - Will not be null
    
    Returns:
    
    May return null if the value does not correspond to anything
    
    Throws:
    
    DataFormatException
  - setDay
```
public BaseDateTimeDt setDay(int theDay)
```
    Sets the month with 1-index, e.g. 1=the first day of the month
  - setHour
```
public BaseDateTimeDt setHour(int theHour)
```
    Sets the hour of the day in a 24h clock, e.g. 13=1pm
  - setMillis
```
public BaseDateTimeDt setMillis(int theMillis)
```
    Sets the milliseconds within the current second.
    Note that this method sets the same value as setNanos(long) but with less precision.
  - setMinute
```
public BaseDateTimeDt setMinute(int theMinute)
```
    Sets the minute of the hour in the range 0-59
  - setMonth
```
public BaseDateTimeDt setMonth(int theMonth)
```
    Sets the month with 0-index, e.g. 0=January
  - setNanos
```
public BaseDateTimeDt setNanos(long theNanos)
```
    Sets the nanoseconds within the current second
    Note that this method sets the same value as setMillis(int) but with more precision.
  - setPrecision
```
public BaseDateTimeDt setPrecision(TemporalPrecisionEnum thePrecision)
                            throws DataFormatException
```
    Sets the precision for this datatype
    
    Throws:
    
    DataFormatException
  - setSecond
```
public BaseDateTimeDt setSecond(int theSecond)
```
    Sets the second of the minute in the range 0-59
  - setTimeZone
```
public BaseDateTimeDt setTimeZone(TimeZone theTimeZone)
```
  - setTimeZoneZulu
```
public BaseDateTimeDt setTimeZoneZulu(boolean theTimeZoneZulu)
```
  - setValue
```
public BaseDateTimeDt setValue(Date theValue)
```
    Sets the value for this type using the given Java Date object as the time, and using the default precision for this datatype (unless the precision is already set), as well as the local timezone as determined by the local operating system. Both of these properties may be modified in subsequent calls if neccesary.
    
    Specified by:
    
    setValue in interface IPrimitiveDatatype<Date>
    
    Specified by:
    
    setValue in interface IPrimitiveType<Date>
    
    Overrides:
    
    setValue in class BasePrimitive<Date>
  - setValue
```
public void setValue(Date theValue,
                     TemporalPrecisionEnum thePrecision)
              throws DataFormatException
```
    Sets the value for this type using the given Java Date object as the time, and using the specified precision, as well as the local timezone as determined by the local operating system. Both of these properties may be modified in subsequent calls if neccesary.
    
    Parameters:
    
    theValue - The date value
    
    thePrecision - The precision
    
    Throws:
    
    DataFormatException
  - setValueAsString
```
public void setValueAsString(String theValue)
                      throws DataFormatException
```
    Specified by:
    
    setValueAsString in interface IPrimitiveDatatype<Date>
    
    Specified by:
    
    setValueAsString in interface IPrimitiveType<Date>
    
    Overrides:
    
    setValueAsString in class BasePrimitive<Date>
    
    Throws:
    
    DataFormatException
  - setYear
```
public BaseDateTimeDt setYear(int theYear)
```
    Sets the year, e.g. 2015
  - toHumanDisplay
```
public String toHumanDisplay()
```
    Returns a human readable version of this date/time using the system local format.
    Note on time zones: This method renders the value using the time zone that is contained within the value. For example, if this date object contains the value "2012-01-05T12:00:00-08:00", the human display will be rendered as "12:00:00" even if the application is being executed on a system in a different time zone. If this behaviour is not what you want, use toHumanDisplayLocalTimezone() instead.
  - toHumanDisplayLocalTimezone
```
public String toHumanDisplayLocalTimezone()
```
    Returns a human readable version of this date/time using the system local format, converted to the local timezone if neccesary.
    
    See Also:
    
    for a method which does not convert the time to the local timezone before rendering it.

Modifier and Type	Field	Description
`static String`	`NOW_DATE_CONSTANT`
`static String`	`TODAY_DATE_CONSTANT`

Class BaseDateTimeDt

Field Summary

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

Field Detail

NOW_DATE_CONSTANT

TODAY_DATE_CONSTANT

Constructor Detail

BaseDateTimeDt

BaseDateTimeDt

BaseDateTimeDt

BaseDateTimeDt

Method Detail

encode

getDay

getDefaultPrecisionForDatatype

getHour

getMillis

getMinute

getMonth

getNanos

getPrecision

getSecond

getTimeZone

getValueAsCalendar

getYear

isPrecisionAllowed

isTimeZoneZulu

isToday

parse

setDay

setHour

setMillis

setMinute

setMonth

setNanos

setPrecision

setSecond

setTimeZone

setTimeZoneZulu

setValue

setValue

setValueAsString

setYear

toHumanDisplay

toHumanDisplayLocalTimezone