Class SubstanceSpecification.Structure.Builder
- java.lang.Object
-
- com.ibm.fhir.model.builder.AbstractBuilder<Element>
-
- com.ibm.fhir.model.type.Element.Builder
-
- com.ibm.fhir.model.type.BackboneElement.Builder
-
- com.ibm.fhir.model.resource.SubstanceSpecification.Structure.Builder
-
- Enclosing class:
- SubstanceSpecification.Structure
public static class SubstanceSpecification.Structure.Builder extends BackboneElement.Builder
-
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.type.BackboneElement.Builder
modifierExtension
-
Fields inherited from class com.ibm.fhir.model.type.Element.Builder
extension, id
-
Fields inherited from class com.ibm.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SubstanceSpecification.Structure
build()
Build theSubstanceSpecification.Structure
SubstanceSpecification.Structure.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.SubstanceSpecification.Structure.Builder
extension(Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element.protected SubstanceSpecification.Structure.Builder
from(SubstanceSpecification.Structure structure)
SubstanceSpecification.Structure.Builder
id(String id)
Unique id for the element within a resource (for internal references).SubstanceSpecification.Structure.Builder
isotope(SubstanceSpecification.Structure.Isotope... isotope)
Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio.SubstanceSpecification.Structure.Builder
isotope(Collection<SubstanceSpecification.Structure.Isotope> isotope)
Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio.SubstanceSpecification.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.SubstanceSpecification.Structure.Builder
modifierExtension(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.SubstanceSpecification.Structure.Builder
molecularFormula(String molecularFormula)
Molecular formula.SubstanceSpecification.Structure.Builder
molecularFormula(String molecularFormula)
Convenience method for settingmolecularFormula
.SubstanceSpecification.Structure.Builder
molecularFormulaByMoiety(String molecularFormulaByMoiety)
Specified per moiety according to the Hill system, i.e.SubstanceSpecification.Structure.Builder
molecularFormulaByMoiety(String molecularFormulaByMoiety)
Convenience method for settingmolecularFormulaByMoiety
.SubstanceSpecification.Structure.Builder
molecularWeight(SubstanceSpecification.Structure.Isotope.MolecularWeight molecularWeight)
The molecular weight or weight range (for proteins, polymers or nucleic acids).SubstanceSpecification.Structure.Builder
opticalActivity(CodeableConcept opticalActivity)
Optical activity type.SubstanceSpecification.Structure.Builder
representation(SubstanceSpecification.Structure.Representation... representation)
Molecular structural representation.SubstanceSpecification.Structure.Builder
representation(Collection<SubstanceSpecification.Structure.Representation> representation)
Molecular structural representation.SubstanceSpecification.Structure.Builder
source(Reference... source)
Supporting literature.SubstanceSpecification.Structure.Builder
source(Collection<Reference> source)
Supporting literature.SubstanceSpecification.Structure.Builder
stereochemistry(CodeableConcept stereochemistry)
Stereochemistry type.protected void
validate(SubstanceSpecification.Structure structure)
-
Methods inherited from class com.ibm.fhir.model.type.BackboneElement.Builder
from, validate
-
Methods inherited from class com.ibm.fhir.model.type.Element.Builder
from, validate
-
Methods inherited from class com.ibm.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public SubstanceSpecification.Structure.Builder id(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 SubstanceSpecification.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 SubstanceSpecification.Structure.Builder extension(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:
NullPointerException
- If the passed collection is null
-
modifierExtension
public SubstanceSpecification.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 SubstanceSpecification.Structure.Builder modifierExtension(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:
NullPointerException
- If the passed collection is null
-
stereochemistry
public SubstanceSpecification.Structure.Builder stereochemistry(CodeableConcept stereochemistry)
Stereochemistry type.- Parameters:
stereochemistry
- Stereochemistry type- Returns:
- A reference to this Builder instance
-
opticalActivity
public SubstanceSpecification.Structure.Builder opticalActivity(CodeableConcept opticalActivity)
Optical activity type.- Parameters:
opticalActivity
- Optical activity type- Returns:
- A reference to this Builder instance
-
molecularFormula
public SubstanceSpecification.Structure.Builder molecularFormula(String molecularFormula)
Convenience method for settingmolecularFormula
.- Parameters:
molecularFormula
- Molecular formula- Returns:
- A reference to this Builder instance
- See Also:
molecularFormula(com.ibm.fhir.model.type.String)
-
molecularFormula
public SubstanceSpecification.Structure.Builder molecularFormula(String molecularFormula)
Molecular formula.- Parameters:
molecularFormula
- Molecular formula- Returns:
- A reference to this Builder instance
-
molecularFormulaByMoiety
public SubstanceSpecification.Structure.Builder molecularFormulaByMoiety(String molecularFormulaByMoiety)
Convenience method for settingmolecularFormulaByMoiety
.- Parameters:
molecularFormulaByMoiety
- Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot- Returns:
- A reference to this Builder instance
- See Also:
molecularFormulaByMoiety(com.ibm.fhir.model.type.String)
-
molecularFormulaByMoiety
public SubstanceSpecification.Structure.Builder molecularFormulaByMoiety(String molecularFormulaByMoiety)
Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot.- Parameters:
molecularFormulaByMoiety
- Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot- Returns:
- A reference to this Builder instance
-
isotope
public SubstanceSpecification.Structure.Builder isotope(SubstanceSpecification.Structure.Isotope... isotope)
Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
isotope
- Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio- Returns:
- A reference to this Builder instance
-
isotope
public SubstanceSpecification.Structure.Builder isotope(Collection<SubstanceSpecification.Structure.Isotope> isotope)
Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio.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:
isotope
- Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException
- If the passed collection is null
-
molecularWeight
public SubstanceSpecification.Structure.Builder molecularWeight(SubstanceSpecification.Structure.Isotope.MolecularWeight molecularWeight)
The molecular weight or weight range (for proteins, polymers or nucleic acids).- Parameters:
molecularWeight
- The molecular weight or weight range (for proteins, polymers or nucleic acids)- Returns:
- A reference to this Builder instance
-
source
public SubstanceSpecification.Structure.Builder source(Reference... source)
Supporting literature.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.Allowed resource types for the references:
- Parameters:
source
- Supporting literature- Returns:
- A reference to this Builder instance
-
source
public SubstanceSpecification.Structure.Builder source(Collection<Reference> source)
Supporting literature.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.Allowed resource types for the references:
- Parameters:
source
- Supporting literature- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException
- If the passed collection is null
-
representation
public SubstanceSpecification.Structure.Builder representation(SubstanceSpecification.Structure.Representation... representation)
Molecular structural representation.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
representation
- Molecular structural representation- Returns:
- A reference to this Builder instance
-
representation
public SubstanceSpecification.Structure.Builder representation(Collection<SubstanceSpecification.Structure.Representation> representation)
Molecular structural representation.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:
representation
- Molecular structural representation- Returns:
- A reference to this Builder instance
- Throws:
NullPointerException
- If the passed collection is null
-
build
public SubstanceSpecification.Structure build()
Build theSubstanceSpecification.Structure
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
SubstanceSpecification.Structure
- Throws:
IllegalStateException
- if the current state cannot be built into a valid Structure per the base specification
-
validate
protected void validate(SubstanceSpecification.Structure structure)
-
from
protected SubstanceSpecification.Structure.Builder from(SubstanceSpecification.Structure structure)
-
-