Class NamingSystem.UniqueId.Builder
- java.lang.Object
-
- org.linuxforhealth.fhir.model.builder.AbstractBuilder<Element>
-
- org.linuxforhealth.fhir.model.type.Element.Builder
-
- org.linuxforhealth.fhir.model.type.BackboneElement.Builder
-
- org.linuxforhealth.fhir.model.resource.NamingSystem.UniqueId.Builder
-
- Enclosing class:
- NamingSystem.UniqueId
public static class NamingSystem.UniqueId.Builder extends BackboneElement.Builder
-
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder
modifierExtension
-
Fields inherited from class org.linuxforhealth.fhir.model.type.Element.Builder
extension, id
-
Fields inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NamingSystem.UniqueId
build()
Build theNamingSystem.UniqueId
NamingSystem.UniqueId.Builder
comment(java.lang.String comment)
Convenience method for settingcomment
.NamingSystem.UniqueId.Builder
comment(String comment)
Notes about the past or intended usage of this identifier.NamingSystem.UniqueId.Builder
extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element.NamingSystem.UniqueId.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected NamingSystem.UniqueId.Builder
from(NamingSystem.UniqueId uniqueId)
NamingSystem.UniqueId.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).NamingSystem.UniqueId.Builder
modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.NamingSystem.UniqueId.Builder
modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.NamingSystem.UniqueId.Builder
period(Period period)
Identifies the period of time over which this identifier is considered appropriate to refer to the naming system.NamingSystem.UniqueId.Builder
preferred(java.lang.Boolean preferred)
Convenience method for settingpreferred
.NamingSystem.UniqueId.Builder
preferred(Boolean preferred)
Indicates whether this identifier is the "preferred" identifier of this type.NamingSystem.UniqueId.Builder
type(NamingSystemIdentifierType type)
Identifies the unique identifier scheme used for this particular identifier.protected void
validate(NamingSystem.UniqueId uniqueId)
NamingSystem.UniqueId.Builder
value(java.lang.String value)
Convenience method for settingvalue
.NamingSystem.UniqueId.Builder
value(String value)
The string that should be sent over the wire to identify the code system or identifier system.-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public NamingSystem.UniqueId.Builder id(java.lang.String id)
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.- Overrides:
id
in classBackboneElement.Builder
- Parameters:
id
- Unique id for inter-element referencing- Returns:
- A reference to this Builder instance
-
extension
public NamingSystem.UniqueId.Builder extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element. 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. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public NamingSystem.UniqueId.Builder extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element. 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. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
modifierExtension
public NamingSystem.UniqueId.Builder modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
-
modifierExtension
public NamingSystem.UniqueId.Builder modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
type
public NamingSystem.UniqueId.Builder type(NamingSystemIdentifierType type)
Identifies the unique identifier scheme used for this particular identifier.This element is required.
- Parameters:
type
- oid | uuid | uri | other- Returns:
- A reference to this Builder instance
-
value
public NamingSystem.UniqueId.Builder value(java.lang.String value)
Convenience method for settingvalue
.This element is required.
- Parameters:
value
- The unique identifier- Returns:
- A reference to this Builder instance
- See Also:
value(org.linuxforhealth.fhir.model.type.String)
-
value
public NamingSystem.UniqueId.Builder value(String value)
The string that should be sent over the wire to identify the code system or identifier system.This element is required.
- Parameters:
value
- The unique identifier- Returns:
- A reference to this Builder instance
-
preferred
public NamingSystem.UniqueId.Builder preferred(java.lang.Boolean preferred)
Convenience method for settingpreferred
.- Parameters:
preferred
- Is this the id that should be used for this type- Returns:
- A reference to this Builder instance
- See Also:
preferred(org.linuxforhealth.fhir.model.type.Boolean)
-
preferred
public NamingSystem.UniqueId.Builder preferred(Boolean preferred)
Indicates whether this identifier is the "preferred" identifier of this type.- Parameters:
preferred
- Is this the id that should be used for this type- Returns:
- A reference to this Builder instance
-
comment
public NamingSystem.UniqueId.Builder comment(java.lang.String comment)
Convenience method for settingcomment
.- Parameters:
comment
- Notes about identifier usage- Returns:
- A reference to this Builder instance
- See Also:
comment(org.linuxforhealth.fhir.model.type.String)
-
comment
public NamingSystem.UniqueId.Builder comment(String comment)
Notes about the past or intended usage of this identifier.- Parameters:
comment
- Notes about identifier usage- Returns:
- A reference to this Builder instance
-
period
public NamingSystem.UniqueId.Builder period(Period period)
Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic.- Parameters:
period
- When is identifier valid?- Returns:
- A reference to this Builder instance
-
build
public NamingSystem.UniqueId build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
NamingSystem.UniqueId
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid UniqueId per the base specification
-
validate
protected void validate(NamingSystem.UniqueId uniqueId)
-
from
protected NamingSystem.UniqueId.Builder from(NamingSystem.UniqueId uniqueId)
-
-