Package com.ibm.fhir.schema.control
Enum FhirSchemaVersion
- java.lang.Object
-
- java.lang.Enum<FhirSchemaVersion>
-
- com.ibm.fhir.schema.control.FhirSchemaVersion
-
- All Implemented Interfaces:
Serializable
,Comparable<FhirSchemaVersion>
public enum FhirSchemaVersion extends Enum<FhirSchemaVersion>
Tracks the incremental changes to the FHIR schema as it evolves. Incremental changes to the schema should be recorded here to create a new version number and this enum can then be used to identify the schema objects associated with a particular version.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDescription()
Getter for the text description of the schema changestatic FhirSchemaVersion
valueOf(String name)
Returns the enum constant of this type with the specified name.static FhirSchemaVersion[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.int
vid()
Getter for the version number used by VERSION_HISTORY.
-
-
-
Enum Constant Detail
-
V0001
public static final FhirSchemaVersion V0001
-
V0002
public static final FhirSchemaVersion V0002
-
V0003
public static final FhirSchemaVersion V0003
-
V0004
public static final FhirSchemaVersion V0004
-
V0005
public static final FhirSchemaVersion V0005
-
-
Method Detail
-
values
public static FhirSchemaVersion[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (FhirSchemaVersion c : FhirSchemaVersion.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static FhirSchemaVersion 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 nameNullPointerException
- if the argument is null
-
vid
public int vid()
Getter for the version number used by VERSION_HISTORY. We use vid here as a short name to improve readability where this value is used- Returns:
-
getDescription
public String getDescription()
Getter for the text description of the schema change- Returns:
-
-