Class SubstanceDefinition.Structure.Representation.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.SubstanceDefinition.Structure.Representation.Builder
-
- Enclosing class:
- SubstanceDefinition.Structure.Representation
public static class SubstanceDefinition.Structure.Representation.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 SubstanceDefinition.Structure.Representation
build()
SubstanceDefinition.Structure.Representation.Builder
document(Reference document)
An attached file with the structural representation or characterization e.g.SubstanceDefinition.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.SubstanceDefinition.Structure.Representation.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.SubstanceDefinition.Structure.Representation.Builder
format(CodeableConcept format)
The format of the representation e.g.protected SubstanceDefinition.Structure.Representation.Builder
from(SubstanceDefinition.Structure.Representation representation)
SubstanceDefinition.Structure.Representation.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).SubstanceDefinition.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.SubstanceDefinition.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.SubstanceDefinition.Structure.Representation.Builder
representation(java.lang.String representation)
Convenience method for settingrepresentation
.SubstanceDefinition.Structure.Representation.Builder
representation(String representation)
The structural representation or characterization as a text string in a standard format.SubstanceDefinition.Structure.Representation.Builder
type(CodeableConcept type)
The kind of structural representation (e.g.protected void
validate(SubstanceDefinition.Structure.Representation representation)
-
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 SubstanceDefinition.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 SubstanceDefinition.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 SubstanceDefinition.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 SubstanceDefinition.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 SubstanceDefinition.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 SubstanceDefinition.Structure.Representation.Builder type(CodeableConcept type)
The kind of structural representation (e.g. full, partial).- Parameters:
type
- The kind of structural representation (e.g. full, partial)- Returns:
- A reference to this Builder instance
-
representation
public SubstanceDefinition.Structure.Representation.Builder representation(java.lang.String representation)
Convenience method for settingrepresentation
.- Parameters:
representation
- The structural representation or characterization as a text string in a standard format- Returns:
- A reference to this Builder instance
- See Also:
representation(org.linuxforhealth.fhir.model.type.String)
-
representation
public SubstanceDefinition.Structure.Representation.Builder representation(String representation)
The structural representation or characterization as a text string in a standard format.- Parameters:
representation
- The structural representation or characterization as a text string in a standard format- Returns:
- A reference to this Builder instance
-
format
public SubstanceDefinition.Structure.Representation.Builder format(CodeableConcept format)
The format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF. The logical content type rather than the physical file format of a document.- Parameters:
format
- The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format)- Returns:
- A reference to this Builder instance
-
document
public SubstanceDefinition.Structure.Representation.Builder document(Reference document)
An attached file with the structural representation or characterization e.g. a molecular structure graphic of the substance, a JCAMP or AnIML file.Allowed resource types for this reference:
- Parameters:
document
- An attachment with the structural representation e.g. a structure graphic or AnIML file- Returns:
- A reference to this Builder instance
-
build
public SubstanceDefinition.Structure.Representation build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
SubstanceDefinition.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(SubstanceDefinition.Structure.Representation representation)
-
from
protected SubstanceDefinition.Structure.Representation.Builder from(SubstanceDefinition.Structure.Representation representation)
-
-