Class TestScript.Variable.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.TestScript.Variable.Builder
-
- Enclosing class:
- TestScript.Variable
public static class TestScript.Variable.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 TestScript.Variable
build()
Build theTestScript.Variable
TestScript.Variable.Builder
defaultValue(java.lang.String defaultValue)
Convenience method for settingdefaultValue
.TestScript.Variable.Builder
defaultValue(String defaultValue)
A default, hard-coded, or user-defined value for this variable.TestScript.Variable.Builder
description(java.lang.String description)
Convenience method for settingdescription
.TestScript.Variable.Builder
description(String description)
A free text natural language description of the variable and its purpose.TestScript.Variable.Builder
expression(java.lang.String expression)
Convenience method for settingexpression
.TestScript.Variable.Builder
expression(String expression)
The FHIRPath expression to evaluate against the fixture body.TestScript.Variable.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.TestScript.Variable.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected TestScript.Variable.Builder
from(TestScript.Variable variable)
TestScript.Variable.Builder
headerField(java.lang.String headerField)
Convenience method for settingheaderField
.TestScript.Variable.Builder
headerField(String headerField)
Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.TestScript.Variable.Builder
hint(java.lang.String hint)
Convenience method for settinghint
.TestScript.Variable.Builder
hint(String hint)
Displayable text string with hint help information to the user when entering a default value.TestScript.Variable.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).TestScript.Variable.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.TestScript.Variable.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.TestScript.Variable.Builder
name(java.lang.String name)
Convenience method for settingname
.TestScript.Variable.Builder
name(String name)
Descriptive name for this variable.TestScript.Variable.Builder
path(java.lang.String path)
Convenience method for settingpath
.TestScript.Variable.Builder
path(String path)
XPath or JSONPath to evaluate against the fixture body.TestScript.Variable.Builder
sourceId(Id sourceId)
Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.protected void
validate(TestScript.Variable variable)
-
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 TestScript.Variable.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 TestScript.Variable.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 TestScript.Variable.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 TestScript.Variable.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 TestScript.Variable.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 TestScript.Variable.Builder name(java.lang.String name)
Convenience method for settingname
.This element is required.
- Parameters:
name
- Descriptive name for this variable- Returns:
- A reference to this Builder instance
- See Also:
name(org.linuxforhealth.fhir.model.type.String)
-
name
public TestScript.Variable.Builder name(String name)
Descriptive name for this variable.This element is required.
- Parameters:
name
- Descriptive name for this variable- Returns:
- A reference to this Builder instance
-
defaultValue
public TestScript.Variable.Builder defaultValue(java.lang.String defaultValue)
Convenience method for settingdefaultValue
.- Parameters:
defaultValue
- Default, hard-coded, or user-defined value for this variable- Returns:
- A reference to this Builder instance
- See Also:
defaultValue(org.linuxforhealth.fhir.model.type.String)
-
defaultValue
public TestScript.Variable.Builder defaultValue(String defaultValue)
A default, hard-coded, or user-defined value for this variable.- Parameters:
defaultValue
- Default, hard-coded, or user-defined value for this variable- Returns:
- A reference to this Builder instance
-
description
public TestScript.Variable.Builder description(java.lang.String description)
Convenience method for settingdescription
.- Parameters:
description
- Natural language description of the variable- Returns:
- A reference to this Builder instance
- See Also:
description(org.linuxforhealth.fhir.model.type.String)
-
description
public TestScript.Variable.Builder description(String description)
A free text natural language description of the variable and its purpose.- Parameters:
description
- Natural language description of the variable- Returns:
- A reference to this Builder instance
-
expression
public TestScript.Variable.Builder expression(java.lang.String expression)
Convenience method for settingexpression
.- Parameters:
expression
- The FHIRPath expression against the fixture body- Returns:
- A reference to this Builder instance
- See Also:
expression(org.linuxforhealth.fhir.model.type.String)
-
expression
public TestScript.Variable.Builder expression(String expression)
The FHIRPath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.- Parameters:
expression
- The FHIRPath expression against the fixture body- Returns:
- A reference to this Builder instance
-
headerField
public TestScript.Variable.Builder headerField(java.lang.String headerField)
Convenience method for settingheaderField
.- Parameters:
headerField
- HTTP header field name for source- Returns:
- A reference to this Builder instance
- See Also:
headerField(org.linuxforhealth.fhir.model.type.String)
-
headerField
public TestScript.Variable.Builder headerField(String headerField)
Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.- Parameters:
headerField
- HTTP header field name for source- Returns:
- A reference to this Builder instance
-
hint
public TestScript.Variable.Builder hint(java.lang.String hint)
Convenience method for settinghint
.- Parameters:
hint
- Hint help text for default value to enter- Returns:
- A reference to this Builder instance
- See Also:
hint(org.linuxforhealth.fhir.model.type.String)
-
hint
public TestScript.Variable.Builder hint(String hint)
Displayable text string with hint help information to the user when entering a default value.- Parameters:
hint
- Hint help text for default value to enter- Returns:
- A reference to this Builder instance
-
path
public TestScript.Variable.Builder path(java.lang.String path)
Convenience method for settingpath
.- Parameters:
path
- XPath or JSONPath against the fixture body- Returns:
- A reference to this Builder instance
- See Also:
path(org.linuxforhealth.fhir.model.type.String)
-
path
public TestScript.Variable.Builder path(String path)
XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.- Parameters:
path
- XPath or JSONPath against the fixture body- Returns:
- A reference to this Builder instance
-
sourceId
public TestScript.Variable.Builder sourceId(Id sourceId)
Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.- Parameters:
sourceId
- Fixture Id of source expression or headerField within this variable- Returns:
- A reference to this Builder instance
-
build
public TestScript.Variable build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
TestScript.Variable
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Variable per the base specification
-
validate
protected void validate(TestScript.Variable variable)
-
from
protected TestScript.Variable.Builder from(TestScript.Variable variable)
-
-