railo.runtime.util
Interface VariableUtil

public interface VariableUtil

Variable Util

Method Summary

java.lang.Object	callFunction(PageContext pc, java.lang.Object coll, java.lang.String key, java.lang.Object[] args) call a Function (UDF, Method) with or witout named values
java.lang.Object	callFunctionWithNamedValues(PageContext pc, java.lang.Object coll, java.lang.String key, java.lang.Object[] args) call a Function (UDF, Method) with Named Values
java.lang.Object	callFunctionWithoutNamedValues(PageContext pc, java.lang.Object coll, java.lang.String key, java.lang.Object[] args) call a Function (UDF, Method) without Named Values
java.lang.Object	get(PageContext pc, java.lang.Object coll, java.lang.String key) return a property from the given Object, when property doesn't exists throw exception
java.lang.Object	get(PageContext pc, java.lang.Object coll, java.lang.String key, java.lang.Object defaultValue) return a property from the given Object, when property doesn't exists return null
java.lang.Object	getCollection(PageContext pc, java.lang.Object coll, java.lang.String key) return a property from the given Object, when coll is a query return a Column,when property doesn't exists throw exception
java.lang.Object	getCollection(PageContext pc, java.lang.Object coll, java.lang.String key, java.lang.Object defaultValue) return a property from the given Object, when property doesn't exists return null
java.lang.Object	getLight(PageContext pc, java.lang.Object coll, java.lang.String key, java.lang.Object defaultValue) return a property from the given Object, when property doesn't exists return null
java.lang.Object	remove(java.lang.Object coll, java.lang.String key) clear value from Collection
java.lang.Object	removeEL(java.lang.Object coll, java.lang.String key) remove value from Collection
java.lang.Object	set(PageContext pc, java.lang.Object coll, java.lang.String key, java.lang.Object value) sets a value to the Object
java.lang.Object	setEL(PageContext pc, java.lang.Object coll, java.lang.String key, java.lang.Object value) sets a value to the Object

Method Detail

getCollection

public java.lang.Object getCollection(PageContext pc,
                                      java.lang.Object coll,
                                      java.lang.String key,
                                      java.lang.Object defaultValue)

return a property from the given Object, when property doesn't exists return null

Parameters:

pc -

coll - Collection to check

key - to get from Collection

Returns:

value or null

get

public java.lang.Object get(PageContext pc,
                            java.lang.Object coll,
                            java.lang.String key,
                            java.lang.Object defaultValue)

return a property from the given Object, when property doesn't exists return null

Parameters:

pc -

coll - Collection to check

key - to get from Collection

Returns:

value or null

getLight

public java.lang.Object getLight(PageContext pc,
                                 java.lang.Object coll,
                                 java.lang.String key,
                                 java.lang.Object defaultValue)

return a property from the given Object, when property doesn't exists return null

Parameters:

pc -

coll - Collection to check

key - to get from Collection

Returns:

value or null

getCollection

public java.lang.Object getCollection(PageContext pc,
                                      java.lang.Object coll,
                                      java.lang.String key)
                               throws PageException

return a property from the given Object, when coll is a query return a Column,when property doesn't exists throw exception

Parameters:

pc -

coll - Collection to check

key - to get from Collection

Returns:

value value to get

Throws:

PageException

get

public java.lang.Object get(PageContext pc,
                            java.lang.Object coll,
                            java.lang.String key)
                     throws PageException

return a property from the given Object, when property doesn't exists throw exception

Parameters:

pc -

coll - Collection to check

key - to get from Collection

Returns:

value value to get

Throws:

PageException

set

public java.lang.Object set(PageContext pc,
                            java.lang.Object coll,
                            java.lang.String key,
                            java.lang.Object value)
                     throws PageException

sets a value to the Object

Parameters:

pc -

coll - Collection to check

key - to get from Collection

value - Value to set

Returns:

value setted

Throws:

PageException

setEL

public java.lang.Object setEL(PageContext pc,
                              java.lang.Object coll,
                              java.lang.String key,
                              java.lang.Object value)

sets a value to the Object

Parameters:

pc -

coll - Collection to check

key - to get from Collection

value - Value to set

Returns:

value setted or null if can't set

removeEL

public java.lang.Object removeEL(java.lang.Object coll,
                                 java.lang.String key)

remove value from Collection

Parameters:

coll -

key -

Returns:

has cleared or not

remove

public java.lang.Object remove(java.lang.Object coll,
                               java.lang.String key)
                        throws PageException

clear value from Collection

Parameters:

coll -

key -

Returns:

has cleared or not

Throws:

PageException

callFunction

public java.lang.Object callFunction(PageContext pc,
                                     java.lang.Object coll,
                                     java.lang.String key,
                                     java.lang.Object[] args)
                              throws PageException

call a Function (UDF, Method) with or witout named values

Parameters:

pc -

coll - Collection of the UDF Function

key - name of the function

args - arguments to call the function

Returns:

return value of the function

Throws:

PageException

callFunctionWithoutNamedValues

public java.lang.Object callFunctionWithoutNamedValues(PageContext pc,
                                                       java.lang.Object coll,
                                                       java.lang.String key,
                                                       java.lang.Object[] args)
                                                throws PageException

call a Function (UDF, Method) without Named Values

Parameters:

pc -

coll - Collection of the UDF Function

key - name of the function

args - arguments to call the function

Returns:

return value of the function

Throws:

PageException

callFunctionWithNamedValues

public java.lang.Object callFunctionWithNamedValues(PageContext pc,
                                                    java.lang.Object coll,
                                                    java.lang.String key,
                                                    java.lang.Object[] args)
                                             throws PageException

call a Function (UDF, Method) with Named Values

Parameters:

pc -

coll - Collection of the UDF Function

key - name of the function

args - arguments to call the function

Returns:

return value of the function

Throws:

PageException