Class ImplementationGuide.Definition.Resource.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.ImplementationGuide.Definition.Resource.Builder
-
- Enclosing class:
- ImplementationGuide.Definition.Resource
public static class ImplementationGuide.Definition.Resource.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 ImplementationGuide.Definition.Resource
build()
Build theImplementationGuide.Definition.Resource
ImplementationGuide.Definition.Resource.Builder
description(java.lang.String description)
Convenience method for settingdescription
.ImplementationGuide.Definition.Resource.Builder
description(String description)
A description of the reason that a resource has been included in the implementation guide.ImplementationGuide.Definition.Resource.Builder
example(java.lang.Boolean example)
Convenience method for settingexample
with choice type Boolean.ImplementationGuide.Definition.Resource.Builder
example(Element example)
If true or a reference, indicates the resource is an example instance.ImplementationGuide.Definition.Resource.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.ImplementationGuide.Definition.Resource.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.ImplementationGuide.Definition.Resource.Builder
fhirVersion(java.util.Collection<FHIRVersion> fhirVersion)
Indicates the FHIR Version(s) this artifact is intended to apply to.ImplementationGuide.Definition.Resource.Builder
fhirVersion(FHIRVersion... fhirVersion)
Indicates the FHIR Version(s) this artifact is intended to apply to.protected ImplementationGuide.Definition.Resource.Builder
from(ImplementationGuide.Definition.Resource resource)
ImplementationGuide.Definition.Resource.Builder
groupingId(Id groupingId)
Reference to the id of the grouping this resource appears in.ImplementationGuide.Definition.Resource.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).ImplementationGuide.Definition.Resource.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.ImplementationGuide.Definition.Resource.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.ImplementationGuide.Definition.Resource.Builder
name(java.lang.String name)
Convenience method for settingname
.ImplementationGuide.Definition.Resource.Builder
name(String name)
A human assigned name for the resource.ImplementationGuide.Definition.Resource.Builder
reference(Reference reference)
Where this resource is found.protected void
validate(ImplementationGuide.Definition.Resource resource)
-
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 ImplementationGuide.Definition.Resource.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 ImplementationGuide.Definition.Resource.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 ImplementationGuide.Definition.Resource.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 ImplementationGuide.Definition.Resource.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 ImplementationGuide.Definition.Resource.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
-
reference
public ImplementationGuide.Definition.Resource.Builder reference(Reference reference)
Where this resource is found.This element is required.
- Parameters:
reference
- Location of the resource- Returns:
- A reference to this Builder instance
-
fhirVersion
public ImplementationGuide.Definition.Resource.Builder fhirVersion(FHIRVersion... fhirVersion)
Indicates the FHIR Version(s) this artifact is intended to apply to. If no versions are specified, the resource is assumed to apply to all the versions stated in ImplementationGuide.fhirVersion.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
fhirVersion
- Versions this applies to (if different to IG)- Returns:
- A reference to this Builder instance
-
fhirVersion
public ImplementationGuide.Definition.Resource.Builder fhirVersion(java.util.Collection<FHIRVersion> fhirVersion)
Indicates the FHIR Version(s) this artifact is intended to apply to. If no versions are specified, the resource is assumed to apply to all the versions stated in ImplementationGuide.fhirVersion.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
fhirVersion
- Versions this applies to (if different to IG)- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
name
public ImplementationGuide.Definition.Resource.Builder name(java.lang.String name)
Convenience method for settingname
.- Parameters:
name
- Human Name for the resource- Returns:
- A reference to this Builder instance
- See Also:
name(org.linuxforhealth.fhir.model.type.String)
-
name
public ImplementationGuide.Definition.Resource.Builder name(String name)
A human assigned name for the resource. All resources SHOULD have a name, but the name may be extracted from the resource (e.g. ValueSet.name).- Parameters:
name
- Human Name for the resource- Returns:
- A reference to this Builder instance
-
description
public ImplementationGuide.Definition.Resource.Builder description(java.lang.String description)
Convenience method for settingdescription
.- Parameters:
description
- Reason why included in guide- Returns:
- A reference to this Builder instance
- See Also:
description(org.linuxforhealth.fhir.model.type.String)
-
description
public ImplementationGuide.Definition.Resource.Builder description(String description)
A description of the reason that a resource has been included in the implementation guide.- Parameters:
description
- Reason why included in guide- Returns:
- A reference to this Builder instance
-
example
public ImplementationGuide.Definition.Resource.Builder example(java.lang.Boolean example)
Convenience method for settingexample
with choice type Boolean.- Parameters:
example
- Is an example/What is this an example of?- Returns:
- A reference to this Builder instance
- See Also:
example(Element)
-
example
public ImplementationGuide.Definition.Resource.Builder example(Element example)
If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.This is a choice element with the following allowed types:
- Parameters:
example
- Is an example/What is this an example of?- Returns:
- A reference to this Builder instance
-
groupingId
public ImplementationGuide.Definition.Resource.Builder groupingId(Id groupingId)
Reference to the id of the grouping this resource appears in.- Parameters:
groupingId
- Grouping this is part of- Returns:
- A reference to this Builder instance
-
build
public ImplementationGuide.Definition.Resource build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
ImplementationGuide.Definition.Resource
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Resource per the base specification
-
validate
protected void validate(ImplementationGuide.Definition.Resource resource)
-
from
protected ImplementationGuide.Definition.Resource.Builder from(ImplementationGuide.Definition.Resource resource)
-
-