StringUtils

Inclusion file:

include "string_utils.iol" from string_utils import StringUtils

Inclusion code:

Service Deployment
Port Name	Location	Protocol	Interfaces
StringUtils documentation:
StringUtils	-	-	StringUtilsInterface

List of Available Interfaces

StringUtilsInterface

Interface documentation: An interface for supporting string manipulation operations.

Operation Name	Input Type	Output Type
leftPad	PadRequest	string
valueToPrettyString	undefined	string
toLowerCase	string	string
length	string	int
match	MatchRequest	MatchResult
replaceFirst	ReplaceRequest	string
sort	StringItemList	StringItemList
replaceAll	ReplaceRequest	string
substring	SubStringRequest	string
getRandomUUID	void	string
rightPad	PadRequest	string
contains	ContainsRequest	bool
split	SplitRequest	SplitResult
splitByLength	SplitByLengthRequest	SplitResult
trim	string	string
find	MatchRequest	MatchResult
endsWith	EndsWithRequest	bool
toUpperCase	string	string
join	JoinRequest	string
indexOf	IndexOfRequest	IndexOfResponse
startsWith	StartsWithRequest	bool

Operation Description

leftPad

Operation documentation: Returns true if the string contains .substring

Invocation template:

leftPad@StringUtils( request )( response )

Request type

Type: PadRequest

type PadRequest: string {
    .length: int
    .char: string
}

PadRequest : string

length : int
char : string

Response type

Type: string

string : string

valueToPrettyString

Operation documentation: take a custom data type / simple type and return it's literal indented representation (string)

Invocation template:

valueToPrettyString@StringUtils( request )( response )

Request type

Type: undefined

undefined : any

Response type

Type: string

string : string

toLowerCase

Operation documentation: Returns true if the string contains .substring

Invocation template:

toLowerCase@StringUtils( request )( response )

Request type

Type: string

string : string

Response type

Type: string

string : string

length

Operation documentation: Returns true if the string contains .substring

Invocation template:

length@StringUtils( request )( response )

Request type

Type: string

string : string

Response type

Type: int

int : int

match

Operation documentation: Returns true if the string contains .substring

Invocation template:

match@StringUtils( request )( response )

Request type

Type: MatchRequest

type MatchRequest: string {
    .regex: string
}

MatchRequest : string

regex : string

Response type

Type: MatchResult

type MatchResult: int {
    .group*: string
}

MatchResult : int

group : string

replaceFirst

Operation documentation: Returns true if the string contains .substring

Invocation template:

replaceFirst@StringUtils( request )( response )

Request type

Type: ReplaceRequest

type ReplaceRequest: string {
    .regex: string
    .replacement: string
}

ReplaceRequest : string

regex : string
replacement : string

Response type

Type: string

string : string

sort

Operation documentation: Returns true if the string contains .substring

Invocation template:

sort@StringUtils( request )( response )

Request type

Type: StringItemList

type StringItemList: void {
    .item*: string
}

StringItemList : void

item : string

Response type

Type: StringItemList

type StringItemList: void {
    .item*: string
}

StringItemList : void

item : string

replaceAll

Operation documentation: Returns true if the string contains .substring

Invocation template:

replaceAll@StringUtils( request )( response )

Request type

Type: ReplaceRequest

type ReplaceRequest: string {
    .regex: string
    .replacement: string
}

ReplaceRequest : string

regex : string
replacement : string

Response type

Type: string

string : string

substring

Operation documentation: Returns true if the string contains .substring

Invocation template:

substring@StringUtils( request )( response )

Request type

Type: SubStringRequest

type SubStringRequest: string {
    .end: int
    .begin: int
}

SubStringRequest : string

end : int
begin : int

Response type

Type: string

string : string

getRandomUUID

Operation documentation: it returns a random UUID

Invocation template:

getRandomUUID@StringUtils( request )( response )

Request type

Type: void

void : void

Response type

Type: string

string : string

rightPad

Operation documentation: Returns true if the string contains .substring

Invocation template:

rightPad@StringUtils( request )( response )

Request type

Type: PadRequest

type PadRequest: string {
    .length: int
    .char: string
}

PadRequest : string

length : int
char : string

Response type

Type: string

string : string

contains

Operation documentation: Returns true if the string contains .substring

Invocation template:

contains@StringUtils( request )( response )

Request type

Type: ContainsRequest

type ContainsRequest: string {
    .substring: string
}

ContainsRequest : string

substring : string

Response type

Type: bool

bool : bool

split

Operation documentation: Returns true if the string contains .substring

Invocation template:

split@StringUtils( request )( response )

Request type

Type: SplitRequest

type SplitRequest: string {
    .regex: string
    .limit?: int
}

SplitRequest : string

regex : string
limit : int

Response type

Type: SplitResult

type SplitResult: void {
    .result*: string
}

SplitResult : void

result : string

splitByLength

Operation documentation: Returns true if the string contains .substring

Invocation template:

splitByLength@StringUtils( request )( response )

Request type

Type: SplitByLengthRequest

type SplitByLengthRequest: string {
    .length: int
}

SplitByLengthRequest : string

length : int

Response type

Type: SplitResult

type SplitResult: void {
    .result*: string
}

SplitResult : void

result : string

trim

Operation documentation: Returns true if the string contains .substring

Invocation template:

trim@StringUtils( request )( response )

Request type

Type: string

string : string

Response type

Type: string

string : string

find

Operation documentation: Returns true if the string contains .substring

Invocation template:

find@StringUtils( request )( response )

Request type

Type: MatchRequest

type MatchRequest: string {
    .regex: string
}

MatchRequest : string

regex : string

Response type

Type: MatchResult

type MatchResult: int {
    .group*: string
}

MatchResult : int

group : string

endsWith

Operation documentation: checks if a string ends with a given suffix

Invocation template:

endsWith@StringUtils( request )( response )

Request type

Type: EndsWithRequest

type EndsWithRequest: string {
    .suffix: string
}

EndsWithRequest : string

suffix : string

Response type

Type: bool

bool : bool

toUpperCase

Operation documentation: Returns true if the string contains .substring

Invocation template:

toUpperCase@StringUtils( request )( response )

Request type

Type: string

string : string

Response type

Type: string

string : string

join

Operation documentation: Returns true if the string contains .substring

Invocation template:

join@StringUtils( request )( response )

Request type

Type: JoinRequest

type JoinRequest: void {
    .piece*: string
    .delimiter: string
}

JoinRequest : void

piece : string
delimiter : string

Response type

Type: string

string : string

indexOf

Operation documentation: Returns true if the string contains .substring

Invocation template:

indexOf@StringUtils( request )( response )

Request type

Type: IndexOfRequest

type IndexOfRequest: string {
    .word: string
}

IndexOfRequest : string

word : string

Response type

Type: IndexOfResponse

IndexOfResponse : int

startsWith

Operation documentation: checks if the passed string starts with a given prefix

Invocation template:

startsWith@StringUtils( request )( response )

Request type

Type: StartsWithRequest

type StartsWithRequest: string {
    .prefix: string
}

StartsWithRequest : string

prefix : string

Response type

Type: bool

bool : bool

Jolie Documentation