Package org.hl7.fhir.dstu3.model
Class InstantType
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Externalizable
,Serializable
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseDatatype
,org.hl7.fhir.instance.model.api.IBaseElement
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.IPrimitiveType<Date>
Represents a FHIR instant datatype. Valid precisions values for this type are:
TemporalPrecisionEnum.SECOND
TemporalPrecisionEnum.MILLI
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final ca.uhn.fhir.model.api.TemporalPrecisionEnum
The default precision for this type -
Constructor Summary
ConstructorDescriptionConstructor which creates an InstantDt with no timne value.InstantType
(String theString) Create a new InstantDt from a string valueInstantType
(Calendar theCalendar) Create a new DateTimeDtInstantType
(Date theDate) Create a new DateTimeDt with the given date/time andTemporalPrecisionEnum.MILLI
precisionInstantType
(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision) Constructor which accepts a date value and a precision value.InstantType
(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision, TimeZone theTimezone) Create a new instance using the given date, precision level, and time zoneInstantType
(BaseDateTimeType theDateTime) Create a new DateTimeDt using an existing value. -
Method Summary
Modifier and TypeMethodDescriptionboolean
InvokesDate.after(Date)
on the contained Date against the given dateboolean
InvokesDate.before(Date)
on the contained Date against the given datecopy()
fhirType()
protected ca.uhn.fhir.model.api.TemporalPrecisionEnum
Returns the default precision for this datatypestatic InstantType
now()
Returns a new instance of DateTimeType with the current system time and MILLI precision and the system local time zonestatic InstantType
Creates a new instance by parsing an HL7 v3 format date time stringvoid
Sets the value of this instant to the current time (from the system clock) and the local/default timezone (as retrieved usingTimeZone.getDefault()
.static InstantType
Factory method which creates a new InstantDt with millisecond precision and initializes it with the current time and the system local timezone.Methods inherited from class org.hl7.fhir.dstu3.model.BaseDateTimeType
add, after, before, encode, getDay, getHour, getMillis, getMinute, getMonth, getNanos, getPrecision, getSecond, getTimeZone, getValueAsCalendar, getValueAsString, getYear, isTimeZoneZulu, isToday, parse, setDay, setHour, setMillis, setMinute, setMonth, setNanos, setPrecision, setSecond, setTimeZone, setTimeZoneZulu, setValue, setValue, setValueAsString, setValueAsV3String, setYear, toCalendar, toHumanDisplay, toHumanDisplayLocalTimezone
Methods inherited from class org.hl7.fhir.dstu3.model.PrimitiveType
asStringValue, equalsDeep, equalsShallow, fromStringValue, getProperty, getValue, getValueAsString, hashCode, hasPrimitiveValue, hasValue, isEmpty, isPrimitive, primitiveValue, readExternal, setProperty, setProperty, toString, typedCopy, updateStringValue, writeExternal
Methods inherited from class org.hl7.fhir.dstu3.model.Element
addChild, addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, getNamedProperty, getTypesForProperty, hasExtension, hasExtension, hasId, hasIdElement, listChildren, makeProperty, setExtension, setId, setIdBase, setIdElement
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isResource, listChildrenByName, listChildrenByName, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions
addExtension, getExtension, hasExtension
-
Field Details
-
DEFAULT_PRECISION
The default precision for this type
-
-
Constructor Details
-
InstantType
public InstantType()Constructor which creates an InstantDt with no timne value. Note that unlike the default constructor for the JavaDate
orCalendar
objects, this constructor does not initialize the object with the current time.- See Also:
-
InstantType
Create a new DateTimeDt -
InstantType
public InstantType(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision, TimeZone theTimezone) Create a new instance using the given date, precision level, and time zone- Throws:
DataFormatException
- If the specified precision is not allowed for this type
-
InstantType
Create a new DateTimeDt using an existing value. Use this constructor with caution, as it may create more precision than warranted (since for example it is possible to pass in a DateTime with only a year, and this constructor will convert to an InstantDt with milliseconds precision). -
InstantType
Create a new DateTimeDt with the given date/time andTemporalPrecisionEnum.MILLI
precision -
InstantType
Constructor which accepts a date value and a precision value. Valid precisions values for this type are:TemporalPrecisionEnum.SECOND
TemporalPrecisionEnum.MILLI
-
InstantType
Create a new InstantDt from a string value- Parameters:
theString
- The string representation of the string. Must be in a valid format according to the FHIR specification- Throws:
DataFormatException
-
-
Method Details
-
after
InvokesDate.after(Date)
on the contained Date against the given date- Throws:
NullPointerException
- If thecontained Date
is null
-
before
InvokesDate.before(Date)
on the contained Date against the given date- Throws:
NullPointerException
- If thecontained Date
is null
-
setToCurrentTimeInLocalTimeZone
Sets the value of this instant to the current time (from the system clock) and the local/default timezone (as retrieved usingTimeZone.getDefault()
. This TimeZone is generally obtained from the underlying OS. -
withCurrentTime
Factory method which creates a new InstantDt with millisecond precision and initializes it with the current time and the system local timezone. -
getDefaultPrecisionForDatatype
Returns the default precision for this datatype- Specified by:
getDefaultPrecisionForDatatype
in classBaseDateTimeType
- See Also:
-
copy
- Specified by:
copy
in classPrimitiveType<Date>
-
now
Returns a new instance of DateTimeType with the current system time and MILLI precision and the system local time zone -
parseV3
Creates a new instance by parsing an HL7 v3 format date time string -
fhirType
-