com.sap.cloud.server.odata

Class StringList

java.lang.Object

com.sap.cloud.server.odata.DataValue

com.sap.cloud.server.odata.ListBase

com.sap.cloud.server.odata.StringList

All Implemented Interfaces:

java.lang.Iterable<java.lang.String>

public class StringList
extends ListBase
implements java.lang.Iterable<java.lang.String>

A list of item type string. Uses the property and function naming conventions of the JavaScript Array object.

Field Summary

Fields

Modifier and Type	Field and Description
static StringList	empty

Fields inherited from class com.sap.cloud.server.odata.DataValue

undefined

Constructor Summary

Constructors

Constructor and Description
StringList() See StringList(int).
StringList(int capacity) Construct a new list with StringList.length of zero and optional initial capacity.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String item) Add item to the end of this list.
void	addAll(StringList list) Add all the items of list to the end of this list.
StringList	addThis(java.lang.String item) Add item to the end of this list.
java.lang.String	concat() Return a concatenation of all the string items in this list into a single string value.
StringList	copy() Return a shallow copy of this list.
StringList	dropEmpty() Return a new list with the items of this list, excluding empty items.
java.lang.String	first() Return the first item in this list.
static StringList	from(java.util.List<java.lang.String> list)
java.lang.String	get(int index) Return the item in this list at the specified index.
boolean	includes(java.lang.String item) Return true if this list contains item.
int	indexOf(java.lang.String item) See indexOf(String, int).
int	indexOf(java.lang.String item, int start) Return first index in this list of item, or -1 if not found.
void	insertAll(int index, StringList list) Insert all items of list into this list, before the item (if any) at index.
void	insertAt(int index, java.lang.String item) Insert item into this list, before the item (if any) at index.
java.util.Iterator<java.lang.String>	iterator()
java.lang.String	join(java.lang.String separator) Return a concatenation of all the string items in this list into a single string value, with the specified separator between items.
java.lang.String	joinLines() Return this.join("\n") plus a final newline (if list is non-empty).
java.lang.String	last() Return the last item in this list.
int	lastIndexOf(java.lang.String item) See lastIndexOf(String, int).
int	lastIndexOf(java.lang.String item, int start) Return last index in this list of item, or -1 if not found.
static StringList	lines(java.lang.String value) Return a list of the lines in this string.
void	set(int index, java.lang.String item) Set the item in this list at the specified index.
static StringList	share(ListBase list) Return a new StringList that shares the ListBase.untypedList as the list parameter.
java.lang.String	single() Return a single item from this list.
StringList	slice(int start) See slice(int, int).
StringList	slice(int start, int end) Return a slice of this list from index start (inclusive) to index end (exclusive).
StringList	sortIgnoreCase() Sort this list (in place) with a case-insensitive ordering.
static StringList	split(java.lang.String value, java.lang.String separator) See split(String, String, int).
static StringList	split(java.lang.String value, java.lang.String separator, int limit) Split a string value into a list of string values, divided by the specified separator.
ListBase	toDynamic() Return (nullable) a dynamic representation of this list (DataValueList, ComplexValueList, or EntityValueList), or null if there is no dynamic representation available.
java.util.List<java.lang.String>	toGeneric()
StringList	trimAll() Return a new list where each item is the corresponding trimmed item from this list.

Methods inherited from class com.sap.cloud.server.odata.ListBase

clear, getComparer, getDataType, getEquality, getUntypedList, isEmpty, length, removeAt, removeFirst, removeLast, removeRange, reverse, shareWith, sort, sortWith, toString, validate

Methods inherited from class com.sap.cloud.server.odata.DataValue

cloneMutable, equals, getTypeCode, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

empty

public static final StringList empty

Constructor Detail

StringList

public StringList()

See StringList(int).

StringList

public StringList(int capacity)

Construct a new list with StringList.length of zero and optional initial capacity. A list can expand in length beyond its initial capacity, but best performance will be obtained if the initial capacity is close to the list's maximum length.

Parameters:

capacity - Optional initial capacity.

Method Detail

add

public void add(java.lang.String item)

Add item to the end of this list.

Parameters:

item - Item to be added.

addAll

public void addAll(StringList list)

Add all the items of list to the end of this list.

Parameters:

list - Items to be added.

addThis

public StringList addThis(java.lang.String item)

Add item to the end of this list.

Parameters:

item - Item to be added.

Returns:

This list.

concat

public java.lang.String concat()

Return a concatenation of all the string items in this list into a single string value.

Returns:

a concatenation of all the string items in this list into a single string value.

copy

public StringList copy()

Return a shallow copy of this list.

Returns:

A shallow copy of this list.

dropEmpty

public StringList dropEmpty()

Return a new list with the items of this list, excluding empty items.

Returns:

A new list with the items of this list, excluding empty items.

first

public java.lang.String first()

Return the first item in this list.

Throws:

EmptyListException if the list is empty.

Returns:

The first item in this list.

from

public static StringList from(java.util.List<java.lang.String> list)

get

public java.lang.String get(int index)

Return the item in this list at the specified index.

Throws:

ListIndexException if index is out of range (0 to StringList.length - 1).

