Tuple (spring-tuple 1.0.0.RELEASE API)

All Known Subinterfaces:

MutableTuple

All Known Implementing Classes:

DefaultMutableTuple, DefaultTuple
```
public interface Tuple
```
Data structure that stores a fixed number of ordered key-value pairs and adds convenience methods to access values in a type-safe manner. Values do not need to be of the same type. When accessing values, Spring's type conversion system is used to convert the value type to the requested type. The type conversion system is extensible. This interface only allows querying properties. Concrete Tuples can also implement MutableTuple to allow mutation. Tuples are created using the TupleBuilder class.

Author:

Mark Pollack

Method Summary

Methods
Modifier and Type	Method and Description
`BigDecimal`	`getBigDecimal(int index)` Read the '`BigDecimal`' value at index '`index`'.
`BigDecimal`	`getBigDecimal(int index, BigDecimal defaultValue)` Read the '`BigDecimal`' value at index '`index`'.
`BigDecimal`	`getBigDecimal(String name)` Read the '`BigDecimal`' value from column with given '`name`'.
`BigDecimal`	`getBigDecimal(String name, BigDecimal defaultValue)` Read the '`BigDecimal`' value from column with given '`name`'.
`boolean`	`getBoolean(int index)` Read the '`boolean`' value at index '`index`'.
`boolean`	`getBoolean(int index, String trueValue)` Read the '`boolean`' value at index '`index`'.
`boolean`	`getBoolean(String name)` Read the '`boolean`' value from field with given '`name`'.
`boolean`	`getBoolean(String name, String trueValue)` Read the '`boolean`' value from column with given '`name`'.
`byte`	`getByte(int index)` Read the '`byte`' value at index '`index`'.
`byte`	`getByte(int index, byte defaultValue)` Read the '`byte`' value at index '`index`'.
`byte`	`getByte(String name)` Read the '`byte`' value from column with given '`name`'.
`byte`	`getByte(String name, byte defaultValue)` Read the '`byte`' value from column with given '`name`'.
`char`	`getChar(int index)` Read the '`char`' value at index '`index`'.
`char`	`getChar(String name)` Read the '`char`' value from field with given '`name`'.
`Date`	`getDate(int index)` Read the `java.util.Date` value in default format at designated column `index`.
`Date`	`getDate(int index, Date defaultValue)` Read the `java.util.Date` value in default format at designated column `index` using the supplied `defaultValue` if the field value is a zero length string or null.
`Date`	`getDate(String name)` Read the `java.util.Date` value in default format at designated column with given `name`.
`Date`	`getDate(String name, Date defaultValue)` Read the `java.util.Date` value in default format at designated column with given `name`.
`Date`	`getDateWithPattern(int index, String pattern)` Read the `java.util.Date` value in default format at designated column `index`.
`Date`	`getDateWithPattern(int index, String pattern, Date defaultValue)` Read the `java.util.Date` value in default format at designated column `index`.
`Date`	`getDateWithPattern(String name, String pattern)` Read the `java.util.Date` value in given format from column with given `name`.
`Date`	`getDateWithPattern(String name, String pattern, Date defaultValue)` Read the `java.util.Date` value in given format from column with given `name`.
`double`	`getDouble(int index)` Read the '`double`' value at index '`index`'.
`double`	`getDouble(int index, double defaultValue)` Read the '`double`' value at index '`index`'.
`double`	`getDouble(String name)` Read the '`double`' value from column with given '`name`'.
`double`	`getDouble(String name, double defaultValue)` Read the '`double`' value from column with given '`name`'.
`int`	`getFieldCount()` Return the number of fields in this tuple.
`List<String>`	`getFieldNames()` Return the fields names that can reference elements by name in this tuple
`List<Class>`	`getFieldTypes()` Return the Java types of the fields in this tuple.
`float`	`getFloat(int index)` Read the '`float`' value at index '`index`'.
`float`	`getFloat(int index, float defaultValue)` Read the '`float`' value at index '`index`'.
`float`	`getFloat(String name)` Read the '`float`' value from column with given '`name`'.
`float`	`getFloat(String name, float defaultValue)` Read the '`float`' value from column with given '`name`'.
`int`	`getInt(int index)` Read the '`int`' value at index '`index`'.
`int`	`getInt(int index, int defaultValue)` Read the '`int`' value at index '`index`'.
`int`	`getInt(String name)` Read the '`int`' value from column with given '`name`'.
`int`	`getInt(String name, int defaultValue)` Read the '`int`' value from column with given '`name`'.
`long`	`getLong(int index)` Read the '`long`' value at index '`index`'.
`long`	`getLong(int index, long defaultValue)` Read the '`long`' value at index '`index`'.
`long`	`getLong(String name)` Read the '`int`' value from column with given '`name`'.
`long`	`getLong(String name, long defaultValue)` Read the '`long`' value from column with given '`name`'.
`String`	`getRawString(int index)` Read the `String` value at index '`index`' including trailing whitespace (don't trim).
`String`	`getRawString(String name)` Read the `String` value from column with given '`name`' including trailing whitespace (don't trim).
`short`	`getShort(int index)` Read the '`short`' value at index '`index`'.
`short`	`getShort(int index, short defaultValue)` Read the '`short`' value at index '`index`'.
`short`	`getShort(String name)` Read the '`short`' value from column with given '`name`'.
`short`	`getShort(String name, short defaultValue)` Read the '`short`' value from column with given '`name`'.
`String`	`getString(int index)` Read the String value given the index position
`String`	`getString(String name)` Read the `String` value given the field '`name`'.
`Tuple`	`getTuple(int index)` Read the Tuple value given the index position
`Tuple`	`getTuple(String name)` Read the `Tuple` value given the field '`name`'.
`Object`	`getValue(int index)` Return the value of the field given the index position
`<T> T`	`getValue(int index, Class<T> valueClass)` Return the value of the field given the index position
`Object`	`getValue(String name)` Return the value of the field given the name
`<T> T`	`getValue(String name, Class<T> valueClass)` Return the value of the field given the name
`List<Object>`	`getValues()` Return the values for all the fields in this tuple
`boolean`	`hasFieldName(String name)` Return true if the tuple contains a field of the given name
`Tuple`	`select(String expression)` Use SpEL expression to return a subset of the tuple that matches the expression
`int`	`size()` Return the number of elements in this tuple.

- Method Detail
  - size
```
int size()
```
    Return the number of elements in this tuple.
    
    Returns:
    number of elements
  - getFieldNames
```
List<String> getFieldNames()
```
    Return the fields names that can reference elements by name in this tuple
    
    Returns:
    list of field names
  - getValues
```
List<Object> getValues()
```
    Return the values for all the fields in this tuple
    
    Returns:
    list of values.
  - hasFieldName
```
boolean hasFieldName(String name)
```
    Return true if the tuple contains a field of the given name
    
    Parameters:
    name - the name of the field
    
    Returns:
    true if present, otherwise false
  - getFieldTypes
```
List<Class> getFieldTypes()
```
    Return the Java types of the fields in this tuple.
    
    Returns:
    the Java types of the fields in this tuple.
  - getFieldCount
```
int getFieldCount()
```
    Return the number of fields in this tuple.
    
    Returns:
    the number of fields in this tuple.
  - getValue
```
Object getValue(String name)
```
    Return the value of the field given the name
    
    Parameters:
    name - the name of the field
    
    Returns:
    value of the field
    
    Throws:
    
    IllegalArgumentException - if the name is not present
  - getValue
```
Object getValue(int index)
```
    Return the value of the field given the index position
    
    Parameters:
    index - position in the tuple
    
    Returns:
    value of the field
    
    Throws:
    
    IndexOutOfBoundsException - if the index position is out of bounds.
  - getValue
```
<T> T getValue(String name,
             Class<T> valueClass)
```
    Return the value of the field given the name
    
    Parameters:
    name - the field name
    valueClass - Class to coerce the value into.
    
    Returns:
    value of the field
  - getValue
```
<T> T getValue(int index,
             Class<T> valueClass)
```
    Return the value of the field given the index position
    
    Parameters:
    index - position in the tuple
    valueClass - Class to coerce the value into
    
    Returns:
    value of the field
  - getString
```
String getString(String name)
```
    Read the String value given the field 'name'.
    
    Parameters:
    name - the field name.
    
    Returns:
    value of the field
  - getString
```
String getString(int index)
```
    Read the String value given the index position
    
    Parameters:
    index - position in the tuple
    
    Returns:
    value of the field
  - getTuple
```
Tuple getTuple(String name)
```
    Read the Tuple value given the field 'name'.
    
    Parameters:
    name - the field name.
    
    Returns:
    value of the field
  - getTuple
```
Tuple getTuple(int index)
```
    Read the Tuple value given the index position
    
    Parameters:
    index - position in the tuple
    
    Returns:
    value of the field
  - getRawString
```
String getRawString(int index)
```
    Read the String value at index 'index' including trailing whitespace (don't trim).
    
    Parameters:
    index - the field index.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds.
  - getRawString
```
String getRawString(String name)
```
    Read the String value from column with given 'name' including trailing whitespace (don't trim).
    
    Parameters:
    name - the field name.
  - getChar
```
char getChar(int index)
```
    Read the 'char' value at index 'index'.
    
    Parameters:
    index - the field index.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds.
  - getChar
```
char getChar(String name)
```
    Read the 'char' value from field with given 'name'.
    
    Parameters:
    name - the field name.
    
    Throws:
    
    IllegalArgumentException - if a field with given name is not defined.
  - getBoolean
```
boolean getBoolean(int index)
```
    Read the 'boolean' value at index 'index'.
    
    Parameters:
    index - the field index.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds.
  - getBoolean
```
boolean getBoolean(String name)
```
    Read the 'boolean' value from field with given 'name'.
    
    Parameters:
    name - the field name.
    
    Throws:
    
    IllegalArgumentException - if a field with given name is not defined.
  - getBoolean
```
boolean getBoolean(int index,
                 String trueValue)
```
    Read the 'boolean' value at index 'index'.
    
    Parameters:
    index - the field index.
    trueValue - the value that signifies true; case-sensitive.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds, or if the supplied trueValue is null.
  - getBoolean
```
boolean getBoolean(String name,
                 String trueValue)
```
    Read the 'boolean' value from column with given 'name'.
    
    Parameters:
    name - the field name.
    trueValue - the value that signifies true; case-sensitive.
    
    Throws:
    
    IllegalArgumentException - if a column with given name is not defined, or if the supplied trueValue is null.
  - getByte
```
byte getByte(int index)
```
    Read the 'byte' value at index 'index'.
    
    Parameters:
    index - the field index.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds.
  - getByte
```
byte getByte(String name)
```
    Read the 'byte' value from column with given 'name'.
    
    Parameters:
    name - the field name.
  - getByte
```
byte getByte(int index,
           byte defaultValue)
```
    Read the 'byte' value at index 'index'. using the supplied defaultValue if the field value is a zero length string or null.
    
    Parameters:
    index - the field index.
    defaultValue - the default value to return if field value is not found.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds.
  - getByte
```
byte getByte(String name,
           byte defaultValue)
```
    Read the 'byte' value from column with given 'name'. using the supplied defaultValue if the field value is a zero length string or null.
    
    Parameters:
    name - the field name.
    defaultValue - the default value to return if field value is not found.
  - getShort
```
short getShort(int index)
```
    Read the 'short' value at index 'index'.
    
    Parameters:
    index - the field index.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds.
  - getShort
```
short getShort(String name)
```
    Read the 'short' value from column with given 'name'.
    
    Parameters:
    name - the field name.
  - getShort
```
short getShort(int index,
             short defaultValue)
```
    Read the 'short' value at index 'index'. using the supplied defaultValue if the field value is a zero length string or null.
    
    Parameters:
    index - the field index.
    defaultValue - the default value to return if field value is not found.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds.
  - getShort
```
short getShort(String name,
             short defaultValue)
```
    Read the 'short' value from column with given 'name'. using the supplied defaultValue if the field value is a zero length string or null.
    
    Parameters:
    name - the field name.
    defaultValue - the default value to return if field value is not found.
  - getInt
```
int getInt(int index)
```
    Read the 'int' value at index 'index'.
    
    Parameters:
    index - the field index.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds.
  - getInt
```
int getInt(String name)
```
    Read the 'int' value from column with given 'name'.
    
    Parameters:
    name - the field name.
  - getInt
```
int getInt(int index,
         int defaultValue)
```
    Read the 'int' value at index 'index'. using the supplied defaultValue if the field value is a zero length string or null.
    
    Parameters:
    index - the field index.
    defaultValue - the default value to return if field value is not found.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds.
  - getInt
```
int getInt(String name,
         int defaultValue)
```
    Read the 'int' value from column with given 'name'. using the supplied defaultValue if the field value is a zero length string or null.
    
    Parameters:
    name - the field name.
    defaultValue - the default value to return if field value is not found.
  - getLong
```
long getLong(int index)
```
    Read the 'long' value at index 'index'.
    
    Parameters:
    index - the field index.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds.
  - getLong
```
long getLong(String name)
```
    Read the 'int' value from column with given 'name'.
    
    Parameters:
    name - the field name.
  - getLong
```
long getLong(int index,
           long defaultValue)
```
    Read the 'long' value at index 'index'. using the supplied defaultValue if the field value is a zero length string or null.
    
    Parameters:
    index - the field index.
    defaultValue - the default value to return if field value is not found.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds.
  - getLong
```
long getLong(String name,
           long defaultValue)
```
    Read the 'long' value from column with given 'name'. using the supplied defaultValue if the field value is a zero length string or null.
    
    Parameters:
    name - the field name.
    defaultValue - the default value to return if field value is not found.
  - getFloat
```
float getFloat(int index)
```
    Read the 'float' value at index 'index'.
    
    Parameters:
    index - the field index.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds.
  - getFloat
```
float getFloat(String name)
```
    Read the 'float' value from column with given 'name'.
    
    Parameters:
    name - the field name.
  - getFloat
```
float getFloat(int index,
             float defaultValue)
```
    Read the 'float' value at index 'index'. using the supplied defaultValue if the field value is a zero length string or null.
    
    Parameters:
    index - the field index.
    defaultValue - the default value to return if field value is not found.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds.
  - getFloat
```
float getFloat(String name,
             float defaultValue)
```
    Read the 'float' value from column with given 'name'. using the supplied defaultValue if the field value is a zero length string or null.
    
    Parameters:
    name - the field name.
    defaultValue - the default value to return if field value is not found.
  - getDouble
```
double getDouble(int index)
```
    Read the 'double' value at index 'index'.
    
    Parameters:
    index - the field index.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds.
  - getDouble
```
double getDouble(String name)
```
    Read the 'double' value from column with given 'name'.
    
    Parameters:
    name - the field name.
  - getDouble
```
double getDouble(int index,
               double defaultValue)
```
    Read the 'double' value at index 'index'. using the supplied defaultValue if the field value is a zero length string or null.
    
    Parameters:
    index - the field index.
    defaultValue - the default value to return if field value is not found.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds.
  - getDouble
```
double getDouble(String name,
               double defaultValue)
```
    Read the 'double' value from column with given 'name'. using the supplied defaultValue if the field value is a zero length string or null.
    
    Parameters:
    name - the field name.
    defaultValue - the default value to return if field value is not found.
  - getBigDecimal
```
BigDecimal getBigDecimal(int index)
```
    Read the 'BigDecimal' value at index 'index'.
    
    Parameters:
    index - the field index.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds.
  - getBigDecimal
```
BigDecimal getBigDecimal(String name)
```
    Read the 'BigDecimal' value from column with given 'name'.
    
    Parameters:
    name - the field name.
  - getBigDecimal
```
BigDecimal getBigDecimal(int index,
                       BigDecimal defaultValue)
```
    Read the 'BigDecimal' value at index 'index'. using the supplied defaultValue if the field value is a zero length string or null.
    
    Parameters:
    index - the field index.
    defaultValue - the default value to return if field value is not found.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds.
  - getBigDecimal
```
BigDecimal getBigDecimal(String name,
                       BigDecimal defaultValue)
```
    Read the 'BigDecimal' value from column with given 'name'. using the supplied defaultValue if the field value is a zero length string or null.
    
    Parameters:
    name - the field name.
    defaultValue - the default value to return if field value is not found.
  - getDate
```
Date getDate(int index)
```
    Read the java.util.Date value in default format at designated column index.
    
    Parameters:
    index - the field index.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds.
    
    org.springframework.core.convert.ConversionFailedException - if the value is not parseable
  - getDate
```
Date getDate(String name)
```
    Read the java.util.Date value in default format at designated column with given name.
    
    Parameters:
    name - the field name.
    
    Throws:
    
    IllegalArgumentException - if a column with given name is not defined
    
    org.springframework.core.convert.ConversionFailedException - if the value is not parseable
  - getDate
```
Date getDate(int index,
           Date defaultValue)
```
    Read the java.util.Date value in default format at designated column index using the supplied defaultValue if the field value is a zero length string or null.
    
    Parameters:
    index - the field index.
    defaultValue - the default value to return if field value is not found.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds.
    
    org.springframework.core.convert.ConversionFailedException - if the value is not parseable
  - getDate
```
Date getDate(String name,
           Date defaultValue)
```
    Read the java.util.Date value in default format at designated column with given name. using the supplied defaultValue if the field value is a zero length string or null.
    
    Parameters:
    name - the field name.
    defaultValue - the default value to return if field value is not found.
    
    Throws:
    
    IllegalArgumentException - if a column with given name is not defined
    
    org.springframework.core.convert.ConversionFailedException - if the value is not parseable
  - getDateWithPattern
```
Date getDateWithPattern(int index,
                      String pattern)
```
    Read the java.util.Date value in default format at designated column index.
    
    Parameters:
    index - the field index.
    pattern - the pattern describing the date and time format
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds.
    
    IllegalArgumentException - if the date cannot be parsed.
  - getDateWithPattern
```
Date getDateWithPattern(String name,
                      String pattern)
```
    Read the java.util.Date value in given format from column with given name.
    
    Parameters:
    name - the field name.
    pattern - the pattern describing the date and time format
    
    Throws:
    
    IllegalArgumentException - if a column with given name is not defined or if the specified field cannot be parsed
  - getDateWithPattern
```
Date getDateWithPattern(int index,
                      String pattern,
                      Date defaultValue)
```
    Read the java.util.Date value in default format at designated column index. using the supplied defaultValue if the field value is a zero length string or null.
    
    Parameters:
    index - the field index.
    pattern - the pattern describing the date and time format
    defaultValue - the default value to return if field value is not found.
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds.
    
    IllegalArgumentException - if the date cannot be parsed.
  - getDateWithPattern
```
Date getDateWithPattern(String name,
                      String pattern,
                      Date defaultValue)
```
    Read the java.util.Date value in given format from column with given name. using the supplied defaultValue if the field value is a zero length string or null.
    
    Parameters:
    name - the field name.
    pattern - the pattern describing the date and time format
    defaultValue - the default value to return if field value is not found.
    
    Throws:
    
    IllegalArgumentException - if a column with given name is not defined or if the specified field cannot be parsed
  - select
```
Tuple select(String expression)
```
    Use SpEL expression to return a subset of the tuple that matches the expression
    
    Parameters:
    expression - SpEL expression to select from a Map, e.g. ?[key.startsWith('b')]
    
    Returns:
    a new Tuple with data selected from the current instance.

Interface Tuple

Method Summary

Method Detail

size

getFieldNames

getValues

hasFieldName

getFieldTypes

getFieldCount

getValue

getValue

getValue

getValue

getString

getString

getTuple

getTuple

getRawString

getRawString

getChar

getChar

getBoolean

getBoolean

getBoolean

getBoolean

getByte

getByte

getByte

getByte

getShort

getShort

getShort

getShort

getInt

getInt

getInt

getInt

getLong

getLong

getLong

getLong

getFloat

getFloat

getFloat

getFloat

getDouble

getDouble

getDouble

getDouble

getBigDecimal

getBigDecimal

getBigDecimal

getBigDecimal

getDate

getDate

getDate

getDate

getDateWithPattern

getDateWithPattern

getDateWithPattern

getDateWithPattern

select