Package ca.uhn.fhir.model.api

Class BaseElement

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

All Implemented Interfaces:

IElement, ISupportsUndeclaredExtensions, Serializable, IBase

Direct Known Subclasses:

BaseIdentifiableElement, Tag

public abstract class BaseElement
extends Object
implements ISupportsUndeclaredExtensions

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
BaseElement()

Method Summary

Modifier and Type	Method	Description
ExtensionDt	addUndeclaredExtension(boolean theIsModifier, String theUrl)	Adds an extension to this object.
ExtensionDt	addUndeclaredExtension(boolean theIsModifier, String theUrl, IBaseDatatype theValue)	Adds an extension to this object
void	addUndeclaredExtension(ExtensionDt theExtension)	Adds an extension to this object.
List<ExtensionDt>	getAllUndeclaredExtensions()	Returns an immutable list containing all extensions (modifier and non-modifier).
List<String>	getFormatCommentsPost()	Returns a list of comments appearing immediately after this element within the serialized form of the resource.
List<String>	getFormatCommentsPre()	Returns a list of comments appearing immediately before this element within the serialized form of the resource.
List<ExtensionDt>	getUndeclaredExtensions()	Returns a list containing all undeclared non-modifier extensions.
List<ExtensionDt>	getUndeclaredExtensionsByUrl(String theUrl)	Returns an immutable list containing all undeclared extensions (modifier and non-modifier) by extension URL
List<ExtensionDt>	getUndeclaredModifierExtensions()	Returns a list containing all undeclared modifier extensions.
Object	getUserData(String name)	Retrieves any user suplied data in this element
boolean	hasFormatComment()	Returns true if any comments would be returned by IBase.getFormatCommentsPre() or IBase.getFormatCommentsPost()
protected boolean	isBaseEmpty()	Intended to be called by extending classes IBase.isEmpty() implementations, returns true if all content in this superclass instance is empty per the semantics of IBase.isEmpty().
void	setUserData(String name, Object value)	Sets a user supplied data value in this element

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

fhirType, isEmpty

Constructor Detail

BaseElement

public BaseElement()

Method Detail

addUndeclaredExtension

public ExtensionDt addUndeclaredExtension(boolean theIsModifier,
                                          String theUrl)

Description copied from interface: ISupportsUndeclaredExtensions

Adds an extension to this object. This method is intended for use when an extension is being added which will contain child extensions, as opposed to a datatype.

Specified by:

addUndeclaredExtension in interface ISupportsUndeclaredExtensions

See Also:

To return a mutable list which may be used to remove extensions

addUndeclaredExtension

public ExtensionDt addUndeclaredExtension(boolean theIsModifier,
                                          String theUrl,
                                          IBaseDatatype theValue)

Description copied from interface: ISupportsUndeclaredExtensions

Adds an extension to this object

Specified by:

addUndeclaredExtension in interface ISupportsUndeclaredExtensions

See Also:

To return a mutable list which may be used to remove extensions

addUndeclaredExtension

public void addUndeclaredExtension(ExtensionDt theExtension)

Description copied from interface: ISupportsUndeclaredExtensions

Adds an extension to this object. This extension should have the following properties set:

• Is Modifier
• URL
• And one of:
  • A datatype value
  • Further sub-extensions

Specified by:

addUndeclaredExtension in interface ISupportsUndeclaredExtensions

Parameters:

theExtension - The extension to add. Can not be null.

getAllUndeclaredExtensions

public List<ExtensionDt> getAllUndeclaredExtensions()

Description copied from interface: ISupportsUndeclaredExtensions

Returns an immutable list containing all extensions (modifier and non-modifier).

Specified by:

getAllUndeclaredExtensions in interface ISupportsUndeclaredExtensions

See Also:

To return a mutable list which may be used to remove undeclared non-modifier extensions, To return a mutable list which may be used to remove undeclared modifier extensions

getFormatCommentsPost

public List<String> getFormatCommentsPost()

Description copied from interface: IBase

Returns a list of comments appearing immediately after this element within the serialized form of the resource. Creates the list if it does not exist, so this method will not return null

Specified by:

getFormatCommentsPost in interface IBase

getFormatCommentsPre

public List<String> getFormatCommentsPre()

Description copied from interface: IBase

Returns a list of comments appearing immediately before this element within the serialized form of the resource. Creates the list if it does not exist, so this method will not return null

Specified by:

getFormatCommentsPre in interface IBase

getUndeclaredExtensions

public List<ExtensionDt> getUndeclaredExtensions()

Description copied from interface: ISupportsUndeclaredExtensions

Returns a list containing all undeclared non-modifier extensions. The returned list is mutable, so it may be modified (e.g. to add or remove an extension).

Specified by:

getUndeclaredExtensions in interface ISupportsUndeclaredExtensions

getUndeclaredExtensionsByUrl

public List<ExtensionDt> getUndeclaredExtensionsByUrl(String theUrl)

Description copied from interface: ISupportsUndeclaredExtensions

Returns an immutable list containing all undeclared extensions (modifier and non-modifier) by extension URL

Specified by:

getUndeclaredExtensionsByUrl in interface ISupportsUndeclaredExtensions

See Also:

To return a mutable list which may be used to remove extensions

getUndeclaredModifierExtensions

public List<ExtensionDt> getUndeclaredModifierExtensions()

Description copied from interface: ISupportsUndeclaredExtensions

Returns a list containing all undeclared modifier extensions. The returned list is mutable, so it may be modified (e.g. to add or remove an extension).

Specified by:

getUndeclaredModifierExtensions in interface ISupportsUndeclaredExtensions

hasFormatComment

public boolean hasFormatComment()

Description copied from interface: IBase

Returns true if any comments would be returned by IBase.getFormatCommentsPre() or IBase.getFormatCommentsPost()

Specified by:

hasFormatComment in interface IBase

getUserData

public Object getUserData(String name)

Description copied from interface: IBase

Retrieves any user suplied data in this element

Specified by:

getUserData in interface IBase

setUserData

public void setUserData(String name,
                        Object value)

Description copied from interface: IBase

Sets a user supplied data value in this element

Specified by:

setUserData in interface IBase

isBaseEmpty

protected boolean isBaseEmpty()

Intended to be called by extending classes IBase.isEmpty() implementations, returns true if all content in this superclass instance is empty per the semantics of IBase.isEmpty().