Package com.ibm.fhir.model.type

Class Canonical.Builder

java.lang.Object

com.ibm.fhir.model.builder.AbstractBuilder<Element>

com.ibm.fhir.model.type.Element.Builder

com.ibm.fhir.model.type.Uri.Builder

com.ibm.fhir.model.type.Canonical.Builder

All Implemented Interfaces:

Builder<Element>

Enclosing class:

Canonical

public static class Canonical.Builder
extends Uri.Builder

Field Summary

Fields inherited from class com.ibm.fhir.model.type.Uri.Builder

value

Fields inherited from class com.ibm.fhir.model.type.Element.Builder

extension, id

Method Summary

Modifier and Type	Method	Description
Canonical	build()	Build the Canonical
Canonical.Builder	extension(Extension... extension)	May be used to represent additional information that is not part of the basic definition of the resource.
Canonical.Builder	extension(Collection<Extension> extension)	May be used to represent additional information that is not part of the basic definition of the resource.
protected Canonical.Builder	from(Canonical canonical)
Canonical.Builder	id(String id)	unique id for the element within a resource (for internal references)
Canonical.Builder	value(String value)	Primitive value for canonical

Methods inherited from class com.ibm.fhir.model.type.Uri.Builder

from

Methods inherited from class com.ibm.fhir.model.type.Element.Builder

from

Methods inherited from class java.lang.Object

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

Method Detail

id

public Canonical.Builder id(String id)

unique id for the element within a resource (for internal references)

Overrides:

id in class Uri.Builder

Parameters:

id - xml:id (or equivalent in JSON)

Returns:

A reference to this Builder instance

extension

public Canonical.Builder extension(Extension... extension)

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Adds new element(s) to the existing list

Overrides:

extension in class Uri.Builder

Parameters:

extension - Additional content defined by implementations

Returns:

A reference to this Builder instance

extension

public Canonical.Builder extension(Collection<Extension> extension)

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Replaces the existing list with a new one containing elements from the Collection

Overrides:

extension in class Uri.Builder

Parameters:

extension - Additional content defined by implementations

Returns:

A reference to this Builder instance

value

public Canonical.Builder value(String value)

Primitive value for canonical

Overrides:

value in class Uri.Builder

Parameters:

value - Primitive value for canonical

Returns:

A reference to this Builder instance

build

public Canonical build()

Build the Canonical

Specified by:

build in interface Builder<Element>

Overrides:

build in class Uri.Builder

Returns:

An immutable object of type Canonical

Throws:

IllegalStateException - if the current state cannot be built into a valid Canonical per the base specification

from

protected Canonical.Builder from(Canonical canonical)