Parameters:

index - Zero-based index.

Returns:

The item in this list at the specified `index`.

includes

public boolean includes(java.lang.String item)

Return true if this list contains item.

Parameters:

item - Item for comparison. Comparison uses the StringList.equality property, which would usually be expected to match the == operator for item type string.

Returns:

true if this list contains item.

indexOf

public int indexOf(java.lang.String item)

See indexOf(String, int).

Parameters:

item - Item parameter.

Returns:

(see linked method).

indexOf

public int indexOf(java.lang.String item,
                   int start)

Return first index in this list of item, or -1 if not found.

Parameters:

item - Item for comparison. Comparison uses the StringList.equality property, which would usually be expected to match the == operator for item type string.

start - Zero-based starting index (search moves forwards from this index).

Returns:

First index in this list of item, or -1 if not found.

insertAll

public void insertAll(int index,
                      StringList list)

Insert all items of list into this list, before the item (if any) at index.

Throws:

ListIndexException if index is out of range (0 to StringList.length).

Parameters:

index - Zero-based index.

list - List of items to be inserted.

insertAt

public void insertAt(int index,
                     java.lang.String item)

Insert item into this list, before the item (if any) at index.

Throws:

ListIndexException if index is out of range (0 to StringList.length).

Parameters:

index - Zero-based index.

item - Item to be added.

iterator

public java.util.Iterator<java.lang.String> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.lang.String>

join

public java.lang.String join(java.lang.String separator)

Return a concatenation of all the string items in this list into a single string value, with the specified separator between items.

Parameters:

separator - The separator string value.

Returns:

a concatenation of all the string items in this list into a single string value, with the specified separator between items.

joinLines

public java.lang.String joinLines()

Return this.join("\n") plus a final newline (if list is non-empty).

Returns:

this.join("\n") plus a final newline (if list is non-empty).

last

public java.lang.String last()

Return the last item in this list.

Throws:

EmptyListException if the list is empty.

Returns:

The last item in this list.

lastIndexOf

public int lastIndexOf(java.lang.String item)

See lastIndexOf(String, int).

Parameters:

item - Item parameter.

Returns:

(see linked method).

lastIndexOf

public int lastIndexOf(java.lang.String item,
                       int start)

Return last index in this list of item, or -1 if not found.

Parameters:

item - Item for comparison. Comparison uses the StringList.equality property, which would usually be expected to match the == operator for item type string.

start - Zero-based starting index (search moves backwards from this index).

Returns:

Last index in this list of item, or -1 if not found.

lines

public static StringList lines(java.lang.String value)

Return a list of the lines in this string.

Parameters:

value - Text where each line is terminated by the newline character (optionally preceeded by carriage return). The final newline character can be omitted.

Returns:

A list of the lines in this string.

set

public void set(int index,
                java.lang.String item)

Set the item in this list at the specified index.

Parameters:

index - Zero-based index.

item - Item value.

share

public static StringList share(ListBase list)

Return a new StringList that shares the ListBase.untypedList as the list parameter. To ensure type safety, items in list that do not have the item type string will be removed.

Parameters:

list - List whose items will be shared by the resulting list.

Returns:

A new list of item type string, sharing the same items as list.

single

public java.lang.String single()

Return a single item from this list.

Throws:

EmptyListException if the list has no items, NotUniqueException if the list has multiple items.

Returns:

A single item from this list.

slice

public StringList slice(int start)

See slice(int, int).

Parameters:

start - Start parameter.

Returns:

(see linked method).

slice

public StringList slice(int start,
                        int end)

Return a slice of this list from index start (inclusive) to index end (exclusive).

Parameters:

start - Zero-based starting index (inclusive), or negative for starting index relative to the end of this list.

end - Zero-based ending index (exclusive), or negative for ending index relative to the end of this list.

Returns:

A slice of this list from index start (inclusive) to index end (exclusive).

sortIgnoreCase

public StringList sortIgnoreCase()

Sort this list (in place) with a case-insensitive ordering.

Returns:

This list.

split

public static StringList split(java.lang.String value,
                               java.lang.String separator)

See split(String, String, int).

Parameters:

value - Value parameter.

separator - Separator parameter.

Returns:

(see linked method).

split

public static StringList split(java.lang.String value,
                               java.lang.String separator,
                               int limit)

Split a string value into a list of string values, divided by the specified separator.

Parameters:

value - The string value to be split.

separator - The separator value.

limit - separator Maximum number of string values to return. The separator can appear (possibly multiple times) in the final string value.

Returns:

String list.

toDynamic

public ListBase toDynamic()

Return (nullable) a dynamic representation of this list (DataValueList, ComplexValueList, or EntityValueList), or null if there is no dynamic representation available.

Overrides:

toDynamic in class ListBase

Returns:

(nullable) a dynamic representation of this list (DataValueList, ComplexValueList, or EntityValueList), or null if there is no dynamic representation available.

toGeneric

public java.util.List<java.lang.String> toGeneric()

trimAll

public StringList trimAll()

Return a new list where each item is the corresponding trimmed item from this list.

Returns:

A new list where each item is the corresponding trimmed item from this list.