Class ImplementationGuide.Definition.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.Builder
-
- Enclosing class:
- ImplementationGuide.Definition
public static class ImplementationGuide.Definition.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
build()
Build theImplementationGuide.Definition
ImplementationGuide.Definition.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.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected ImplementationGuide.Definition.Builder
from(ImplementationGuide.Definition definition)
ImplementationGuide.Definition.Builder
grouping(java.util.Collection<ImplementationGuide.Definition.Grouping> grouping)
A logical group of resources.ImplementationGuide.Definition.Builder
grouping(ImplementationGuide.Definition.Grouping... grouping)
A logical group of resources.ImplementationGuide.Definition.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).ImplementationGuide.Definition.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.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.Builder
page(ImplementationGuide.Definition.Page page)
A page / section in the implementation guide.ImplementationGuide.Definition.Builder
parameter(java.util.Collection<ImplementationGuide.Definition.Parameter> parameter)
Defines how IG is built by tools.ImplementationGuide.Definition.Builder
parameter(ImplementationGuide.Definition.Parameter... parameter)
Defines how IG is built by tools.ImplementationGuide.Definition.Builder
resource(java.util.Collection<ImplementationGuide.Definition.Resource> resource)
A resource that is part of the implementation guide.ImplementationGuide.Definition.Builder
resource(ImplementationGuide.Definition.Resource... resource)
A resource that is part of the implementation guide.ImplementationGuide.Definition.Builder
template(java.util.Collection<ImplementationGuide.Definition.Template> template)
A template for building resources.ImplementationGuide.Definition.Builder
template(ImplementationGuide.Definition.Template... template)
A template for building resources.protected void
validate(ImplementationGuide.Definition definition)
-
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.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.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.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.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.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
-
grouping
public ImplementationGuide.Definition.Builder grouping(ImplementationGuide.Definition.Grouping... grouping)
A logical group of resources. Logical groups can be used when building pages.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
grouping
- Grouping used to present related resources in the IG- Returns:
- A reference to this Builder instance
-
grouping
public ImplementationGuide.Definition.Builder grouping(java.util.Collection<ImplementationGuide.Definition.Grouping> grouping)
A logical group of resources. Logical groups can be used when building pages.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:
grouping
- Grouping used to present related resources in the IG- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
resource
public ImplementationGuide.Definition.Builder resource(ImplementationGuide.Definition.Resource... resource)
A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.This element is required.
- Parameters:
resource
- Resource in the implementation guide- Returns:
- A reference to this Builder instance
-
resource
public ImplementationGuide.Definition.Builder resource(java.util.Collection<ImplementationGuide.Definition.Resource> resource)
A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.This element is required.
- Parameters:
resource
- Resource in the implementation guide- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
page
public ImplementationGuide.Definition.Builder page(ImplementationGuide.Definition.Page page)
A page / section in the implementation guide. The root page is the implementation guide home page.- Parameters:
page
- Page/Section in the Guide- Returns:
- A reference to this Builder instance
-
parameter
public ImplementationGuide.Definition.Builder parameter(ImplementationGuide.Definition.Parameter... parameter)
Defines how IG is built by tools.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
parameter
- Defines how IG is built by tools- Returns:
- A reference to this Builder instance
-
parameter
public ImplementationGuide.Definition.Builder parameter(java.util.Collection<ImplementationGuide.Definition.Parameter> parameter)
Defines how IG is built by tools.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:
parameter
- Defines how IG is built by tools- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
template
public ImplementationGuide.Definition.Builder template(ImplementationGuide.Definition.Template... template)
A template for building resources.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
template
- A template for building resources- Returns:
- A reference to this Builder instance
-
template
public ImplementationGuide.Definition.Builder template(java.util.Collection<ImplementationGuide.Definition.Template> template)
A template for building resources.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:
template
- A template for building resources- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public ImplementationGuide.Definition build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
ImplementationGuide.Definition
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Definition per the base specification
-
validate
protected void validate(ImplementationGuide.Definition definition)
-
from
protected ImplementationGuide.Definition.Builder from(ImplementationGuide.Definition definition)
-
-