RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.robotframework.RobotFrameworkComponent>

All Known Implementing Classes:

RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilderImpl

Enclosing interface:

RobotframeworkComponentBuilderFactory
```
public static interface RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder
extends ComponentBuilder<org.apache.camel.component.robotframework.RobotFrameworkComponent>
```
Builder for the Robot Framework component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`allowTemplateFromHeader(boolean allowTemplateFromHeader)` Whether to allow to use resource template from header or not (default false).
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`argumentFile(File argumentFile)` A text file to read more arguments from.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`basicPropertyBinding(boolean basicPropertyBinding)` Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`bridgeErrorHandler(boolean bridgeErrorHandler)` Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`combinedTagStats(String combinedTagStats)` Creates combined statistics based on tags.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`configuration(org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration configuration)` The configuration.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`criticalTags(String criticalTags)` Tests that have the given tags are considered critical.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`debugFile(File debugFile)` A debug file that is written during execution.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`document(String document)` Sets the documentation of the top-level tests suites.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`dryrun(boolean dryrun)` Sets dryrun mode on use.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`excludes(String excludes)` Selects the tests cases by tags.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`exitOnFailure(boolean exitOnFailure)` Sets robot to stop execution immediately if a critical test fails.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`includes(String includes)` Selects the tests cases by tags.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`listener(String listener)` Sets a single listener for monitoring tests execution.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`listeners(String listeners)` Sets multiple listeners for monitoring tests execution.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`log(File log)` Sets the path to the generated log file.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`logLevel(String logLevel)` Sets the threshold level for logging.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`logTitle(String logTitle)` Sets a title for the generated tests log.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`metadata(String metadata)` Sets free metadata for the top level tests suites.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`monitorColors(String monitorColors)` Using ANSI colors in console.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`monitorWidth(String monitorWidth)` Width of the monitor output.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`name(String name)` Sets the name of the top-level tests suites.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`nonCriticalTags(String nonCriticalTags)` Tests that have the given tags are not critical.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`noStatusReturnCode(boolean noStatusReturnCode)` If true, sets the return code to zero regardless of failures in test cases.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`output(File output)` Sets the path to the generated output file.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`outputDirectory(File outputDirectory)` Configures where generated reports are to be placed.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`randomize(String randomize)` Sets the test execution order to be randomized.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`report(File report)` Sets the path to the generated report file.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`reportBackground(String reportBackground)` Sets background colors for the generated report and summary.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`reportTitle(String reportTitle)` Sets a title for the generated tests report.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`runEmptySuite(boolean runEmptySuite)` Executes tests also if the top level test suite is empty.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`runFailed(File runFailed)` Re-run failed tests, based on output.xml file.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`runMode(String runMode)` Sets the execution mode for this tests run.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`skipTeardownOnExit(boolean skipTeardownOnExit)` Sets whether the teardowns are skipped if the test execution is prematurely stopped.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`splitOutputs(String splitOutputs)` Splits output and log files.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`suites(String suites)` Selects the tests suites by name.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`suiteStatLevel(String suiteStatLevel)` Defines how many levels to show in the Statistics by Suite table in outputs.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`summaryTitle(String summaryTitle)` Sets a title for the generated summary report.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`tagDocs(String tagDocs)` Adds documentation to the specified tags.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`tags(String tags)` Sets the tags(s) to all executed tests cases.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`tagStatExcludes(String tagStatExcludes)` Excludes these tags from the Statistics by Tag and Test Details by Tag tables in outputs.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`tagStatIncludes(String tagStatIncludes)` Includes only these tags in the Statistics by Tag and Test Details by Tag tables in outputs.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`tagStatLinks(String tagStatLinks)` Adds external links to the Statistics by Tag table in outputs.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`tests(String tests)` Selects the tests cases by name.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`timestampOutputs(boolean timestampOutputs)` Adds a timestamp to all output files.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`variableFiles(String variableFiles)` Sets variables using variables files.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`variables(String variables)` Sets individual variables.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`warnOnSkippedFiles(boolean warnOnSkippedFiles)` Show a warning when an invalid file is skipped.
`default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder`	`xunitFile(File xunitFile)` Sets the path to the generated XUnit compatible result file, relative to outputDirectory.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register

