Package ca.uhn.fhir.context.api

Enum Class AddProfileTagEnum

java.lang.Object

java.lang.Enum<AddProfileTagEnum>

ca.uhn.fhir.context.api.AddProfileTagEnum

All Implemented Interfaces:

Serializable, Comparable<AddProfileTagEnum>, Constable

public enum AddProfileTagEnum
extends Enum<AddProfileTagEnum>

RESTful server behaviour for automatically adding profile tags when serializing resources

See Also:

• FhirContext.setAddProfileTagWhenEncoding(AddProfileTagEnum)

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS	Deprecated. This mode causes even FHIR's default profiles to be exported in the resource metadata section.
NEVER	Do not add profile tags automatically
ONLY_FOR_CUSTOM	Add any profile tags that returned resources appear to conform to if the resource is a non-standard class (e.g.

Method Summary

Modifier and Type	Method	Description
static AddProfileTagEnum	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AddProfileTagEnum[]	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

Enum Constant Details

NEVER

public static final AddProfileTagEnum NEVER

Do not add profile tags automatically

ALWAYS

@Deprecated
public static final AddProfileTagEnum ALWAYS

Deprecated.

This mode causes even FHIR's default profiles to be exported in the resource metadata section. This is not generally expected behaviour from other systems and it offers no real benefit, so it will be removed at some point. This option was deprecated in HAPI 1.5

Add any profile tags that returned resources appear to conform to

ONLY_FOR_CUSTOM

public static final AddProfileTagEnum ONLY_FOR_CUSTOM

Add any profile tags that returned resources appear to conform to if the resource is a non-standard class (e.g. it is an instance of a class that extends a built in type, but adds or constrains it)

Method Details

values

public static AddProfileTagEnum[] 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 AddProfileTagEnum 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