IncludeController (Apache JMeter dist API)
Description: declaration: package: org.apache.jmeter.control, class: IncludeController

Package org.apache.jmeter.control

# Class IncludeController

java.lang.Object
org.apache.jmeter.testelement.AbstractTestElement
org.apache.jmeter.control.GenericController
org.apache.jmeter.control.IncludeController

All Implemented Interfaces:
  `Serializable`, `Cloneable`, `Controller`, `ReplaceableController`, `Searchable`, `org.apache.jmeter.testelement.TestElement`, `TestCompilerHelper`

public class IncludeController extends GenericController implements ReplaceableController

See Also:
  - Serialized Form

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from interface org.apache.jmeter.testelement.TestElement

  `org.apache.jmeter.testelement.TestElement.Companion`

- ## Field Summary

  ### Fields inherited from class org.apache.jmeter.control.GenericController

  `current, subControllersAndSamplers`

  ### Fields inherited from interface org.apache.jmeter.testelement.TestElement

  `COMMENTS, Companion, ENABLED, GUI_CLASS, NAME, TEST_CLASS`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `IncludeController()`
  No-arg constructor

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Object`
  `clone()`
  `String`
  `getIncludePath()`
  return the JMX file path.
  `org.apache.jmeter.testelement.schema.PropertiesAccessor<? extends IncludeController,? extends org.apache.jmeter.control.IncludeControllerSchema>`
  `getProps()`
  `org.apache.jmeter.testelement.TestElement`
  `getReplacementElement()`
  `HashTree`
  `getReplacementSubTree()`
  The way ReplaceableController works is clone is called first, followed by replace(HashTree) and finally getReplacement().
  `org.apache.jmeter.control.IncludeControllerSchema`
  `getSchema()`
  `protected HashTree`
  `loadIncludedElements()`
  load the included elements using SaveService
  `void`
  `resolveReplacementSubTree(JMeterTreeNode context)`
  Compute the replacement tree.
  `void`
  `setIncludePath(String jmxfile)`
  In the event an user wants to include an external JMX test plan the GUI would call this.

  ### Methods inherited from class org.apache.jmeter.control.GenericController

  `addIterationListener, addTestElement, addTestElementOnce, currentReturnedNull, fireIterationStart, fireIterEvents, getCurrentElement, getIterCount, getSubControllers, incrementCurrent, incrementIterCount, initialize, initializeSubControllers, isDone, isFirst, next, nextIsAController, nextIsASampler, nextIsNull, readResolve, reInitialize, removeCurrentElement, removeIterationListener, resetCurrent, resetIterCount, setCurrentElement, setDone, setFirst, triggerEndOfLoop`

  ### Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement

  `addPropertiesValues, addProperty, addProperty, canRemove, clear, clearTemporary, clearTestElementChildren, emptyTemporary, equals, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getPropertyOrNull, getSearchableTokens, getThreadContext, getThreadName, hashCode, isEnabled, isRunningVersion, isTemporary, logProperties, mergeIn, propertyIterator, recoverRunningVersion, removeProperty, setComment, setEnabled, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse, traverseCollection, traverseMap, traverseProperty`

  ### Methods inherited from class java.lang.Object

  `finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

  ### Methods inherited from interface org.apache.jmeter.testelement.TestElement

  `canRemove, clear, clearTestElementChildren, get, get, get, get, get, get, get, get, get, getComment, getName, getOrCreate, getOrCreate, getOrNull, getOrNull, getOrNull, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getPropertyOrNull, getPropertyOrNull, getString, getThreadContext, getThreadName, isEnabled, isRunningVersion, isTemporary, propertyIterator, recoverRunningVersion, removed, removeProperty, removeProperty, set, set, set, set, set, set, set, set, set, setComment, setEnabled, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse`

- ## Constructor Details

  - ### IncludeController

    public IncludeController()
    No-arg constructor
    See Also:
      - `Object()`

- ## Method Details

  - ### getSchema

    public org.apache.jmeter.control.IncludeControllerSchema getSchema()
    Specified by:
      `getSchema` in interface `org.apache.jmeter.testelement.TestElement`
    Overrides:
      `getSchema` in class `GenericController`

  - ### getProps

    public org.apache.jmeter.testelement.schema.PropertiesAccessor<? extends IncludeController,? extends org.apache.jmeter.control.IncludeControllerSchema> getProps()
    Specified by:
      `getProps` in interface `org.apache.jmeter.testelement.TestElement`
    Overrides:
      `getProps` in class `GenericController`

  - ### clone

    public Object clone()
    Specified by:
      `clone` in interface `org.apache.jmeter.testelement.TestElement`
    Overrides:
      `clone` in class `AbstractTestElement`

  - ### setIncludePath

    public void setIncludePath(String jmxfile)
    In the event an user wants to include an external JMX test plan the GUI would call this.
    Parameters:
      `jmxfile` - The path to the JMX test plan to include

  - ### getIncludePath

    public String getIncludePath()
    return the JMX file path.
    Returns:
      the JMX file path

  - ### getReplacementSubTree

    public HashTree getReplacementSubTree()
    The way ReplaceableController works is clone is called first, followed by replace(HashTree) and finally getReplacement().
    Specified by:
      `getReplacementSubTree` in interface `ReplaceableController`
    Returns:
      The replaced sub tree
    See Also:
      - `HashTree`

  - ### getReplacementElement

    public org.apache.jmeter.testelement.TestElement getReplacementElement()

  - ### resolveReplacementSubTree

    public void resolveReplacementSubTree(JMeterTreeNode context)
    Description copied from interface: `ReplaceableController`
    Compute the replacement tree.
    Specified by:
      `resolveReplacementSubTree` in interface `ReplaceableController`
    Parameters:
      `context` - the starting point of the replacement

  - ### loadIncludedElements

    protected HashTree loadIncludedElements()
    load the included elements using SaveService
    Returns:
      tree with loaded elements