JolieDoc for Port StringUtils

From file string_utils.iol

Port Name Location Protocol
StringUtils

List of the available interfaces


Interface StringUtilsInterface

An interface for supporting string manipulation operations.
Heading Input type Output type Faults
contains ContainsRequest
bool
endsWith EndsWithRequest
bool
find MatchRequest
MatchResult
getRandomUUID void
string
indexOf IndexOfRequest
IndexOfResponse
join JoinRequest
string
leftPad PadRequest
string
length string
int
match MatchRequest
MatchResult
replaceAll ReplaceRequest
string
replaceFirst ReplaceRequest
string
rightPad PadRequest
string
sort StringItemList
StringItemList
split SplitRequest
SplitResult
splitByLength SplitByLengthRequest
SplitResult
startsWith StartsWithRequest
bool
substring SubStringRequest
string
toLowerCase string
string
toUpperCase string
string
trim string
string
valueToPrettyString undefined
string

Operation list

leftPad

leftPad( PadRequest )( string )

valueToPrettyString

valueToPrettyString( undefined )( string )

toLowerCase

toLowerCase( string )( string )

length

length( string )( int )

match

match( MatchRequest )( MatchResult )

replaceFirst

replaceFirst( ReplaceRequest )( string )

sort

sort( StringItemList )( StringItemList )

replaceAll

replaceAll( ReplaceRequest )( string )

substring

substring( SubStringRequest )( string )

getRandomUUID

getRandomUUID( void )( string )

it returns a random UUID

rightPad

rightPad( PadRequest )( string )

contains

contains( ContainsRequest )( bool )

Returns true if the string contains .substring

split

split( SplitRequest )( SplitResult )

splitByLength

splitByLength( SplitByLengthRequest )( SplitResult )

trim

trim( string )( string )

find

find( MatchRequest )( MatchResult )

endsWith

endsWith( EndsWithRequest )( bool )

checks if a string ends with a given suffix

toUpperCase

toUpperCase( string )( string )

join

join( JoinRequest )( string )

indexOf

indexOf( IndexOfRequest )( IndexOfResponse )

startsWith

startsWith( StartsWithRequest )( bool )

checks if the passed string starts with a given prefix


Message type list

PadRequest

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

MatchRequest

type MatchRequest: string { 
    .regex: string
}

MatchResult

type MatchResult: int { 
    .group*: string
}

ReplaceRequest

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

StringItemList

type StringItemList: void { 
    .item*: string
}

SubStringRequest

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

ContainsRequest

type ContainsRequest: string { 
    .substring: string
}

SplitRequest

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

SplitResult

type SplitResult: void { 
    .result*: string
}

SplitByLengthRequest

type SplitByLengthRequest: string { 
    .length: int
}

EndsWithRequest

type EndsWithRequest: string { 
    .suffix: string
}

JoinRequest

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

IndexOfRequest

type IndexOfRequest: string { 
    .word: string
}

IndexOfResponse

type IndexOfResponse: int

StartsWithRequest

type StartsWithRequest: string { 
    .prefix: string
}

Type list

results matching ""

    No results matching ""