org.apache.camel.builder.endpoint.dsl

Interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder, RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

Enclosing interface:

RobotFrameworkEndpointBuilderFactory

public static interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder
extends RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder, RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

Builder for endpoint for the Robot Framework component.

Method Summary

Modifier and Type	Method and Description
default RobotFrameworkEndpointBuilderFactory.AdvancedRobotFrameworkEndpointBuilder	advanced()
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	allowContextMapAll(boolean allowContextMapAll) Sets whether the context map should allow access to all details.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	allowContextMapAll(String allowContextMapAll) Sets whether the context map should allow access to all details.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	allowTemplateFromHeader(boolean allowTemplateFromHeader) Whether to allow to use resource template from header or not (default false).
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	allowTemplateFromHeader(String allowTemplateFromHeader) Whether to allow to use resource template from header or not (default false).
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	argumentFile(File argumentFile) A text file to read more arguments from.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	argumentFile(String argumentFile) A text file to read more arguments from.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	combinedTagStats(String combinedTagStats) Creates combined statistics based on tags.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	contentCache(boolean contentCache) Sets whether to use resource content cache or not.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	contentCache(String contentCache) Sets whether to use resource content cache or not.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	criticalTags(String criticalTags) Tests that have the given tags are considered critical.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	debugFile(File debugFile) A debug file that is written during execution.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	debugFile(String debugFile) A debug file that is written during execution.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	document(String document) Sets the documentation of the top-level tests suites.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	dryrun(boolean dryrun) Sets dryrun mode on use.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	dryrun(String dryrun) Sets dryrun mode on use.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	excludes(String excludes) Selects the tests cases by tags.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	exitOnFailure(boolean exitOnFailure) Sets robot to stop execution immediately if a critical test fails.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	exitOnFailure(String exitOnFailure) Sets robot to stop execution immediately if a critical test fails.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	includes(String includes) Selects the tests cases by tags.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	listener(String listener) Sets a single listener for monitoring tests execution.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	listeners(String listeners) Sets multiple listeners for monitoring tests execution.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	log(File log) Sets the path to the generated log file.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	log(String log) Sets the path to the generated log file.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	logLevel(String logLevel) Sets the threshold level for logging.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	logTitle(String logTitle) Sets a title for the generated tests log.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	metadata(String metadata) Sets free metadata for the top level tests suites.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	monitorColors(String monitorColors) Using ANSI colors in console.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	monitorWidth(String monitorWidth) Width of the monitor output.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	name(String name) Sets the name of the top-level tests suites.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	nonCriticalTags(String nonCriticalTags) Tests that have the given tags are not critical.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	noStatusReturnCode(boolean noStatusReturnCode) If true, sets the return code to zero regardless of failures in test cases.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	noStatusReturnCode(String noStatusReturnCode) If true, sets the return code to zero regardless of failures in test cases.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	output(File output) Sets the path to the generated output file.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	output(String output) Sets the path to the generated output file.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	outputDirectory(File outputDirectory) Configures where generated reports are to be placed.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	outputDirectory(String outputDirectory) Configures where generated reports are to be placed.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	randomize(String randomize) Sets the test execution order to be randomized.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	report(File report) Sets the path to the generated report file.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	report(String report) Sets the path to the generated report file.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	reportBackground(String reportBackground) Sets background colors for the generated report and summary.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	reportTitle(String reportTitle) Sets a title for the generated tests report.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	runEmptySuite(boolean runEmptySuite) Executes tests also if the top level test suite is empty.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	runEmptySuite(String runEmptySuite) Executes tests also if the top level test suite is empty.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	runFailed(File runFailed) Re-run failed tests, based on output.xml file.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	runFailed(String runFailed) Re-run failed tests, based on output.xml file.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	runMode(String runMode) Sets the execution mode for this tests run.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	skipTeardownOnExit(boolean skipTeardownOnExit) Sets whether the teardowns are skipped if the test execution is prematurely stopped.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	skipTeardownOnExit(String skipTeardownOnExit) Sets whether the teardowns are skipped if the test execution is prematurely stopped.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	splitOutputs(String splitOutputs) Splits output and log files.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	suites(String suites) Selects the tests suites by name.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	suiteStatLevel(String suiteStatLevel) Defines how many levels to show in the Statistics by Suite table in outputs.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	summaryTitle(String summaryTitle) Sets a title for the generated summary report.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	tagDocs(String tagDocs) Adds documentation to the specified tags.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	tags(String tags) Sets the tags(s) to all executed tests cases.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	tagStatExcludes(String tagStatExcludes) Excludes these tags from the Statistics by Tag and Test Details by Tag tables in outputs.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	tagStatIncludes(String tagStatIncludes) Includes only these tags in the Statistics by Tag and Test Details by Tag tables in outputs.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	tagStatLinks(String tagStatLinks) Adds external links to the Statistics by Tag table in outputs.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	tests(String tests) Selects the tests cases by name.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	timestampOutputs(boolean timestampOutputs) Adds a timestamp to all output files.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	timestampOutputs(String timestampOutputs) Adds a timestamp to all output files.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	variableFiles(String variableFiles) Sets variables using variables files.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	variables(String variables) Sets individual variables.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	warnOnSkippedFiles(boolean warnOnSkippedFiles) Show a warning when an invalid file is skipped.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	warnOnSkippedFiles(String warnOnSkippedFiles) Show a warning when an invalid file is skipped.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	xunitFile(File xunitFile) Sets the path to the generated XUnit compatible result file, relative to outputDirectory.
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder	xunitFile(String xunitFile) Sets the path to the generated XUnit compatible result file, relative to outputDirectory.

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, bridgeErrorHandler, bridgeErrorHandler, delay, delay, greedy, greedy, initialDelay, initialDelay, repeatCount, repeatCount, runLoggingLevel, runLoggingLevel, scheduledExecutorService, scheduledExecutorService, scheduler, scheduler, schedulerProperties, schedulerProperties, sendEmptyMessageWhenIdle, sendEmptyMessageWhenIdle, startScheduler, startScheduler, timeUnit, timeUnit, useFixedDelay, useFixedDelay

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