- Method Detail
  - allowTemplateFromHeader
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder allowTemplateFromHeader(boolean allowTemplateFromHeader)
```
    Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care. The option is a: boolean type. Default: false Group: common
  - argumentFile
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder argumentFile(File argumentFile)
```
    A text file to read more arguments from. The option is a: java.io.File type. Group: common
  - combinedTagStats
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder combinedTagStats(String combinedTagStats)
```
    Creates combined statistics based on tags. Use the format tags:title List. The option is a: java.lang.String type. Group: common
  - criticalTags
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder criticalTags(String criticalTags)
```
    Tests that have the given tags are considered critical. List. The option is a: java.lang.String type. Group: common
  - debugFile
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder debugFile(File debugFile)
```
    A debug file that is written during execution. The option is a: java.io.File type. Group: common
  - document
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder document(String document)
```
    Sets the documentation of the top-level tests suites. The option is a: java.lang.String type. Group: common
  - dryrun
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder dryrun(boolean dryrun)
```
    Sets dryrun mode on use. In the dry run mode tests are run without executing keywords originating from test libraries. Useful for validating test data syntax. The option is a: boolean type. Default: false Group: common
  - excludes
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder excludes(String excludes)
```
    Selects the tests cases by tags. List. The option is a: java.lang.String type. Group: common
  - exitOnFailure
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder exitOnFailure(boolean exitOnFailure)
```
    Sets robot to stop execution immediately if a critical test fails. The option is a: boolean type. Default: false Group: common
  - includes
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder includes(String includes)
```
    Selects the tests cases by tags. List. The option is a: java.lang.String type. Group: common
  - listener
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder listener(String listener)
```
    Sets a single listener for monitoring tests execution. The option is a: java.lang.String type. Group: common
  - listeners
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder listeners(String listeners)
```
    Sets multiple listeners for monitoring tests execution. Use the format ListenerWithArgs:arg1:arg2 or simply ListenerWithoutArgs List. The option is a: java.lang.String type. Group: common
  - log
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder log(File log)
```
    Sets the path to the generated log file. The option is a: java.io.File type. Group: common
  - logLevel
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder logLevel(String logLevel)
```
    Sets the threshold level for logging. The option is a: java.lang.String type. Group: common
  - logTitle
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder logTitle(String logTitle)
```
    Sets a title for the generated tests log. The option is a: java.lang.String type. Group: common
  - metadata
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder metadata(String metadata)
```
    Sets free metadata for the top level tests suites. comma seperated list of string resulting as List. The option is a: java.lang.String type. Group: common
  - monitorColors
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder monitorColors(String monitorColors)
```
    Using ANSI colors in console. Normally colors work in unixes but not in Windows. Default is 'on'. 'on' - use colors in unixes but not in Windows 'off' - never use colors 'force' - always use colors (also in Windows). The option is a: java.lang.String type. Group: common
  - monitorWidth
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder monitorWidth(String monitorWidth)
```
    Width of the monitor output. Default is 78. The option is a: java.lang.String type. Default: 78 Group: common
  - name
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder name(String name)
```
    Sets the name of the top-level tests suites. The option is a: java.lang.String type. Group: common
  - nonCriticalTags
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder nonCriticalTags(String nonCriticalTags)
```
    Tests that have the given tags are not critical. List. The option is a: java.lang.String type. Group: common
  - noStatusReturnCode
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder noStatusReturnCode(boolean noStatusReturnCode)
```
    If true, sets the return code to zero regardless of failures in test cases. Error codes are returned normally. The option is a: boolean type. Default: false Group: common
  - output
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder output(File output)
```
    Sets the path to the generated output file. The option is a: java.io.File type. Group: common
  - outputDirectory
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder outputDirectory(File outputDirectory)
```
    Configures where generated reports are to be placed. The option is a: java.io.File type. Group: common
  - randomize
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder randomize(String randomize)
```
    Sets the test execution order to be randomized. Valid values are all, suite, and test. The option is a: java.lang.String type. Group: common
  - report
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder report(File report)
```
    Sets the path to the generated report file. The option is a: java.io.File type. Group: common
  - reportBackground
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder reportBackground(String reportBackground)
```
    Sets background colors for the generated report and summary. The option is a: java.lang.String type. Group: common
  - reportTitle
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder reportTitle(String reportTitle)
```
    Sets a title for the generated tests report. The option is a: java.lang.String type. Group: common
  - runEmptySuite
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder runEmptySuite(boolean runEmptySuite)
```
    Executes tests also if the top level test suite is empty. Useful e.g. with --include/--exclude when it is not an error that no test matches the condition. The option is a: boolean type. Default: false Group: common
  - runFailed
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder runFailed(File runFailed)
```
    Re-run failed tests, based on output.xml file. The option is a: java.io.File type. Group: common
  - runMode
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder runMode(String runMode)
```
    Sets the execution mode for this tests run. Note that this setting has been deprecated in Robot Framework 2.8. Use separate dryryn, skipTeardownOnExit, exitOnFailure, and randomize settings instead. The option is a: java.lang.String type. Group: common
  - skipTeardownOnExit
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder skipTeardownOnExit(boolean skipTeardownOnExit)
```
    Sets whether the teardowns are skipped if the test execution is prematurely stopped. The option is a: boolean type. Default: false Group: common
  - splitOutputs
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder splitOutputs(String splitOutputs)
```
    Splits output and log files. The option is a: java.lang.String type. Group: common
  - suites
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder suites(String suites)
```
    Selects the tests suites by name. List. The option is a: java.lang.String type. Group: common
  - suiteStatLevel
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder suiteStatLevel(String suiteStatLevel)
```
    Defines how many levels to show in the Statistics by Suite table in outputs. The option is a: java.lang.String type. Group: common
  - summaryTitle
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder summaryTitle(String summaryTitle)
```
    Sets a title for the generated summary report. The option is a: java.lang.String type. Group: common
  - tagDocs
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder tagDocs(String tagDocs)
```
    Adds documentation to the specified tags. List. The option is a: java.lang.String type. Group: common
  - tags
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder tags(String tags)
```
    Sets the tags(s) to all executed tests cases. List. The option is a: java.lang.String type. Group: common
  - tagStatExcludes
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder tagStatExcludes(String tagStatExcludes)
```
    Excludes these tags from the Statistics by Tag and Test Details by Tag tables in outputs. List. The option is a: java.lang.String type. Group: common
  - tagStatIncludes
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder tagStatIncludes(String tagStatIncludes)
```
    Includes only these tags in the Statistics by Tag and Test Details by Tag tables in outputs. List. The option is a: java.lang.String type. Group: common
  - tagStatLinks
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder tagStatLinks(String tagStatLinks)
```
    Adds external links to the Statistics by Tag table in outputs. Use the format pattern:link:title List. The option is a: java.lang.String type. Group: common
  - tests
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder tests(String tests)
```
    Selects the tests cases by name. List. The option is a: java.lang.String type. Group: common
  - timestampOutputs
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder timestampOutputs(boolean timestampOutputs)
```
    Adds a timestamp to all output files. The option is a: boolean type. Default: false Group: common
  - variableFiles
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder variableFiles(String variableFiles)
```
    Sets variables using variables files. Use the format path:args List. The option is a: java.lang.String type. Group: common
  - variables
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder variables(String variables)
```
    Sets individual variables. Use the format name:value List. The option is a: java.lang.String type. Group: common
  - warnOnSkippedFiles
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder warnOnSkippedFiles(boolean warnOnSkippedFiles)
```
    Show a warning when an invalid file is skipped. The option is a: boolean type. Default: false Group: common
  - xunitFile
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder xunitFile(File xunitFile)
```
    Sets the path to the generated XUnit compatible result file, relative to outputDirectory. The file is in xml format. By default, the file name is derived from the testCasesDirectory parameter, replacing blanks in the directory name by underscores. The option is a: java.io.File type. Group: common
  - bridgeErrorHandler
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
```
    Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: boolean type. Default: false Group: consumer
  - lazyStartProducer
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder lazyStartProducer(boolean lazyStartProducer)
```
    Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: boolean type. Default: false Group: producer
  - basicPropertyBinding
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder basicPropertyBinding(boolean basicPropertyBinding)
```
    Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a: boolean type. Default: false Group: advanced
  - configuration
```
default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder configuration(org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration configuration)
```
    The configuration. The option is a: org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration type. Group: advanced

Interface RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

Method Detail

allowTemplateFromHeader

argumentFile

combinedTagStats

criticalTags

debugFile

document

dryrun

excludes

exitOnFailure

includes

listener

listeners

log

logLevel

logTitle

metadata

monitorColors

monitorWidth

name

nonCriticalTags

noStatusReturnCode

output

outputDirectory

randomize

report

reportBackground

reportTitle

runEmptySuite

runFailed

runMode

skipTeardownOnExit

splitOutputs

suites

suiteStatLevel

summaryTitle

tagDocs

tags

tagStatExcludes

tagStatIncludes

tagStatLinks

tests

timestampOutputs

variableFiles

variables

warnOnSkippedFiles

xunitFile

bridgeErrorHandler

lazyStartProducer

basicPropertyBinding

configuration