ca.uhn.fhir.model.api

Class Tag

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.Tag

All Implemented Interfaces:

IElement, ISupportsUndeclaredExtensions, Serializable, IBase

public class Tag
extends BaseElement
implements IElement

A single tag

Note on equality- When computing hashCode or equals values for this class, only the scheme and

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_LABEL
static String	ATTR_SCHEME
static String	ATTR_TERM
static String	HL7_ORG_FHIR_TAG Convenience constant containing the "http://hl7.org/fhir/tag" scheme value
static String	HL7_ORG_PROFILE_TAG Convenience constant containing the "http://hl7.org/fhir/tag/profile" scheme value
static String	HL7_ORG_SECURITY_TAG Convenience constant containing the "http://hl7.org/fhir/tag/security" scheme value

Constructor Summary

Constructors

Constructor and Description
Tag() Deprecated. Tags will become immutable in a future release, so this constructor should not be used.
Tag(String theTerm) Deprecated. There is no reason to create a tag with a term and not a scheme, so this constructor will be removed
Tag(String theScheme, String theTerm)
Tag(String theScheme, String theTerm, String theLabel)
Tag(URI theScheme, URI theTerm, String theLabel)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getLabel()
String	getScheme()
String	getTerm()
int	hashCode()
boolean	isEmpty() Returns true if either scheme or term is populated.
Tag	setLabel(String theLabel) Deprecated. Tags will become immutable in a future release of HAPI in order to facilitate ensuring that the TagList acts as an unordered set. Use the constructor to set this field when creating a new tag object
Tag	setScheme(String theScheme) Deprecated. Tags will become immutable in a future release of HAPI in order to facilitate ensuring that the TagList acts as an unordered set. Use the constructor to set this field when creating a new tag object
Tag	setTerm(String theTerm) Deprecated. Tags will become immutable in a future release of HAPI in order to facilitate ensuring that the TagList acts as an unordered set. Use the constructor to set this field when creating a new tag object
String	toHeaderValue()
String	toString()

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, isBaseEmpty

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ATTR_LABEL

public static final String ATTR_LABEL

See Also:

Constant Field Values

ATTR_SCHEME

public static final String ATTR_SCHEME

See Also:

Constant Field Values

ATTR_TERM

public static final String ATTR_TERM

See Also:

Constant Field Values

HL7_ORG_FHIR_TAG

public static final String HL7_ORG_FHIR_TAG

Convenience constant containing the "http://hl7.org/fhir/tag" scheme value

See Also:

Constant Field Values

HL7_ORG_PROFILE_TAG

public static final String HL7_ORG_PROFILE_TAG

Convenience constant containing the "http://hl7.org/fhir/tag/profile" scheme value

See Also:

Constant Field Values

HL7_ORG_SECURITY_TAG

public static final String HL7_ORG_SECURITY_TAG

Convenience constant containing the "http://hl7.org/fhir/tag/security" scheme value

See Also:

Constant Field Values

Constructor Detail

Tag

@Deprecated
public Tag()

Deprecated. Tags will become immutable in a future release, so this constructor should not be used.

Tag

@Deprecated
public Tag(String theTerm)

Deprecated. There is no reason to create a tag with a term and not a scheme, so this constructor will be removed

Tag

public Tag(String theScheme,
           String theTerm)

Tag

public Tag(String theScheme,
           String theTerm,
           String theLabel)

Tag

public Tag(URI theScheme,
           URI theTerm,
           String theLabel)

Method Detail

getLabel

public String getLabel()

getScheme

public String getScheme()

getTerm

public String getTerm()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isEmpty

public boolean isEmpty()

Returns true if either scheme or term is populated.

Specified by:

isEmpty in interface IBase

setLabel

@Deprecated
public Tag setLabel(String theLabel)

Deprecated. Tags will become immutable in a future release of HAPI in order to facilitate ensuring that the TagList acts as an unordered set. Use the constructor to set this field when creating a new tag object

Sets the label and returns a reference to this tag

setScheme

@Deprecated
public Tag setScheme(String theScheme)

Deprecated. Tags will become immutable in a future release of HAPI in order to facilitate ensuring that the TagList acts as an unordered set. Use the constructor to set this field when creating a new tag object

Sets the scheme and returns a reference to this tag

setTerm

@Deprecated
public Tag setTerm(String theTerm)

Deprecated. Tags will become immutable in a future release of HAPI in order to facilitate ensuring that the TagList acts as an unordered set. Use the constructor to set this field when creating a new tag object

Sets the term and returns a reference to this tag

toHeaderValue

public String toHeaderValue()

toString

public String toString()

Overrides:

toString in class Object