lazyStartProducer, lazyStartProducer

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default RobotFrameworkEndpointBuilderFactory.AdvancedRobotFrameworkEndpointBuilder advanced()

Specified by:

advanced in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

advanced in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

allowContextMapAll

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder allowContextMapAll(boolean allowContextMapAll)

Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API. The option is a: boolean type. Default: false Group: common

Specified by:

allowContextMapAll in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

allowContextMapAll in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

allowContextMapAll

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder allowContextMapAll(String allowContextMapAll)

Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API. The option will be converted to a boolean type. Default: false Group: common

Specified by:

allowContextMapAll in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

allowContextMapAll in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

allowTemplateFromHeader

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder 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

Specified by:

allowTemplateFromHeader in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

allowTemplateFromHeader in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

allowTemplateFromHeader

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder allowTemplateFromHeader(String 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 will be converted to a boolean type. Default: false Group: common

Specified by:

allowTemplateFromHeader in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

allowTemplateFromHeader in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

argumentFile

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder argumentFile(File argumentFile)

A text file to read more arguments from. The option is a: java.io.File type. Group: common

Specified by:

argumentFile in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

argumentFile in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

argumentFile

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder argumentFile(String argumentFile)

A text file to read more arguments from. The option will be converted to a java.io.File type. Group: common

Specified by:

argumentFile in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

argumentFile in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

combinedTagStats

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder 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

Specified by:

combinedTagStats in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

combinedTagStats in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

contentCache

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder contentCache(boolean contentCache)

Sets whether to use resource content cache or not. The option is a: boolean type. Default: false Group: common

Specified by:

contentCache in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

contentCache in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

contentCache

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder contentCache(String contentCache)

Sets whether to use resource content cache or not. The option will be converted to a boolean type. Default: false Group: common

Specified by:

contentCache in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

contentCache in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

criticalTags

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder criticalTags(String criticalTags)

Tests that have the given tags are considered critical. List. The option is a: java.lang.String type. Group: common

Specified by:

criticalTags in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

criticalTags in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

debugFile

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder debugFile(File debugFile)

A debug file that is written during execution. The option is a: java.io.File type. Group: common

Specified by:

debugFile in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

debugFile in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

debugFile

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder debugFile(String debugFile)

A debug file that is written during execution. The option will be converted to a java.io.File type. Group: common

Specified by:

debugFile in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

debugFile in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

document

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder document(String document)

Sets the documentation of the top-level tests suites. The option is a: java.lang.String type. Group: common

Specified by:

document in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

document in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

dryrun

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder 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

Specified by:

dryrun in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

dryrun in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

dryrun

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder dryrun(String 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 will be converted to a boolean type. Default: false Group: common

Specified by:

dryrun in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

dryrun in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

excludes

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder excludes(String excludes)

Selects the tests cases by tags. List. The option is a: java.lang.String type. Group: common

Specified by:

excludes in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

excludes in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

exitOnFailure

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder exitOnFailure(boolean exitOnFailure)

Sets robot to stop execution immediately if a critical test fails. The option is a: boolean type. Default: false Group: common

Specified by:

exitOnFailure in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

exitOnFailure in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

exitOnFailure

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder exitOnFailure(String exitOnFailure)

Sets robot to stop execution immediately if a critical test fails. The option will be converted to a boolean type. Default: false Group: common

Specified by:

exitOnFailure in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

exitOnFailure in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

includes

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder includes(String includes)

Selects the tests cases by tags. List. The option is a: java.lang.String type. Group: common

Specified by:

includes in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

includes in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

listener

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder listener(String listener)

Sets a single listener for monitoring tests execution. The option is a: java.lang.String type. Group: common

Specified by:

listener in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

listener in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

listeners

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder 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

Specified by:

listeners in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

listeners in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

log

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder log(File log)

Sets the path to the generated log file. The option is a: java.io.File type. Group: common

Specified by:

log in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

log in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

log

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder log(String log)

Sets the path to the generated log file. The option will be converted to a java.io.File type. Group: common

Specified by:

log in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

log in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

logLevel

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder logLevel(String logLevel)

Sets the threshold level for logging. The option is a: java.lang.String type. Group: common

Specified by:

logLevel in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

logLevel in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

logTitle

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder logTitle(String logTitle)

Sets a title for the generated tests log. The option is a: java.lang.String type. Group: common

Specified by:

logTitle in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

logTitle in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

metadata

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder 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

Specified by:

metadata in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

metadata in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

monitorColors

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder 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

Specified by:

monitorColors in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

monitorColors in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

monitorWidth

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder monitorWidth(String monitorWidth)

Width of the monitor output. Default is 78. The option is a: java.lang.String type. Default: 78 Group: common

Specified by:

monitorWidth in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

monitorWidth in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

name

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder name(String name)

Sets the name of the top-level tests suites. The option is a: java.lang.String type. Group: common

Specified by:

name in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

name in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

nonCriticalTags

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder nonCriticalTags(String nonCriticalTags)

Tests that have the given tags are not critical. List. The option is a: java.lang.String type. Group: common

Specified by:

nonCriticalTags in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

nonCriticalTags in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

noStatusReturnCode

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder 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

Specified by:

noStatusReturnCode in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

noStatusReturnCode in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

noStatusReturnCode

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder noStatusReturnCode(String noStatusReturnCode)

If true, sets the return code to zero regardless of failures in test cases. Error codes are returned normally. The option will be converted to a boolean type. Default: false Group: common

Specified by:

noStatusReturnCode in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

noStatusReturnCode in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

output

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder output(File output)

Sets the path to the generated output file. The option is a: java.io.File type. Group: common

Specified by:

output in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

output in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

output

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder output(String output)

Sets the path to the generated output file. The option will be converted to a java.io.File type. Group: common

Specified by:

output in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

output in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

outputDirectory

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder outputDirectory(File outputDirectory)

Configures where generated reports are to be placed. The option is a: java.io.File type. Group: common

Specified by:

outputDirectory in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

outputDirectory in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

outputDirectory

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder outputDirectory(String outputDirectory)

Configures where generated reports are to be placed. The option will be converted to a java.io.File type. Group: common

Specified by:

outputDirectory in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

outputDirectory in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

randomize

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder 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

Specified by:

randomize in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

randomize in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

report

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder report(File report)

Sets the path to the generated report file. The option is a: java.io.File type. Group: common

Specified by:

report in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

report in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

report

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder report(String report)

Sets the path to the generated report file. The option will be converted to a java.io.File type. Group: common

Specified by:

report in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

report in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

reportBackground

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder reportBackground(String reportBackground)

Sets background colors for the generated report and summary. The option is a: java.lang.String type. Group: common

Specified by:

reportBackground in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

reportBackground in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

reportTitle

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder reportTitle(String reportTitle)

Sets a title for the generated tests report. The option is a: java.lang.String type. Group: common

Specified by:

reportTitle in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

reportTitle in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

runEmptySuite

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder 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

Specified by:

runEmptySuite in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

runEmptySuite in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

runEmptySuite

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder runEmptySuite(String 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 will be converted to a boolean type. Default: false Group: common

Specified by:

runEmptySuite in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

runEmptySuite in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

runFailed

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder runFailed(File runFailed)

Re-run failed tests, based on output.xml file. The option is a: java.io.File type. Group: common

Specified by:

runFailed in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

runFailed in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

runFailed

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder runFailed(String runFailed)

Re-run failed tests, based on output.xml file. The option will be converted to a java.io.File type. Group: common

Specified by:

runFailed in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

runFailed in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

runMode

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder 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

Specified by:

runMode in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

runMode in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

skipTeardownOnExit

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder 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

Specified by:

skipTeardownOnExit in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

skipTeardownOnExit in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

skipTeardownOnExit

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder skipTeardownOnExit(String skipTeardownOnExit)

Sets whether the teardowns are skipped if the test execution is prematurely stopped. The option will be converted to a boolean type. Default: false Group: common

Specified by:

skipTeardownOnExit in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

skipTeardownOnExit in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

splitOutputs

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder splitOutputs(String splitOutputs)

Splits output and log files. The option is a: java.lang.String type. Group: common

Specified by:

splitOutputs in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

splitOutputs in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

suites

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder suites(String suites)

Selects the tests suites by name. List. The option is a: java.lang.String type. Group: common

Specified by:

suites in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

suites in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

suiteStatLevel

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder 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

Specified by:

suiteStatLevel in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

suiteStatLevel in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

summaryTitle

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder summaryTitle(String summaryTitle)

Sets a title for the generated summary report. The option is a: java.lang.String type. Group: common

Specified by:

summaryTitle in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

summaryTitle in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

tagDocs

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder tagDocs(String tagDocs)

Adds documentation to the specified tags. List. The option is a: java.lang.String type. Group: common

Specified by:

tagDocs in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

tagDocs in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

tags

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder tags(String tags)

Sets the tags(s) to all executed tests cases. List. The option is a: java.lang.String type. Group: common

Specified by:

tags in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

tags in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

tagStatExcludes

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder 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

Specified by:

tagStatExcludes in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

tagStatExcludes in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

tagStatIncludes

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder 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

Specified by:

tagStatIncludes in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

tagStatIncludes in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

tagStatLinks

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder 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

Specified by:

tagStatLinks in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

tagStatLinks in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

tests

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder tests(String tests)

Selects the tests cases by name. List. The option is a: java.lang.String type. Group: common

Specified by:

tests in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

tests in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

timestampOutputs

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder timestampOutputs(boolean timestampOutputs)

Adds a timestamp to all output files. The option is a: boolean type. Default: false Group: common

Specified by:

timestampOutputs in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

timestampOutputs in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

timestampOutputs

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder timestampOutputs(String timestampOutputs)

Adds a timestamp to all output files. The option will be converted to a boolean type. Default: false Group: common

Specified by:

timestampOutputs in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

timestampOutputs in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

variableFiles

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder variableFiles(String variableFiles)

Sets variables using variables files. Use the format path:args List. The option is a: java.lang.String type. Group: common

Specified by:

variableFiles in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

variableFiles in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

variables

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder variables(String variables)

Sets individual variables. Use the format name:value List. The option is a: java.lang.String type. Group: common

Specified by:

variables in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

variables in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

warnOnSkippedFiles

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder warnOnSkippedFiles(boolean warnOnSkippedFiles)

Show a warning when an invalid file is skipped. The option is a: boolean type. Default: false Group: common

Specified by:

warnOnSkippedFiles in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

warnOnSkippedFiles in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

warnOnSkippedFiles

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder warnOnSkippedFiles(String warnOnSkippedFiles)

Show a warning when an invalid file is skipped. The option will be converted to a boolean type. Default: false Group: common

Specified by:

warnOnSkippedFiles in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

warnOnSkippedFiles in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

xunitFile

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder 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

Specified by:

xunitFile in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

xunitFile in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder

xunitFile

default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder xunitFile(String 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 will be converted to a java.io.File type. Group: common

Specified by:

xunitFile in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder

Specified by:

xunitFile in interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder