ListFilter

Filters a delimted list and returns the values from the callback test

Method Signature

ListFilter(list=[string], filter=[function:Predicate], delimiter=[string], includeEmptyFields=[boolean], multiCharacterDelimiter=[boolean], parallel=[boolean], maxThreads=[integer])

Arguments

Argument	Type	Required	Description	Default
list	string	true	string list to filter entries from
filter	function:Predicate	true	function closure filter test. You can alternatively pass a Java Predicate 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	boolean whether to execute the filter in parallel	false
maxThreads	integer	false	number the maximum number of threads to use in the parallel filter

Examples

Example using a simple numeric comparison

Take list and use List Filter to return items that are 3 and higher.

Run Example

numberList = "1,2,3,4,5,6";
threeOrMore = listFilter( numberList, ( Any item ) => {
	return item >= 3;
} );
writedump( threeOrMore );

Result: A List with the values '3,4,5,6'

Example using a member function

This is the same example as above, but using a member function on the list instead of a standalone function.

Run Example

numberList = "1,2,3,4,5,6";
threeOrMore = numberList.listFilter( ( Any item ) => {
	return item >= 3;
} );
writedump( threeOrMore );

Result: A List with the values '3,4,5,6'

Additional Examples

Run Example

mylist = "Save|Water|Plant|green";
filterResult = listFilter( mylist, ( Any element, Any idx ) => {
	if( element != "water" ) {
		return true;
	}
	return false;
}, "|" );
writeDump( filterResult );
// Member Function
listVal = "one,two,three,four,five";
res = listVal.listFilter( ( Any elem, Any ind ) => {
	if( elem != "three" ) {
		return true;
	}
	return false;
} );
writeDump( res );

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

• ListEach

• ListSort

• ListSetAt

• GetToken

• ListItemTrim