org.incava.ijdk.collect

Class StringList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<T>

org.incava.ijdk.collect.Array<java.lang.String>

org.incava.ijdk.collect.StringList

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.lang.String>, java.util.Collection<java.lang.String>, java.util.List<java.lang.String>, java.util.RandomAccess, Sequence<java.lang.String>

Direct Known Subclasses:

StringList

public class StringList
extends Array<java.lang.String>

An extension of org.incava.ijdk.collect.Array<String>, with a constructor for varargs, and selectors that use closures.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
StringList() Creates an empty StringList.
StringList(java.util.Collection<java.lang.String> coll) Creates a StringList from the given collection.
StringList(java.lang.String... ary) Creates a StringList from the given varargs.

Method Summary

Modifier and Type	Method and Description
StringList	allContaining(java.lang.String substr) Returns all strings in this list containing the given one.
StringList	allEndingWith(java.lang.String substr) Returns all strings in this list ending with the given one.
StringList	allStartingWith(java.lang.String substr) Returns all strings in this list starting with the given one.
boolean	anyContains(java.lang.String substr) Returns whether any string in this list contains the given one.
boolean	anyEndsWith(java.lang.String substr) Returns whether any string in this list ends with the given one.
boolean	anyEqualsIgnoreCase(java.lang.String str) Returns whether any element matches the given one, without regard to case.
boolean	anyStartsWith(java.lang.String substr) Returns whether any string in this list starts with the given one.
static StringList	empty() Creates an empty StringList.
StringList	findAll(Closure<java.lang.Boolean,java.lang.String> criteria) Returns all strings in the list for which the closure returns true.
java.lang.String	findFirst(Closure<java.lang.Boolean,java.lang.String> criteria) Returns the first string in the list for which the closure returns true.
java.lang.Boolean	hasMatch(Closure<java.lang.Boolean,java.lang.String> criteria) Returns whether the given criteria matches any element in the list.
static StringList	of(java.lang.String... args) Creates a new StringList.
StringList	sort() Returns a copy of this string list, sorted.
StringList	toLines() Returns the string list as lines, which have the current end-of-line character(s) for the current OS, for any element that does not already have an EOLN character.

Methods inherited from class org.incava.ijdk.collect.Array

append, compact, containsAny, containsAny, elements, first, get, get, getRandomElement, intersection, join, last, minus, of, plus, removeAll, set, sorted, takeFirst, takeLast, toStringArrayList, toStringList, unique

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

StringList

public StringList()

Creates an empty StringList.

StringList

public StringList(java.util.Collection<java.lang.String> coll)

Creates a StringList from the given collection.

Parameters:

coll - the collection of strings to populate this array.

StringList

public StringList(java.lang.String... ary)

Creates a StringList from the given varargs.

Parameters:

ary - the strings to populate the new array

Method Detail

of

public static StringList of(java.lang.String... args)

Creates a new StringList.

Parameters:

args - the strings to populate the new array

Returns:

the newly-created array

empty

public static StringList empty()

Creates an empty StringList.

Returns:

the newly-created array

anyStartsWith

public boolean anyStartsWith(java.lang.String substr)

Returns whether any string in this list starts with the given one.

Parameters:

substr - the substring to match

Returns:

whether any string in this list starts with the given one.

anyContains

public boolean anyContains(java.lang.String substr)

Returns whether any string in this list contains the given one.

Parameters:

substr - the substring to match

Returns:

whether any string in this list contains the given one.

anyEndsWith

public boolean anyEndsWith(java.lang.String substr)

Returns whether any string in this list ends with the given one.

Parameters:

substr - the substring to match

Returns:

whether any string in this list ends with the given one.

anyEqualsIgnoreCase

public boolean anyEqualsIgnoreCase(java.lang.String str)

Returns whether any element matches the given one, without regard to case.

Parameters:

str - the substring to match

Returns:

whether any element matches the given one, without regard to case.

allStartingWith

public StringList allStartingWith(java.lang.String substr)

Returns all strings in this list starting with the given one.

Parameters:

substr - the substring to match

Returns:

all strings in this list starting with the given one.

allContaining

public StringList allContaining(java.lang.String substr)

Returns all strings in this list containing the given one.

Parameters:

substr - the substring to match

Returns:

all strings in this list containing the given one.

allEndingWith

public StringList allEndingWith(java.lang.String substr)

Returns all strings in this list ending with the given one.

Parameters:

substr - the substring to match

Returns:

all strings in this list ending with the given one.

findFirst

public java.lang.String findFirst(Closure<java.lang.Boolean,java.lang.String> criteria)

Returns the first string in the list for which the closure returns true. Returns null if the criteria is null or the criteria is not matched.

Parameters:

criteria - the selection criteria

Returns:

the first string in the list for which the closure returns true.

See Also:

Criteria, Closure

hasMatch

public java.lang.Boolean hasMatch(Closure<java.lang.Boolean,java.lang.String> criteria)

Returns whether the given criteria matches any element in the list.

Parameters:

criteria - the selection criteria

Returns:

whether the given criteria matches any element in the list.

See Also:

Criteria, Closure

findAll

public StringList findAll(Closure<java.lang.Boolean,java.lang.String> criteria)

Returns all strings in the list for which the closure returns true. Returns an empty list if the criteria is null or the criteria is not matched.

Parameters:

criteria - the selection criteria

Returns:

all strings in the list for which the closure returns true.

See Also:

Criteria

toLines

public StringList toLines()

Returns the string list as lines, which have the current end-of-line character(s) for the current OS, for any element that does not already have an EOLN character. Null elements will have no EOLN added.

Returns:

the new list of strings

sort

public StringList sort()

Returns a copy of this string list, sorted.