Class ResearchStudy.Arm.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.ResearchStudy.Arm.Builder
-
- Enclosing class:
- ResearchStudy.Arm
public static class ResearchStudy.Arm.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 ResearchStudy.Arm
build()
Build theResearchStudy.Arm
ResearchStudy.Arm.Builder
description(java.lang.String description)
Convenience method for settingdescription
.ResearchStudy.Arm.Builder
description(String description)
A succinct description of the path through the study that would be followed by a subject adhering to this arm.ResearchStudy.Arm.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.ResearchStudy.Arm.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected ResearchStudy.Arm.Builder
from(ResearchStudy.Arm arm)
ResearchStudy.Arm.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).ResearchStudy.Arm.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.ResearchStudy.Arm.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.ResearchStudy.Arm.Builder
name(java.lang.String name)
Convenience method for settingname
.ResearchStudy.Arm.Builder
name(String name)
Unique, human-readable label for this arm of the study.ResearchStudy.Arm.Builder
type(CodeableConcept type)
Categorization of study arm, e.g.protected void
validate(ResearchStudy.Arm arm)
-
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 ResearchStudy.Arm.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 ResearchStudy.Arm.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 ResearchStudy.Arm.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 ResearchStudy.Arm.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 ResearchStudy.Arm.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
-
name
public ResearchStudy.Arm.Builder name(java.lang.String name)
Convenience method for settingname
.This element is required.
- Parameters:
name
- Label for study arm- Returns:
- A reference to this Builder instance
- See Also:
name(org.linuxforhealth.fhir.model.type.String)
-
name
public ResearchStudy.Arm.Builder name(String name)
Unique, human-readable label for this arm of the study.This element is required.
- Parameters:
name
- Label for study arm- Returns:
- A reference to this Builder instance
-
type
public ResearchStudy.Arm.Builder type(CodeableConcept type)
Categorization of study arm, e.g. experimental, active comparator, placebo comparater.- Parameters:
type
- Categorization of study arm- Returns:
- A reference to this Builder instance
-
description
public ResearchStudy.Arm.Builder description(java.lang.String description)
Convenience method for settingdescription
.- Parameters:
description
- Short explanation of study path- Returns:
- A reference to this Builder instance
- See Also:
description(org.linuxforhealth.fhir.model.type.String)
-
description
public ResearchStudy.Arm.Builder description(String description)
A succinct description of the path through the study that would be followed by a subject adhering to this arm.- Parameters:
description
- Short explanation of study path- Returns:
- A reference to this Builder instance
-
build
public ResearchStudy.Arm build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
ResearchStudy.Arm
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Arm per the base specification
-
validate
protected void validate(ResearchStudy.Arm arm)
-
from
protected ResearchStudy.Arm.Builder from(ResearchStudy.Arm arm)
-
-