Package org.citrusframework.functions.core

Class SubstringFunction

java.lang.Object

org.citrusframework.functions.core.SubstringFunction

All Implemented Interfaces:

org.citrusframework.functions.Function, org.citrusframework.functions.ParameterizedFunction<SubstringFunction.Parameters>

public class SubstringFunction
extends Object
implements org.citrusframework.functions.ParameterizedFunction<SubstringFunction.Parameters>

Function implements simple substring functionality.

Function requires at least a target string and a beginIndex as function parameters. An optional endIndex may be given as function parameter, too. The parameter usage looks like this: substring(targetString, beginIndex, [endIndex]).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubstringFunction.Parameters

Nested classes/interfaces inherited from interface org.citrusframework.functions.ParameterizedFunction

org.citrusframework.functions.ParameterizedFunction.FunctionParameters

Field Summary

Fields inherited from interface org.citrusframework.functions.Function

functions, logger, RESOURCE_PATH

Constructor Summary

Constructors

Constructor	Description
SubstringFunction()

Method Summary

Modifier and Type	Method	Description
String	execute(SubstringFunction.Parameters params, org.citrusframework.context.TestContext context)
SubstringFunction.Parameters	getParameters()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.citrusframework.functions.ParameterizedFunction

execute

Constructor Details

SubstringFunction

public SubstringFunction()

Method Details

execute

public String execute(SubstringFunction.Parameters params,
 org.citrusframework.context.TestContext context)

Specified by:

execute in interface org.citrusframework.functions.ParameterizedFunction<SubstringFunction.Parameters>

getParameters

public SubstringFunction.Parameters getParameters()

Specified by:

getParameters in interface org.citrusframework.functions.ParameterizedFunction<SubstringFunction.Parameters>