java.lang.Object
- ca.uhn.fhir.model.api.TagList

All Implemented Interfaces:

Serializable, Iterable<Tag>, Collection<Tag>, Set<Tag>, IBase
```
public class TagList
extends Object
implements Set<Tag>, Serializable, IBase
```
A collection of tags present on a single resource. TagList is backed by a LinkedHashSet, so the order of added tags will be consistent, but duplicates will not be preserved.
Thread safety: This class is not thread safe

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static String ATTR_CATEGORY

static String ELEMENT_NAME

static String ELEMENT_NAME_LC

Constructor Summary

Constructors
Constructor Description

TagList()
Constructor

TagList(TagList theTags)
Copy constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`add(Tag theE)`
`boolean`	`addAll(Collection<? extends Tag> theC)`
`Tag`	`addTag()`	Deprecated. Tags wil become immutable in a future release of HAPI, so `addTag(String, String, String)` should be used instead
`Tag`	`addTag(String theScheme, String theTerm)`	Add a new tag instance
`Tag`	`addTag(String theScheme, String theTerm, String theLabel)`	Add a new tag instance
`void`	`clear()`
`boolean`	`contains(Object theO)`
`boolean`	`containsAll(Collection<?> theC)`
`boolean`	`equals(Object obj)`
`Tag`	`get(int theIndex)`	Returns the tag at a given index - Note that the TagList is backed by a `LinkedHashSet`, so the order of added tags will be consistent, but duplicates will not be preserved.
`List<String>`	`getFormatCommentsPost()`	NOT SUPPORTED - Throws `UnsupportedOperationException`
`List<String>`	`getFormatCommentsPre()`	NOT SUPPORTED - Throws `UnsupportedOperationException`
`Tag`	`getTag(String theScheme, String theTerm)`
`List<Tag>`	`getTagsWithScheme(String theScheme)`
`Object`	`getUserData(String theName)`	Retrieves any user suplied data in this element
`boolean`	`hasFormatComment()`	Returns false
`int`	`hashCode()`
`boolean`	`isEmpty()`
`Iterator<Tag>`	`iterator()`
`boolean`	`remove(Object theO)`
`boolean`	`removeAll(Collection<?> theC)`
`boolean`	`retainAll(Collection<?> theC)`
`void`	`setUserData(String theName, Object theValue)`	Sets a user supplied data value in this element
`int`	`size()`
`Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] theA)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArray

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
fhirType

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface java.util.Set
spliterator

- Field Detail
  - ATTR_CATEGORY
```
public static final String ATTR_CATEGORY
```
    See Also:
    
    Constant Field Values
  - ELEMENT_NAME
```
public static final String ELEMENT_NAME
```
    See Also:
    
    Constant Field Values
  - ELEMENT_NAME_LC
```
public static final String ELEMENT_NAME_LC
```
- Constructor Detail
  - TagList
```
public TagList()
```
    Constructor
  - TagList
```
public TagList(TagList theTags)
```
    Copy constructor
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - add
```
public boolean add(Tag theE)
```
    Specified by:
    
    add in interface Collection<Tag>
    
    Specified by:
    
    add in interface Set<Tag>
  - addAll
```
public boolean addAll(Collection<? extends Tag> theC)
```
    Specified by:
    
    addAll in interface Collection<Tag>
    
    Specified by:
    
    addAll in interface Set<Tag>
  - addTag
```
@Deprecated
public Tag addTag()
```
    Deprecated.
    Tags wil become immutable in a future release of HAPI, so addTag(String, String, String) should be used instead
  - addTag
```
public Tag addTag(String theScheme,
                  String theTerm)
```
    Add a new tag instance
    
    Parameters:
    
    theScheme - The tag scheme (the system)
    
    theTerm - The tag term (the code)
    
    Returns:
    
    Returns the newly created tag instance. Note that the tag is added to the list by this method, so you generally do not need to interact directly with the added tag.
  - addTag
```
public Tag addTag(String theScheme,
                  String theTerm,
                  String theLabel)
```
    Add a new tag instance
    
    Parameters:
    
    theScheme - The tag scheme
    
    theTerm - The tag term
    
    theLabel - The tag label
    
    Returns:
    
    Returns the newly created tag instance. Note that the tag is added to the list by this method, so you generally do not need to interact directly with the added tag.
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<Tag>
    
    Specified by:
    
    clear in interface Set<Tag>
  - contains
```
public boolean contains(Object theO)
```
    Specified by:
    
    contains in interface Collection<Tag>
    
    Specified by:
    
    contains in interface Set<Tag>
  - containsAll
```
public boolean containsAll(Collection<?> theC)
```
    Specified by:
    
    containsAll in interface Collection<Tag>
    
    Specified by:
    
    containsAll in interface Set<Tag>
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface Collection<Tag>
    
    Specified by:
    
    equals in interface Set<Tag>
    
    Overrides:
    
    equals in class Object
  - get
```
public Tag get(int theIndex)
```
    Returns the tag at a given index - Note that the TagList is backed by a LinkedHashSet, so the order of added tags will be consistent, but duplicates will not be preserved.
  - getTag
```
public Tag getTag(String theScheme,
                  String theTerm)
```
  - getTagsWithScheme
```
public List<Tag> getTagsWithScheme(String theScheme)
```
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Collection<Tag>
    
    Specified by:
    
    hashCode in interface Set<Tag>
    
    Overrides:
    
    hashCode in class Object
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<Tag>
    
    Specified by:
    
    isEmpty in interface IBase
    
    Specified by:
    
    isEmpty in interface Set<Tag>
  - iterator
```
public Iterator<Tag> iterator()
```
    Specified by:
    
    iterator in interface Collection<Tag>
    
    Specified by:
    
    iterator in interface Iterable<Tag>
    
    Specified by:
    
    iterator in interface Set<Tag>
  - remove
```
public boolean remove(Object theO)
```
    Specified by:
    
    remove in interface Collection<Tag>
    
    Specified by:
    
    remove in interface Set<Tag>
  - removeAll
```
public boolean removeAll(Collection<?> theC)
```
    Specified by:
    
    removeAll in interface Collection<Tag>
    
    Specified by:
    
    removeAll in interface Set<Tag>
  - retainAll
```
public boolean retainAll(Collection<?> theC)
```
    Specified by:
    
    retainAll in interface Collection<Tag>
    
    Specified by:
    
    retainAll in interface Set<Tag>
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<Tag>
    
    Specified by:
    
    size in interface Set<Tag>
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<Tag>
    
    Specified by:
    
    toArray in interface Set<Tag>
  - toArray
```
public <T> T[] toArray(T[] theA)
```
    Specified by:
    
    toArray in interface Collection<Tag>
    
    Specified by:
    
    toArray in interface Set<Tag>
  - hasFormatComment
```
public boolean hasFormatComment()
```
    Returns false
    
    Specified by:
    
    hasFormatComment in interface IBase
  - getFormatCommentsPre
```
public List<String> getFormatCommentsPre()
```
    NOT SUPPORTED - Throws UnsupportedOperationException
    
    Specified by:
    
    getFormatCommentsPre in interface IBase
  - getFormatCommentsPost
```
public List<String> getFormatCommentsPost()
```
    NOT SUPPORTED - Throws UnsupportedOperationException
    
    Specified by:
    
    getFormatCommentsPost in interface IBase
  - getUserData
```
public Object getUserData(String theName)
```
    Description copied from interface: IBase
    
    Retrieves any user suplied data in this element
    
    Specified by:
    
    getUserData in interface IBase
  - setUserData
```
public void setUserData(String theName,
                        Object theValue)
```
    Description copied from interface: IBase
    
    Sets a user supplied data value in this element
    
    Specified by:
    
    setUserData in interface IBase

Modifier and Type	Field	Description
`static String`	`ATTR_CATEGORY`
`static String`	`ELEMENT_NAME`
`static String`	`ELEMENT_NAME_LC`

Constructor	Description
`TagList()`	Constructor
`TagList(TagList theTags)`	Copy constructor

Class TagList

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.Set

Field Detail

ATTR_CATEGORY

ELEMENT_NAME

ELEMENT_NAME_LC

Constructor Detail

TagList

TagList

Method Detail

toString

add

addAll

addTag

addTag

addTag

clear

contains

containsAll

equals

get

getTag

getTagsWithScheme

hashCode

isEmpty

iterator

remove

removeAll

retainAll

size

toArray

toArray

hasFormatComment

getFormatCommentsPre

getFormatCommentsPost

getUserData

setUserData