Class TestScript.Variable
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.type.Element
-
- org.linuxforhealth.fhir.model.type.BackboneElement
-
- org.linuxforhealth.fhir.model.resource.TestScript.Variable
-
- All Implemented Interfaces:
Visitable
- Enclosing class:
- TestScript
public static class TestScript.Variable extends BackboneElement
Variable is set based either on element value in response body or on header field value in the response headers.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TestScript.Variable.Builder
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
modifierExtension
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static TestScript.Variable.Builder
builder()
boolean
equals(java.lang.Object obj)
String
getDefaultValue()
A default, hard-coded, or user-defined value for this variable.String
getDescription()
A free text natural language description of the variable and its purpose.String
getExpression()
The FHIRPath expression to evaluate against the fixture body.String
getHeaderField()
Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.String
getHint()
Displayable text string with hint help information to the user when entering a default value.String
getName()
Descriptive name for this variable.String
getPath()
XPath or JSONPath to evaluate against the fixture body.Id
getSourceId()
Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.boolean
hasChildren()
int
hashCode()
TestScript.Variable.Builder
toBuilder()
Create a new Builder from the contents of this Element-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
getModifierExtension
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element
as, getExtension, getId, hasValue, is
-
-
-
-
Method Detail
-
getName
public String getName()
Descriptive name for this variable.- Returns:
- An immutable object of type
String
that is non-null.
-
getDefaultValue
public String getDefaultValue()
A default, hard-coded, or user-defined value for this variable.- Returns:
- An immutable object of type
String
that may be null.
-
getDescription
public String getDescription()
A free text natural language description of the variable and its purpose.- Returns:
- An immutable object of type
String
that may be null.
-
getExpression
public String getExpression()
The FHIRPath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.- Returns:
- An immutable object of type
String
that may be null.
-
getHeaderField
public String getHeaderField()
Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.- Returns:
- An immutable object of type
String
that may be null.
-
getHint
public String getHint()
Displayable text string with hint help information to the user when entering a default value.- Returns:
- An immutable object of type
String
that may be null.
-
getPath
public String getPath()
XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.- Returns:
- An immutable object of type
String
that may be null.
-
getSourceId
public Id getSourceId()
Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.- Returns:
- An immutable object of type
Id
that may be null.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classBackboneElement
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public TestScript.Variable.Builder toBuilder()
Description copied from class:Element
Create a new Builder from the contents of this Element- Specified by:
toBuilder
in classBackboneElement
-
builder
public static TestScript.Variable.Builder builder()
-
-