sirius.kernel.commons

Class Values

java.lang.Object

sirius.kernel.commons.Values

public class Values
extends Object

Wraps an array or list of uncertain size for safe access.

Either an array or a list can be wrapped into a Values object. Accessing the elements of these data structures is done via the at(..) methods which return the element wrapped as Value.

This permits instant coercing and conversion capabilities for the returned element and also handles IndexOutOfBoundExceptions gracefully as simply an empty value is returned instead of throwing an exception.

Also this supports access via "Excel Style" column names ("A", "B", ..., "AH") which is beneficial when importing external data.

Method Summary

Modifier and Type	Method and Description
Value	at(int index) Returns the element at the (zero based) index wrapped as Value If the index is out of the valid range for the wrapped elements, an empty value will be returned
Value	at(String excelStyleIndex) Returns the element at the given column in "Excel style" notation.
static int	convertExcelColumn(String excelStyleIndex) Converts an "Excel Style" column name into a zero based index Therefore "A" will return 0.
int	length() Returns the number of elements in the underlying data structure
static Values	of(List<?> list) Creates a wrapper for the given list
static Values	of(Object[] array) Creates a wrapper for the given array
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

of

@Nonnull
public static Values of(@Nonnull
                                 List<?> list)

Creates a wrapper for the given list

Parameters:

list - the list to wrap

Returns:

a wrapped instance of the given list

of

@Nonnull
public static Values of(@Nonnull
                                 Object[] array)

Creates a wrapper for the given array

Parameters:

array - the array to wrap

Returns:

a wrapped instance of the given array

at

@Nonnull
public Value at(int index)

Returns the element at the (zero based) index wrapped as Value

If the index is out of the valid range for the wrapped elements, an empty value will be returned

Parameters:

index - the zero based index of the element to return

Returns:

the requested element wrapped as value or an empty value if no such element exists

at

@Nonnull
public Value at(@Nonnull
                         String excelStyleIndex)

Returns the element at the given column in "Excel style" notation.

Therefore "A" will return the first element (which is at index 0). "Z" will return the 26th element (at index 25). "AH" will return the 34th element (at index 33).

Parameters:

excelStyleIndex - a column index in "Excel Notation" (A, B, ..., AA, AB, ...)

Returns:

the element at the given index wrapped as value or an empty value if no such element exists

length

public int length()

Returns the number of elements in the underlying data structure

Returns:

the number of element wrapped

convertExcelColumn

public static int convertExcelColumn(@Nonnull
                                     String excelStyleIndex)

Converts an "Excel Style" column name into a zero based index

Therefore "A" will return 0. "Z" will return 25 and AH will return 33.

Parameters:

excelStyleIndex - a column index in "Excel Notation" (A, B, ..., AA, AB, ...)

Returns:

the zero based index of the requested column

toString

public String toString()

Overrides:

toString in class Object