dk.heick.properties.types.utils

Class StringList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<String>

dk.heick.properties.types.utils.StringList

All Implemented Interfaces:

Serializable, Cloneable, Iterable<String>, Collection<String>, List<String>, RandomAccess

public class StringList
extends ArrayList<String>

Convenience class for a list of strings, extension of ArrayList<String>.
Gives the ability to add format "adds" if nessecary.

Since:

1.9

Author:

Frederik Heick

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
StringList() Default constructor
StringList(List<String> list) Constructs a StringList on the basis of another StringList.
StringList(Object[] objs) Constructs a StringList on the basis of an array of Objects.
StringList(String s) Constructs a StringList which starts with one string.
StringList(String[] strings) Constructs a StringList on the basis of an array of strings.

Method Summary

Modifier and Type	Method and Description
List<String>	asList() Returns the list as a list of Strings, and not a StringList instance.
List<String>	asUnmodifiableList() Returns this list as an unmodifiableList of strings.
StringList	getAllThatContains(String contains, boolean caseSensitive) Get all the lines that contains a certain text value in a seperate StringList
int	getIndexForFirstContainLine(String contains, boolean caseSensitive) Gets the index of the first String in the StringList containing the certain text value.
String	getLineForFirstContainLine(String contains, boolean caseSensitive) Gets the line of the first String in the StringList containing the certain text value.
void	println() Print all the lines to System.out.println.
void	sort() Sorts the this list of strings using "Collections.sort()".
StringList	subList(int fromIndex, int toIndex)
String	toString() Appends all the strings in the list to one string.
String	toString(String divider) Appends all the strings in the list to one string, divided by the divider.
String[]	toStringArray() Returns the StringList as an array of Strings.

Methods inherited from class java.util.ArrayList

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

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

StringList

public StringList()

Default constructor

StringList

public StringList(List<String> list)

Constructs a StringList on the basis of another StringList.

Parameters:

list - the other list to construct with, if the list is null, it is ignored.

Since:

1.9

StringList

public StringList(String s)

Constructs a StringList which starts with one string.

Parameters:

s - a string which is added as the first entry. If the s is null, it is ignored.

Since:

2.0

StringList

public StringList(String[] strings)

Constructs a StringList on the basis of an array of strings.

Parameters:

strings - an array of strings which is added. If the strings is null, it is ignored.

Since:

2.0

StringList

public StringList(Object[] objs)

Constructs a StringList on the basis of an array of Objects.

Parameters:

objs - an array of Objects which is added as "toString()". If the objs is null, it is ignored, or any of the objects in the array is null it is ignored.

Since:

2.0

Method Detail

asUnmodifiableList

public final List<String> asUnmodifiableList()

Returns this list as an unmodifiableList of strings.

Returns:

an unmodifiableList of strings.

See Also:

Collections.unmodifiableList(List)

asList

public List<String> asList()

Returns the list as a list of Strings, and not a StringList instance.

Returns:

as a list of string

sort

public void sort()

Sorts the this list of strings using "Collections.sort()".

See Also:

Collections.sort(List)

getIndexForFirstContainLine

public final int getIndexForFirstContainLine(String contains,
                                             boolean caseSensitive)

Gets the index of the first String in the StringList containing the certain text value.

Parameters:

contains - the text to search for.

caseSensitive - if the search shall be case sensitive or not.

Returns:

if a line is found the index is returned, otherwise -1 is returned.

getLineForFirstContainLine

public final String getLineForFirstContainLine(String contains,
                                               boolean caseSensitive)

Gets the line of the first String in the StringList containing the certain text value.

Parameters:

contains - the text to search for.

caseSensitive - if the search shall be case sensitive or not.

Returns:

if a line is found the line is returned, otherwise null is returned.

getAllThatContains

public final StringList getAllThatContains(String contains,
                                           boolean caseSensitive)

Get all the lines that contains a certain text value in a seperate StringList

Parameters:

contains - the text to search for.

caseSensitive - if the search shall be case sensitive or not.

Returns:

a StringList with all the lines containing the text value.

subList

public final StringList subList(int fromIndex,
                                int toIndex)

Specified by:

subList in interface List<String>

Overrides:

subList in class ArrayList<String>

toStringArray

public final String[] toStringArray()

Returns the StringList as an array of Strings.

Returns:

a string array.

println

public final void println()

Print all the lines to System.out.println.

toString

public String toString()

Appends all the strings in the list to one string.

Overrides:

toString in class AbstractCollection<String>

toString

public String toString(String divider)

Appends all the strings in the list to one string, divided by the divider.

Parameters:

divider - the string divider to divide the string list entries.

Returns:

a String containing all the strings in the list with the divider between the entries.