ListEach

Used to iterate over a delimited list and run the function closure for each item in the list.

Method Signature

ListEach(list=[string], callback=[function:Consumer], delimiter=[string], includeEmptyFields=[boolean], multiCharacterDelimiter=[boolean], parallel=[boolean], maxThreads=[integer], ordered=[boolean])

Arguments

Argument	Type	Required	Description	Default
list	string	true	The delimited list to perform operations on
callback	function:Consumer	true	The function to invoke for each item. The function will be passed 3 arguments: the value, the index, the array. You can alternatively pass a Java Consumer which will only receive the 1st arg.
delimiter	string	false	string the list delimiter	,
includeEmptyFields	boolean	false	boolean whether to include empty fields in the returned result	false
multiCharacterDelimiter	boolean	false	boolean whether the delimiter is multi-character	true
parallel	boolean	false	Specifies whether the items can be executed in parallel	false
maxThreads	integer	false	The maximum number of threads to use when parallel = true
ordered	boolean	false	(BoxLang only) whether parallel operations should execute and maintain order	false

Examples

List Loop using listEach

Using a semicolon delimiter.

Run Example

list = "a;b;c";
listEach( list, ( Any element, Any index, Any list ) => {
	writeOutput( "#index#:#element#;" );
}, ";" );

Result: 1:a;2:b;3:c;

Member Function Example

List Loop list.listEach()

Run Example

list = "a;b;c";
list.listEach( ( Any element, Any index, Any list ) => {
	writeOutput( "#index#:#element#;" );
}, ";" );

Result: 1:a;2:b;3:c;

Example using a Closure

Example 1

Run Example

empArray = [ 
	"john",
	"pete",
	"bob"
];
listS = "'john', 'pete', 'bob'";
arrayEach( empArray, xclosure );
listEach( listS, xclosure );

function xclosure( Any empname, Any index ) {
	writeOutput( empName & " at index: " & index );
}

Result: john at index: 1pete at index: 2bob at index: 3'john' at index: 1 'pete' at index: 2 'bob' at index: 3

Another Closure Example

Example 2

Run Example

cityList = "Pittsburgh, Raleigh, Miami, Las Vegas";

function printCity( String city ) {
	writeOutput( "Current city: " & city );
}
listEach( cityList, printCity );

Result: Current city: PittsburghCurrent city: RaleighCurrent city: MiamiCurrent city: Las Vegas

Additional Examples

Run Example

list = "Plant,green,save,earth";
listEach( list, ( Any element, Any index, Any list ) => {
	writeOutput( "#index#:#element#;<br>" );
} );
// Member function with custom delimiter
writeOutput( "<br>Member Function<br>" );
strLst = "one+two+three";
strLst.listEach( ( Any element, Any index, Any list ) => {
	writeOutput( "#index#:#element#;<br>" );
}, "+" );

Related

• ListSome

• ListReduceRight

• ListPrepend

• ListFirst

• ListLast

• ListIndexExists

• ListInsertAt

• ListChangeDelims

• ListFind

• ListFindNoCase

• ListContains

• ListContainsNoCase

• ListCompact

• ListTrim

• ListMap

• ListDeleteAt

• ListRemoveDuplicates

• ListToArray

• ListQualify

• ListAppend

• ListValueCount

• ListValueCountNoCase

• ListAvg

• ListLen

• ListRest

• ListGetAt

• ListEvery

• ListSort

• ListSetAt

• ListFilter

• GetToken

• ListItemTrim