Class ValueSet.Expansion.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.ValueSet.Expansion.Builder
-
- Enclosing class:
- ValueSet.Expansion
public static class ValueSet.Expansion.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 ValueSet.Expansion
build()
Build theValueSet.Expansion
ValueSet.Expansion.Builder
contains(java.util.Collection<ValueSet.Expansion.Contains> contains)
The codes that are contained in the value set expansion.ValueSet.Expansion.Builder
contains(ValueSet.Expansion.Contains... contains)
The codes that are contained in the value set expansion.ValueSet.Expansion.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.ValueSet.Expansion.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected ValueSet.Expansion.Builder
from(ValueSet.Expansion expansion)
ValueSet.Expansion.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).ValueSet.Expansion.Builder
identifier(Uri identifier)
An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc.ValueSet.Expansion.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.ValueSet.Expansion.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.ValueSet.Expansion.Builder
offset(java.lang.Integer offset)
Convenience method for settingoffset
.ValueSet.Expansion.Builder
offset(Integer offset)
If paging is being used, the offset at which this resource starts.ValueSet.Expansion.Builder
parameter(java.util.Collection<ValueSet.Expansion.Parameter> parameter)
A parameter that controlled the expansion process.ValueSet.Expansion.Builder
parameter(ValueSet.Expansion.Parameter... parameter)
A parameter that controlled the expansion process.ValueSet.Expansion.Builder
timestamp(DateTime timestamp)
The time at which the expansion was produced by the expanding system.ValueSet.Expansion.Builder
total(java.lang.Integer total)
Convenience method for settingtotal
.ValueSet.Expansion.Builder
total(Integer total)
The total number of concepts in the expansion.protected void
validate(ValueSet.Expansion expansion)
-
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 ValueSet.Expansion.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 ValueSet.Expansion.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 ValueSet.Expansion.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 ValueSet.Expansion.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 ValueSet.Expansion.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
-
identifier
public ValueSet.Expansion.Builder identifier(Uri identifier)
An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier.- Parameters:
identifier
- Identifies the value set expansion (business identifier)- Returns:
- A reference to this Builder instance
-
timestamp
public ValueSet.Expansion.Builder timestamp(DateTime timestamp)
The time at which the expansion was produced by the expanding system.This element is required.
- Parameters:
timestamp
- Time ValueSet expansion happened- Returns:
- A reference to this Builder instance
-
total
public ValueSet.Expansion.Builder total(java.lang.Integer total)
Convenience method for settingtotal
.- Parameters:
total
- Total number of codes in the expansion- Returns:
- A reference to this Builder instance
- See Also:
total(org.linuxforhealth.fhir.model.type.Integer)
-
total
public ValueSet.Expansion.Builder total(Integer total)
The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter.- Parameters:
total
- Total number of codes in the expansion- Returns:
- A reference to this Builder instance
-
offset
public ValueSet.Expansion.Builder offset(java.lang.Integer offset)
Convenience method for settingoffset
.- Parameters:
offset
- Offset at which this resource starts- Returns:
- A reference to this Builder instance
- See Also:
offset(org.linuxforhealth.fhir.model.type.Integer)
-
offset
public ValueSet.Expansion.Builder offset(Integer offset)
If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present.- Parameters:
offset
- Offset at which this resource starts- Returns:
- A reference to this Builder instance
-
parameter
public ValueSet.Expansion.Builder parameter(ValueSet.Expansion.Parameter... parameter)
A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
parameter
- Parameter that controlled the expansion process- Returns:
- A reference to this Builder instance
-
parameter
public ValueSet.Expansion.Builder parameter(java.util.Collection<ValueSet.Expansion.Parameter> parameter)
A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.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:
parameter
- Parameter that controlled the expansion process- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
contains
public ValueSet.Expansion.Builder contains(ValueSet.Expansion.Contains... contains)
The codes that are contained in the value set expansion.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
contains
- Codes in the value set- Returns:
- A reference to this Builder instance
-
contains
public ValueSet.Expansion.Builder contains(java.util.Collection<ValueSet.Expansion.Contains> contains)
The codes that are contained in the value set expansion.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:
contains
- Codes in the value set- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public ValueSet.Expansion build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
ValueSet.Expansion
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Expansion per the base specification
-
validate
protected void validate(ValueSet.Expansion expansion)
-
from
protected ValueSet.Expansion.Builder from(ValueSet.Expansion expansion)
-
-