Package org.projecthusky.fhir.emed.ch.common.enums

Enum Class CommonLanguages

java.lang.Object

java.lang.Enum<CommonLanguages>

org.projecthusky.fhir.emed.ch.common.enums.CommonLanguages

All Implemented Interfaces:

Serializable, Comparable<CommonLanguages>, Constable, CodedMetadataEnumInterface, TranslatedEnumInterface, ValueSetEnumInterface

public enum CommonLanguages
extends Enum<CommonLanguages>
implements ValueSetEnumInterface

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CODE_SYSTEM_ID	Identifier of the code system (all values share the same).
static final String	VALUE_SET_NAME	Name of the value set.

Method Summary

Modifier and Type	Method	Description
@NonNull String	getCodeSystemId()	Gets the code system identifier.
@NonNull String	getCodeSystemName()	Gets the code system name.
@NonNull String	getCodeValue()	Gets the code value as a string.
@NonNull String	getDisplayName(@Nullable LanguageCode languageCode)	Gets the display name defined by the language param.
static @Nullable CommonLanguages	getEnum(@Nullable String code)	Gets the Enum with a given code.
@NonNull String	getValueSetId()	Gets the value set identifier.
@NonNull String	getValueSetName()	Gets the value set name.
static boolean	isEnumOfValueSet(@Nullable String enumName)	Checks if a given enum is part of this value set.
static boolean	isInValueSet(@Nullable String codeValue)	Checks if a given code value is in this value set.
static CommonLanguages	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CommonLanguages[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.projecthusky.common.enums.TranslatedEnumInterface

getDisplayName

Methods inherited from interface org.projecthusky.common.enums.ValueSetEnumInterface

getCD, getCD, getCE, getCE, getCode, getCode, getCodedString, getIpfCode, isContainedIn, isEqualTo, name

Field Details

VALUE_SET_NAME

public static final String VALUE_SET_NAME

Name of the value set.

See Also:

• Constant Field Values

CODE_SYSTEM_ID

public static final String CODE_SYSTEM_ID

Identifier of the code system (all values share the same).

See Also:

• Constant Field Values

Method Details

values

public static CommonLanguages[] values()

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

Returns:

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

valueOf

public static CommonLanguages valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getCodeSystemId

public @NonNull String getCodeSystemId()

Gets the code system identifier.

Specified by:

getCodeSystemId in interface ValueSetEnumInterface

Returns:

the code system identifier.

getCodeSystemName

public @NonNull String getCodeSystemName()

Gets the code system name.

Specified by:

getCodeSystemName in interface ValueSetEnumInterface

Returns:

the code system name.

getCodeValue

public @NonNull String getCodeValue()

Gets the code value as a string.

Specified by:

getCodeValue in interface ValueSetEnumInterface

Returns:

the code value.

getDisplayName

public @NonNull String getDisplayName(@Nullable LanguageCode languageCode)

Gets the display name defined by the language param.

Specified by:

getDisplayName in interface TranslatedEnumInterface

Parameters:

languageCode - The language code to get the display name for, null to get the default display name.

Returns:

the display name in the desired language.

getValueSetId

public @NonNull String getValueSetId()

Description copied from interface: ValueSetEnumInterface

Gets the value set identifier.

Specified by:

getValueSetId in interface ValueSetEnumInterface

Returns:

the value set identifier.

getValueSetName

public @NonNull String getValueSetName()

Description copied from interface: ValueSetEnumInterface

Gets the value set name.

Specified by:

getValueSetName in interface ValueSetEnumInterface

Returns:

the value set name.

getEnum

public static @Nullable CommonLanguages getEnum(@Nullable String code)

Gets the Enum with a given code.

Parameters:

code - The code value.

Returns:

the enum value found or null.

isEnumOfValueSet

public static boolean isEnumOfValueSet(@Nullable String enumName)

Checks if a given enum is part of this value set.

Parameters:

enumName - The name of the enum.

Returns:

true if the name is found in this value set, false otherwise.

isInValueSet

public static boolean isInValueSet(@Nullable String codeValue)

Checks if a given code value is in this value set.

Parameters:

codeValue - The code value.

Returns:

true if the value is found in this value set, false otherwise.