Class StructureMap.Structure.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.StructureMap.Structure.Builder
-
- Enclosing class:
- StructureMap.Structure
public static class StructureMap.Structure.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 StructureMap.Structure.Builder
alias(java.lang.String alias)
Convenience method for settingalias
.StructureMap.Structure.Builder
alias(String alias)
The name used for this type in the map.StructureMap.Structure
build()
Build theStructureMap.Structure
StructureMap.Structure.Builder
documentation(java.lang.String documentation)
Convenience method for settingdocumentation
.StructureMap.Structure.Builder
documentation(String documentation)
Documentation that describes how the structure is used in the mapping.StructureMap.Structure.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.StructureMap.Structure.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected StructureMap.Structure.Builder
from(StructureMap.Structure structure)
StructureMap.Structure.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).StructureMap.Structure.Builder
mode(StructureMapModelMode mode)
How the referenced structure is used in this mapping.StructureMap.Structure.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.StructureMap.Structure.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.StructureMap.Structure.Builder
url(Canonical url)
The canonical reference to the structure.protected void
validate(StructureMap.Structure structure)
-
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 StructureMap.Structure.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 StructureMap.Structure.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 StructureMap.Structure.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 StructureMap.Structure.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 StructureMap.Structure.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
-
url
public StructureMap.Structure.Builder url(Canonical url)
The canonical reference to the structure.This element is required.
- Parameters:
url
- Canonical reference to structure definition- Returns:
- A reference to this Builder instance
-
mode
public StructureMap.Structure.Builder mode(StructureMapModelMode mode)
How the referenced structure is used in this mapping.This element is required.
- Parameters:
mode
- source | queried | target | produced- Returns:
- A reference to this Builder instance
-
alias
public StructureMap.Structure.Builder alias(java.lang.String alias)
Convenience method for settingalias
.- Parameters:
alias
- Name for type in this map- Returns:
- A reference to this Builder instance
- See Also:
alias(org.linuxforhealth.fhir.model.type.String)
-
alias
public StructureMap.Structure.Builder alias(String alias)
The name used for this type in the map.- Parameters:
alias
- Name for type in this map- Returns:
- A reference to this Builder instance
-
documentation
public StructureMap.Structure.Builder documentation(java.lang.String documentation)
Convenience method for settingdocumentation
.- Parameters:
documentation
- Documentation on use of structure- Returns:
- A reference to this Builder instance
- See Also:
documentation(org.linuxforhealth.fhir.model.type.String)
-
documentation
public StructureMap.Structure.Builder documentation(String documentation)
Documentation that describes how the structure is used in the mapping.- Parameters:
documentation
- Documentation on use of structure- Returns:
- A reference to this Builder instance
-
build
public StructureMap.Structure build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
StructureMap.Structure
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Structure per the base specification
-
validate
protected void validate(StructureMap.Structure structure)
-
from
protected StructureMap.Structure.Builder from(StructureMap.Structure structure)
-
-