com.inspirel.yami
Class Parameters.Entry

java.lang.Object
  com.inspirel.yami.Parameters.Entry

Enclosing class:

Parameters

public static class Parameters.Entry
extends java.lang.Object

Class representing a single entry in the collection.

The Entry class allows only inspection of the data and is provided for natural iteration usage. The underlying data cannot be modified, except for the boolean[], int[], long[], double[] and binary arrays (byte[]), which are kept by reference and which can be modified by the user.

Method Summary

byte[]	getBinary() Gets the byte[] value from this entry.
byte[][]	getBinaryArray() Gets the byte[] array (that is, array of byte arrays) from this entry.
boolean	getBoolean() Gets the boolean value from this entry.
boolean[]	getBooleanArray() Gets the boolean array from this entry.
double	getDouble() Gets the double value from this entry.
double[]	getDoubleArray() Gets the double array from this entry.
int	getInteger() Gets the int value from this entry.
int[]	getIntegerArray() Gets the int array from this entry.
long	getLong() Gets the long value from this entry.
long[]	getLongArray() Gets the long array from this entry.
Parameters[]	getNestedArray() Gets the Parameters array (that is, array of Parameters objects) from this entry.
Parameters	getNestedParameters() Gets the nested Parameters object from this entry.
java.lang.String	getString() Gets the String value from this entry.
java.lang.String[]	getStringArray() Gets the String array from this entry.
java.lang.String	name() Gets the name of this entry.
Parameters.EntryType	type() Gets the type of this entry.

Methods inherited from class java.lang.Object

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

Method Detail

type

public Parameters.EntryType type()

Gets the type of this entry.

Returns:

type of this entry

name

public java.lang.String name()

Gets the name of this entry.

Returns:

name of this entry

getBoolean

public boolean getBoolean()

Gets the boolean value from this entry.

Returns:

value of this entry

Throws:

BadTypeException - if this entry does not contain boolean value

getInteger

public int getInteger()

Gets the int value from this entry.

Returns:

value of this entry

Throws:

BadTypeException - if this entry does not contain int value

getLong

public long getLong()

Gets the long value from this entry.

Returns:

value of this entry

Throws:

BadTypeException - if this entry does not contain long value

getDouble

public double getDouble()

Gets the double value from this entry.

Returns:

value of this entry

Throws:

BadTypeException - if this entry does not contain double value

getString

public java.lang.String getString()

Gets the String value from this entry.

Returns:

value of this entry

Throws:

BadTypeException - if this entry does not contain String value

getBinary

public byte[] getBinary()

Gets the byte[] value from this entry.

Returns:

value of this entry

Throws:

BadTypeException - if this entry does not contain byte[] value

getBooleanArray

public boolean[] getBooleanArray()

Gets the boolean array from this entry.

Returns:

value of this entry

Throws:

BadTypeException - if this entry does not contain boolean array

getIntegerArray

public int[] getIntegerArray()

Gets the int array from this entry.

Returns:

value of this entry

Throws:

BadTypeException - if this entry does not contain int array

getLongArray

public long[] getLongArray()

Gets the long array from this entry.

Returns:

value of this entry

Throws:

BadTypeException - if this entry does not contain long array

getDoubleArray

public double[] getDoubleArray()

Gets the double array from this entry.

Returns:

value of this entry

Throws:

BadTypeException - if this entry does not contain double array

getStringArray

public java.lang.String[] getStringArray()

Gets the String array from this entry.

Returns:

value of this entry

Throws:

BadTypeException - if this entry does not contain String array

getBinaryArray

public byte[][] getBinaryArray()

Gets the byte[] array (that is, array of byte arrays) from this entry.

Returns:

value of this entry

Throws:

BadTypeException - if this entry does not contain byte[] array

getNestedParameters

public Parameters getNestedParameters()

Gets the nested Parameters object from this entry.

Returns:

nested object

Throws:

BadTypeException - if this entry does not contain nested Parameters object

getNestedArray

public Parameters[] getNestedArray()

Gets the Parameters array (that is, array of Parameters objects) from this entry.

Returns:

value of this entry

Throws:

BadTypeException - if this entry does not contain Parameters array