OracleOciCollection (Resin 4.0.s170329)

java.lang.Object
- com.caucho.quercus.lib.db.OracleOciCollection

public class OracleOciCollection
extends java.lang.Object

Quercus Oracle OCI-Collection object oriented API.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`append(Env env, Value value)` Appends element to the collection
`boolean`	`assign(Env env, OracleOciCollection fromCollection)` Assigns a value to the collection from another existing collection
`boolean`	`assignElem(Env env, int index, Value value)` Assigns a value to the element of the collection
`boolean`	`free(Env env)` Frees the resources associated with the collection object
`protected java.sql.Array`	`getCollection()` Returns the underlying Oracle collection
`Value`	`getElem(Env env, int index)` Returns value of the element by index (1-based)
`protected java.util.ArrayList<java.lang.Object>`	`getJavaCollection()` Returns the underlying Java collection
`LongValue`	`max(Env env)` Returns the maximum number of elements in the collection If the returned value is 0, then the number of elements is not limited.
`LongValue`	`size(Env env)` Returns size of the collection
`java.lang.String`	`toString()`
`boolean`	`trim(Env env, int num)` Trims num elements from the end of the collection

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - append
```
public boolean append(Env env,
                      Value value)
```
    Appends element to the collection
    
    Parameters:
    
    value - can be a string or a number
  - assign
```
public boolean assign(Env env,
                      OracleOciCollection fromCollection)
```
    Assigns a value to the collection from another existing collection
  - assignElem
```
public boolean assignElem(Env env,
                          int index,
                          Value value)
```
    Assigns a value to the element of the collection
    
    Parameters:
    
    index - 1-based index
    
    value - can be a string or a number
  - free
```
public boolean free(Env env)
```
    Frees the resources associated with the collection object
  - getCollection
```
protected java.sql.Array getCollection()
```
    Returns the underlying Oracle collection
  - getElem
```
public Value getElem(Env env,
                     int index)
```
    Returns value of the element by index (1-based)
  - getJavaCollection
```
protected java.util.ArrayList<java.lang.Object> getJavaCollection()
```
    Returns the underlying Java collection
  - max
```
public LongValue max(Env env)
```
    Returns the maximum number of elements in the collection If the returned value is 0, then the number of elements is not limited. Returns FALSE in case of error.
  - size
```
public LongValue size(Env env)
```
    Returns size of the collection
  - trim
```
public boolean trim(Env env,
                    int num)
```
    Trims num elements from the end of the collection
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class OracleOciCollection

Method Summary

Methods inherited from class java.lang.Object

Method Detail

append

assign

assignElem

free

getCollection

getElem

getJavaCollection

max

size

trim

toString