lucee.runtime.util

Interface VariableUtil

public interface VariableUtil

Variable Util

Method Summary

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

Method Detail

getCollection

Object getCollection(PageContext pc,
                     Object coll,
                     String key,
                     Object defaultValue)

Deprecated. use instead

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

See Also:

getCollection(PageContext, Object, lucee.runtime.type.Collection.Key, Object)

getCollection

Object getCollection(PageContext pc,
                     Object coll,
                     Collection.Key key,
                     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

@Deprecated
Object get(PageContext pc,
                       Object coll,
                       String key,
                       Object defaultValue)

Deprecated. use instead get(PageContext pc, Object coll, Collection.Key key, 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

Object get(PageContext pc,
           Object coll,
           Collection.Key key,
           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

Object getLight(PageContext pc,
                Object coll,
                String key,
                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

Object getCollection(PageContext pc,
                     Object coll,
                     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

Object get(PageContext pc,
           Object coll,
           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

@Deprecated
Object set(PageContext pc,
                       Object coll,
                       String key,
                       Object value)
                throws PageException

Deprecated. use instead set(PageContext pc, Object coll, Collection.Key key,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

Throws:

PageException

set

Object set(PageContext pc,
           Object coll,
           Collection.Key key,
           Object value)
    throws PageException

Throws:

PageException

setEL

@Deprecated
Object setEL(PageContext pc,
                         Object coll,
                         String key,
                         Object value)

Deprecated. use instead setEL(PageContext pc, Object coll, Collection.Key key,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

setEL

Object setEL(PageContext pc,
             Object coll,
             Collection.Key key,
             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

@Deprecated
Object removeEL(Object coll,
                            String key)

Deprecated.

remove value from Collection

Parameters:

coll -

key -

Returns:

has cleared or not

removeEL

Object removeEL(Object coll,
                Collection.Key key)

remove

@Deprecated
Object remove(Object coll,
                          String key)
                   throws PageException

Deprecated.

clear value from Collection

Parameters:

coll -

key -

Returns:

has cleared or not

Throws:

PageException

remove

Object remove(Object coll,
              Collection.Key key)
       throws PageException

Throws:

PageException

callFunction

Object callFunction(PageContext pc,
                    Object coll,
                    String key,
                    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

@Deprecated
Object callFunctionWithoutNamedValues(PageContext pc,
                                                  Object coll,
                                                  String key,
                                                  Object[] args)
                                           throws PageException

Deprecated. use instead callFunctionWithoutNamedValues(PageContext pc, Object coll, Collection.Key key, Object[] args)

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

callFunctionWithoutNamedValues

Object callFunctionWithoutNamedValues(PageContext pc,
                                      Object coll,
                                      Collection.Key key,
                                      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

@Deprecated
Object callFunctionWithNamedValues(PageContext pc,
                                               Object coll,
                                               String key,
                                               Object[] args)
                                        throws PageException

Deprecated. use instead callFunctionWithNamedValues(PageContext pc, Object coll, Collection.Key key, Object[] args)

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

callFunctionWithNamedValues

Object callFunctionWithNamedValues(PageContext pc,
                                   Object coll,
                                   Collection.Key key,
                                   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

callFunctionWithNamedValues

Object callFunctionWithNamedValues(PageContext pc,
                                   Object coll,
                                   Collection.Key key,
                                   Struct args)
                            throws PageException

Throws:

PageException