Package org.hl7.fhir.r5.model

Class Enumeration<T extends Enum<?>>

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.DataType

org.hl7.fhir.r5.model.PrimitiveType<T>

org.hl7.fhir.r5.model.Enumeration<T>

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.IBaseEnumeration<T>, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IPrimitiveType<T>, ICoding

public class Enumeration<T extends Enum<?>>
extends PrimitiveType<T>
implements org.hl7.fhir.instance.model.api.IBaseEnumeration<T>, ICoding

Primitive type "code" in FHIR, where the code is tied to an enumerated list of possible values

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields inherited from class org.hl7.fhir.r5.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
Enumeration()	Deprecated. This no-arg constructor is provided for serialization only - Do not use
Enumeration(EnumFactory<T> theEnumFactory)	Constructor
Enumeration(EnumFactory<T> theEnumFactory, String theValue)	Constructor
Enumeration(EnumFactory<T> theEnumFactory, CodeType source)	Constructor
Enumeration(EnumFactory<T> theEnumFactory, T theValue)	Constructor
Enumeration(EnumFactory<T> theEnumFactory, T theValue, Element source)	Constructor

Method Summary

Modifier and Type	Method	Description
Enumeration<T>	copy()
protected String	encode(T theValue)	Subclasses must override to convert a "coerced" value into an encoded one.
String	fhirType()
String	getCode()
CodeType	getCodeType()
String	getDisplay()
EnumFactory<T>	getEnumFactory()	Provides the enum factory which binds this enumeration to a specific ValueSet
String	getSystem()
String	getVersion()
boolean	hasCode()
boolean	hasDisplay()
boolean	hasSystem()
boolean	hasVersion()
protected T	parse(String theValue)	Subclasses must override to convert an encoded representation of this datatype into a "coerced" one
void	readExternal(ObjectInput theIn)
boolean	supportsDisplay()
boolean	supportsVersion()
String	toSystem()
void	writeExternal(ObjectOutput theOut)

Methods inherited from class org.hl7.fhir.r5.model.PrimitiveType

asStringValue, canHavePrimitiveValue, equalsDeep, equalsShallow, forceStringValue, fpValue, fromStringValue, getProperty, getTypesForProperty, getValue, getValueAsString, hashCode, hasPrimitiveValue, hasValue, isEmpty, isPrimitive, makeProperty, matches, primitiveValue, removeChild, setProperty, setProperty, setValue, setValueAsString, toString, typedCopy, updateStringValue

Methods inherited from class org.hl7.fhir.r5.model.DataType

copyValues, getTranslation, isTranslatable

Methods inherited from class org.hl7.fhir.r5.model.Element

addChild, addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getNamedProperty, getStandardsStatus, hasExtension, hasExtension, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, listChildren, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

Methods inherited from class org.hl7.fhir.r5.model.Base

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isResource, listChildrenByName, listChildrenByName, setCopyUserData, 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, isEmpty, 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

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

getValue, getValueAsString, hasValue, setValue, setValueAsString

Constructor Details

Enumeration

@Deprecated
public Enumeration()

Deprecated.

This no-arg constructor is provided for serialization only - Do not use

Constructor

Enumeration

public Enumeration(EnumFactory<T> theEnumFactory)

Constructor

Enumeration

public Enumeration(EnumFactory<T> theEnumFactory,
 String theValue)

Constructor

Enumeration

public Enumeration(EnumFactory<T> theEnumFactory,
 T theValue)

Constructor

Enumeration

public Enumeration(EnumFactory<T> theEnumFactory,
 T theValue,
 Element source)

Constructor

Enumeration

public Enumeration(EnumFactory<T> theEnumFactory,
 CodeType source)

Constructor

Method Details

copy

public Enumeration<T> copy()

Specified by:

copy in class PrimitiveType<T extends Enum<?>>

encode

protected String encode(T theValue)

Description copied from class: PrimitiveType

Subclasses must override to convert a "coerced" value into an encoded one.

Specified by:

encode in class PrimitiveType<T extends Enum<?>>

Parameters:

theValue - Will not be null

Returns:

May return null if the value does not correspond to anything

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DataType

Returns:

the FHIR type name of the instance (not the java class name)

getEnumFactory

public EnumFactory<T> getEnumFactory()

Provides the enum factory which binds this enumeration to a specific ValueSet

Specified by:

getEnumFactory in interface org.hl7.fhir.instance.model.api.IBaseEnumeration<T extends Enum<?>>

parse

protected T parse(String theValue)

Description copied from class: PrimitiveType

Subclasses must override to convert an encoded representation of this datatype into a "coerced" one

Specified by:

parse in class PrimitiveType<T extends Enum<?>>

Parameters:

theValue - Will not be null

Returns:

May return null if the value does not correspond to anything

readExternal

public void readExternal(ObjectInput theIn)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class PrimitiveType<T extends Enum<?>>

Throws:

IOException

ClassNotFoundException

toSystem

public String toSystem()

writeExternal

public void writeExternal(ObjectOutput theOut)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class PrimitiveType<T extends Enum<?>>

Throws:

IOException

getSystem

public String getSystem()

Specified by:

getSystem in interface ICoding

hasSystem

public boolean hasSystem()

Specified by:

hasSystem in interface ICoding

getVersion

public String getVersion()

Specified by:

getVersion in interface ICoding

hasVersion

public boolean hasVersion()

Specified by:

hasVersion in interface ICoding

supportsVersion

public boolean supportsVersion()

Specified by:

supportsVersion in interface ICoding

getCode

public String getCode()

Specified by:

getCode in interface ICoding

hasCode

public boolean hasCode()

Specified by:

hasCode in interface ICoding

getDisplay

public String getDisplay()

Specified by:

getDisplay in interface ICoding

hasDisplay

public boolean hasDisplay()

Specified by:

hasDisplay in interface ICoding

supportsDisplay

public boolean supportsDisplay()

Specified by:

supportsDisplay in interface ICoding

getCodeType

public CodeType getCodeType()