Class SubstanceSpecification.Structure.Representation.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.Representation.Builder
-
- Enclosing class:
- SubstanceSpecification.Structure.Representation
public static class SubstanceSpecification.Structure.Representation.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.Representation.Builder
attachment(Attachment attachment)
An attached file with the structural representation.SubstanceSpecification.Structure.Representation
build()
SubstanceSpecification.Structure.Representation.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.SubstanceSpecification.Structure.Representation.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.protected SubstanceSpecification.Structure.Representation.Builder
from(SubstanceSpecification.Structure.Representation representation)
SubstanceSpecification.Structure.Representation.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).SubstanceSpecification.Structure.Representation.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.Representation.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.SubstanceSpecification.Structure.Representation.Builder
representation(String representation)
The structural representation as text string in a format e.g.SubstanceSpecification.Structure.Representation.Builder
representation(java.lang.String representation)
Convenience method for settingrepresentation
.SubstanceSpecification.Structure.Representation.Builder
type(CodeableConcept type)
The type of structure (e.g.protected void
validate(SubstanceSpecification.Structure.Representation representation)
-
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.Representation.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 SubstanceSpecification.Structure.Representation.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.Representation.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 SubstanceSpecification.Structure.Representation.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.Representation.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 SubstanceSpecification.Structure.Representation.Builder type(CodeableConcept type)
The type of structure (e.g. Full, Partial, Representative).- Parameters:
type
- The type of structure (e.g. Full, Partial, Representative)- Returns:
- A reference to this Builder instance
-
representation
public SubstanceSpecification.Structure.Representation.Builder representation(java.lang.String representation)
Convenience method for settingrepresentation
.- Parameters:
representation
- The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX- Returns:
- A reference to this Builder instance
- See Also:
representation(com.ibm.fhir.model.type.String)
-
representation
public SubstanceSpecification.Structure.Representation.Builder representation(String representation)
The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX.- Parameters:
representation
- The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX- Returns:
- A reference to this Builder instance
-
attachment
public SubstanceSpecification.Structure.Representation.Builder attachment(Attachment attachment)
An attached file with the structural representation.- Parameters:
attachment
- An attached file with the structural representation- Returns:
- A reference to this Builder instance
-
build
public SubstanceSpecification.Structure.Representation build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
SubstanceSpecification.Structure.Representation
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Representation per the base specification
-
validate
protected void validate(SubstanceSpecification.Structure.Representation representation)
-
from
protected SubstanceSpecification.Structure.Representation.Builder from(SubstanceSpecification.Structure.Representation representation)
-
-