Package ca.uhn.fhir.context

Enum FhirVersionEnum

java.lang.Object

java.lang.Enum<FhirVersionEnum>

ca.uhn.fhir.context.FhirVersionEnum

All Implemented Interfaces:

Serializable, Comparable<FhirVersionEnum>

public enum FhirVersionEnum
extends Enum<FhirVersionEnum>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DSTU2
DSTU2_1
DSTU2_HL7ORG
DSTU3
R4
R4B
R5

Method Summary

Modifier and Type	Method	Description
static FhirVersionEnum	determineVersionForType(Class<?> theFhirType)	Given a FHIR model object type, determine which version of FHIR it is for
static FhirVersionEnum	forVersionString(String theVersionString)	Returns the FhirVersionEnum which corresponds to a specific version of FHIR.
String	getFhirVersionString()
IFhirVersion	getVersionImplementation()
boolean	isEqualOrNewerThan(FhirVersionEnum theVersion)
boolean	isEquivalentTo(FhirVersionEnum theVersion)
boolean	isNewerThan(FhirVersionEnum theVersion)
boolean	isOlderThan(FhirVersionEnum theVersion)
boolean	isPresentOnClasspath()	Returns true if the given version is present on the classpath
boolean	isRi()	Is this version using the HL7.org RI structures?
FhirContext	newContext()	Deprecated, for removal: This API element is subject to removal in a future version. since 7.7.
FhirContext	newContextCached()	Deprecated, for removal: This API element is subject to removal in a future version. since 7.7.
static FhirVersionEnum	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FhirVersionEnum[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DSTU2

public static final FhirVersionEnum DSTU2

DSTU2_HL7ORG

public static final FhirVersionEnum DSTU2_HL7ORG

DSTU2_1

public static final FhirVersionEnum DSTU2_1

DSTU3

public static final FhirVersionEnum DSTU3

R4

public static final FhirVersionEnum R4

R4B

public static final FhirVersionEnum R4B

R5

public static final FhirVersionEnum R5

Method Details

values

public static FhirVersionEnum[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FhirVersionEnum valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getFhirVersionString

public String getFhirVersionString()

getVersionImplementation

public IFhirVersion getVersionImplementation()

isEqualOrNewerThan

public boolean isEqualOrNewerThan(FhirVersionEnum theVersion)

isEquivalentTo

public boolean isEquivalentTo(FhirVersionEnum theVersion)

isNewerThan

public boolean isNewerThan(FhirVersionEnum theVersion)

isOlderThan

public boolean isOlderThan(FhirVersionEnum theVersion)

isPresentOnClasspath

public boolean isPresentOnClasspath()

Returns true if the given version is present on the classpath

isRi

public boolean isRi()

Is this version using the HL7.org RI structures?

newContext

@Deprecated(forRemoval=true,
            since="7.7")
public FhirContext newContext()

Deprecated, for removal: This API element is subject to removal in a future version.

since 7.7. Use FhirContext.forVersion(FhirVersionEnum) instead

Creates a new FhirContext for this FHIR version

newContextCached

@Deprecated(forRemoval=true,
            since="7.7")
public FhirContext newContextCached()

Deprecated, for removal: This API element is subject to removal in a future version.

since 7.7. Use FhirContext.forCached(FhirVersionEnum) instead

Creates a new FhirContext for this FHIR version, or returns a previously created one if one exists. This method uses FhirContext.forCached(FhirVersionEnum) to return a cached instance.

determineVersionForType

public static FhirVersionEnum determineVersionForType(Class<?> theFhirType)

Given a FHIR model object type, determine which version of FHIR it is for

forVersionString

public static FhirVersionEnum forVersionString(String theVersionString)

Returns the FhirVersionEnum which corresponds to a specific version of FHIR. Partial version strings (e.g. "3.0") are acceptable. This method will also accept version names such as "DSTU2", "STU3", "R5", etc.

Returns:

Returns null if no version exists matching the given string