public interface IDfList
Modifier and Type | Field and Description |
---|---|
static int |
DF_BOOLEAN
Represents the boolean datatype.
|
static int |
DF_DOUBLE
Represents the double datatype.
|
static int |
DF_ID
Represents the ID datatype.
|
static int |
DF_INTEGER
Represents the integer datatype.
|
static int |
DF_LIST
Represents a DfList object.
|
static int |
DF_OBJECT
Represents any Java object.
|
static int |
DF_STRING
Represents the string datatype.
|
static int |
DF_TIME
Represents the time datatype.
|
static int |
DF_VALUE
Represents a DfValue object.
|
Modifier and Type | Method and Description |
---|---|
int |
append(java.lang.Object value)
Appends an Object instance to the list.
|
int |
appendBoolean(boolean value)
Appends a boolean value to the list.
|
int |
appendDouble(double value)
Appends a double value to the list.
|
int |
appendId(IDfId value)
Appends an instance of an IDfId object to the list.
|
int |
appendInt(int value)
Appends an int value to the list.
|
int |
appendList(IDfList value)
Appends an instance of an IDfList object to the list.
|
int |
appendString(java.lang.String value)
Appends a string value to the list.
|
int |
appendTime(IDfTime value)
Appends an instance of an IDfTime object to the list.
|
int |
appendValue(IDfValue value)
Appends an instance of an IDfValue object to the list.
|
int |
findBooleanIndex(boolean value)
Returns the index of the first occurrence of a boolean value in the list.
|
int |
findDoubleIndex(double value)
Returns the index of the first occurrence of a double value in the list.
|
int |
findIdIndex(IDfId value)
Returns the index of the first occurrence of an IDfId object in the list.
|
int |
findIndex(java.lang.Object value)
Returns the index of the first occurrence of the Object in the list.
|
int |
findIntIndex(int value)
Returns the index of the first occurrence of an int value in the list.
|
int |
findListIndex(IDfList value)
Returns the index of the first occurrence of an IDfList object in the list.
|
int |
findStringIndex(java.lang.String value)
Returns the index of the first occurrence of a string value in the list.
|
int |
findTimeIndex(IDfTime value)
Returns the index of the first occurrence of an IDfTime object in the list.
|
int |
findValueIndex(IDfValue value)
Returns the index of the first occurrence of an IDfValue object in the list.
|
java.lang.Object |
get(int index)
Fetches an Object instance from the list at the specified index.
|
boolean |
getBoolean(int index)
Fetches a boolean value from the list at the specified index.
|
int |
getCount()
Returns the number of items in the list.
|
double |
getDouble(int index)
Fetches a double value from the list at the specified index.
|
int |
getElementType()
Returns the datatype of the items added to the list.
|
int |
getElementTypeAt(int index)
Returns the datatype of the items added to the list at the specified
index.
|
IDfId |
getId(int index)
Fetches an instance of an IDfId object from the list at the specified index.
|
int |
getInt(int index)
Fetches an int value from the list at the specified index.
|
IDfList |
getList(int index)
Fetches an instance of an IDfList object from the list at the specified index.
|
java.lang.String |
getString(int index)
Fetches a string value from the list at the specified index.
|
IDfTime |
getTime(int index)
Fetches an instance of an IDfTime object from the list at the specified index.
|
IDfValue |
getValue(int index)
Fetches an instance of an IDfValue object from the list at the specified index.
|
void |
insert(int index,
java.lang.Object value)
Inserts an Object instance into the list at a specified index.
|
void |
insertAll(int index,
IDfList list)
Inserts all objects contained in an IDfList object into the list at a specified index.
|
void |
insertBoolean(int index,
boolean value)
Inserts a boolean value into the list at a specified index.
|
void |
insertDouble(int index,
double value)
Inserts a double value into the list at a specified index.
|
void |
insertId(int index,
IDfId value)
Inserts an instance of an IDfId object into the list at a specified index.
|
void |
insertInt(int index,
int value)
Inserts an int value into the list at a specified index.
|
void |
insertList(int index,
IDfList value)
Inserts an instance of an IDfList object into the list at a specified index.
|
void |
insertString(int index,
java.lang.String value)
Inserts a string value into the list at a specified index.
|
void |
insertTime(int index,
IDfTime value)
Inserts an instance of an IDfTime object into the list at a specified index.
|
void |
insertValue(int index,
IDfValue value)
Inserts an instance of an IDfValue object into the list at a specified index.
|
void |
remove(int index)
Removes an item from the list at the specified index.
|
void |
removeAll()
Removes all items from the list and set its size to zero.
|
void |
set(int index,
java.lang.Object value)
Adds an Object instance into the list at a specified index.
|
void |
setBoolean(int index,
boolean value)
Adds a boolean value into the list at a specified index.
|
void |
setDouble(int index,
double value)
Adds a double value into the list at a specified index.
|
void |
setElementType(int type)
Sets the element type for the list.
|
void |
setId(int index,
IDfId value)
Adds an instance of an IDfId interface into the list at a specified index.
|
void |
setInt(int index,
int value)
Adds an int value into the list at a specified index.
|
void |
setList(int index,
IDfList value)
Adds an instance of an IDfList interface into the list at a specified index.
|
void |
setString(int index,
java.lang.String value)
Adds a string value into the list at a specified index.
|
void |
setTime(int index,
IDfTime value)
Adds an instance of an IDfTime interface into the list at a specified index.
|
void |
setValue(int index,
IDfValue value)
Adds an instance of an IDfValue interface into the list at a specified index.
|
static final int DF_BOOLEAN
static final int DF_INTEGER
static final int DF_STRING
static final int DF_ID
static final int DF_TIME
static final int DF_DOUBLE
static final int DF_OBJECT
static final int DF_VALUE
static final int DF_LIST
int append(java.lang.Object value) throws DfException
value
- the object instance to add to the list.append
.DfException
- if there is a type mismatchint appendString(java.lang.String value) throws DfException
value
- the string value to add to the list.appendString
.DfException
- if there is a type mismatchint appendInt(int value) throws DfException
value
- the int value to add to the list.appendInt
.DfException
- if there is a type mismatchint appendDouble(double value) throws DfException
value
- the double value to add to the list.appendDouble
.DfException
- if there is a type mismatchint appendBoolean(boolean value) throws DfException
value
- the boolean value to add to the list.appendBoolean
.DfException
- if there is a type mismatchint appendId(IDfId value) throws DfException
value
- the IDfId object to add to the list.appendId
.DfException
- if there is a type mismatchint appendTime(IDfTime value) throws DfException
value
- the IDfTime object to add to the list.appendTime
.DfException
- if there is a type mismatchint appendValue(IDfValue value) throws DfException
value
- the IDfValue object to add to the list.appendValue
.DfException
- if there is a type mismatchint appendList(IDfList value) throws DfException
value
- the IDfList object to add to the list.appendList
.DfException
- if there is a type mismatchvoid insert(int index, java.lang.Object value) throws DfException
index
- the location where the object will be inserted into the list.value
- the object instance to add to the list.DfException
- if there is a type mismatch, a null pointer exception,
or an index out of boundsvoid insertString(int index, java.lang.String value) throws DfException
index
- the location where the value will be inserted into the list.value
- the string value to add to the list.DfException
- if there is a type mismatchvoid insertInt(int index, int value) throws DfException
index
- the location where the value will be inserted into the list.value
- the int value to add to the list.DfException
- if there is a type mismatchvoid insertDouble(int index, double value) throws DfException
index
- the location where the value will be inserted into the list.value
- the double value to add to the list.DfException
- if there is a type mismatchvoid insertBoolean(int index, boolean value) throws DfException
index
- the location where the value will be inserted into the list.value
- the boolean value to add to the list.DfException
- if there is a type mismatchvoid insertId(int index, IDfId value) throws DfException
index
- the location where the object will be inserted into the list.value
- the object instance to add to the list.DfException
- if there is a type mismatchvoid insertTime(int index, IDfTime value) throws DfException
index
- the location where the object will be inserted into the list.value
- the object instance to add to the list.DfException
- if there is a type mismatchvoid insertValue(int index, IDfValue value) throws DfException
index
- the location where the object will be inserted into the list.value
- the object instance to add to the list.DfException
- if there is a type mismatchvoid insertList(int index, IDfList value) throws DfException
index
- the location where the object will be inserted into the list.value
- the object instance to add to the list.DfException
- if there is a type mismatchjava.lang.Object get(int index) throws DfException
index
- the location in the list where the Object will be fetched.DfException
- if there is a bad index valuejava.lang.String getString(int index) throws DfException
index
- the location in the list where the string value will be fetched.DfException
- if there is a type mismatchint getInt(int index) throws DfException
index
- the location in the list where the int value will be fetched.DfException
- if there is a type mismatchdouble getDouble(int index) throws DfException
index
- the location in the list where the double value will be fetched.DfException
- if there is a type mismatchboolean getBoolean(int index) throws DfException
index
- the location in the list where the boolean value will be fetched.DfException
- if there is a type mismatchIDfId getId(int index) throws DfException
index
- the location in the list where an instance of an IDfId object will be fetched.DfException
- if there is a type mismatchIDfTime getTime(int index) throws DfException
index
- the location in the list where an instance of an IDfTime object will be fetched.DfException
- if there is a type mismatchIDfValue getValue(int index) throws DfException
index
- the location in the list where an instance of an IDfValue object will be fetched.DfException
- if there is a type mismatchIDfList getList(int index) throws DfException
index
- the location in the list where an instance of an IDfList object will be fetched.DfException
- if there is a type mismatchvoid set(int index, java.lang.Object value) throws DfException
index
- the location where the object will be added to the list.value
- the object instance to add to the list.DfException
- if there is a type mismatch, a null value, or a
bad indexvoid setString(int index, java.lang.String value) throws DfException
index
- the location where the value will be added to the list.value
- the string value to add to the list.DfException
- if there is a type mismatchvoid setInt(int index, int value) throws DfException
index
- the location where the value will be added to the list.value
- the int value to add to the list.DfException
- if there is a type mismatchvoid setDouble(int index, double value) throws DfException
index
- the location where the value will be added to the list.value
- the double value to add to the list.DfException
- if there is a type mismatchvoid setBoolean(int index, boolean value) throws DfException
index
- the location where the value will be added to the list.value
- the boolean value to add to the list.DfException
- if there is a type mismatchvoid setId(int index, IDfId value) throws DfException
index
- the location where the object will be added to the list.value
- the object instance to add to the list.DfException
- if there is a type mismatchvoid setTime(int index, IDfTime value) throws DfException
index
- the location where the object will be added to the list.value
- the object instance to add to the list.DfException
- if there is a type mismatchvoid setValue(int index, IDfValue value) throws DfException
index
- the location where the object will be added to the list.value
- the object instance to add to the list.DfException
- if there is a type mismatchvoid setList(int index, IDfList value) throws DfException
index
- the location where the object will be added to the list.value
- the object instance to add to the list.DfException
- if there is a type mismatchint findIndex(java.lang.Object value) throws DfException
value
- the object to search for in the list.DfException
- if an unexpected error occursint findStringIndex(java.lang.String value) throws DfException
value
- the string value to search for in the list.DfException
- if an unexpected error occursint findIntIndex(int value) throws DfException
value
- the int value to search for in the list.DfException
- if an unexpected error occursint findDoubleIndex(double value) throws DfException
value
- the double value to search for in the list.DfException
- if an unexpected error occursint findBooleanIndex(boolean value) throws DfException
value
- the boolean value to search for in the list.DfException
- if an unexpected error occursint findIdIndex(IDfId value) throws DfException
value
- the IDfId object to search for in the list.DfException
- if an unexpected error occursint findTimeIndex(IDfTime value) throws DfException
value
- the IDfTime object to search for in the list.DfException
- if an unexpected error occursint findValueIndex(IDfValue value) throws DfException
value
- the IDfValue object to search for in the list.DfException
- if an unexpected error occursint findListIndex(IDfList value) throws DfException
value
- the IDfList object to search for in the list.DfException
- if an unexpected error occursvoid insertAll(int index, IDfList list) throws DfException
list
parameter must contain objects of type Object (or subtypes of
Object), otherwise an exception will be thrown.index
- the location where the object will be added to the list.list
- an IDfList object containing objects of type Object (or subtypes of Object).DfException
- if there is a type mismatchvoid remove(int index) throws DfException
index
- the location where the item will be removed.DfException
- if there is a bad indexvoid removeAll()
int getCount()
int getElementType()
setElementType
.void setElementType(int type)
The following code example demonstrates how to set the list element type and add a value: a DQL query:
IDfList listObj = new DfList(); listObj.setElementType(IDfList.DF_STRING); listObj.appendString("strVal");
type
- the datatype of the items in the list. The valid values are DF_BOOLEAN,
DF_INTEGER, DF_STRING, DF_ID, DF_TIME, DF_DOUBLE, DF_OBJECT,
DF_VALUE, and DF_LIST (ie a list of lists).int getElementTypeAt(int index) throws DfException
setElementType
.index
- the location where the datatype will be looked up.DfException
- if there is an unexpected errorCopyright 1994-2023 OpenText Corporation. All rights reserved.