railo.runtime.type
Class UDFSetterProperty

java.lang.Object
  extended by railo.runtime.component.MemberSupport
      extended by railo.runtime.type.UDFImpl
          extended by railo.runtime.type.UDFGSProperty
              extended by railo.runtime.type.UDFSetterProperty
All Implemented Interfaces:
Externalizable, Serializable, Cloneable, Member, Dumpable, Function, Duplicable, Sizeable, UDF, UDFPlus

public final class UDFSetterProperty
extends UDFGSProperty

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface railo.runtime.type.UDF
RETURN_FORMAT_JSON, RETURN_FORMAT_PLAIN, RETURN_FORMAT_SERIALIZE, RETURN_FORMAT_WDDX, RETURN_FORMAT_XML
 
Constructor Summary
UDFSetterProperty(ComponentImpl component, Property prop)
           
 
Method Summary
 Object call(PageContext pageContext, Object[] args, boolean doIncludePath)
          call user defined Funcion with parameters as Object Array
 Object callWithNamedValues(PageContext pageContext, Struct values, boolean doIncludePath)
          call user defined Funcion with a hashmap of named values
 UDF duplicate()
           
 UDF duplicate(ComponentImpl c)
           
 Object getDefaultValue(PageContext pc, int index)
           
 Object getDefaultValue(PageContext pc, int index, Object defaultValue)
           
 String getReturnTypeAsString()
           
 Object implementation(PageContext pageContext)
          abstract method for the function Body
 
Methods inherited from class railo.runtime.type.UDFGSProperty
getAccess, getDescription, getDisplayName, getFunctionArguments, getFunctionName, getHint, getMetaData, getOutput, getOwnerComponent, getPage, getReturnFormat, getReturnType, getSecureJson, getValue, getVerifyClient, toDumpData
 
Methods inherited from class railo.runtime.type.UDFImpl
argumentCollection, argumentCollection, clone, duplicate, equals, equals, getBufferOutput, getIndex, getMeta, getPageSource, getReturnFormatAsString, readExternal, setOwnerComponent, sizeOf, toDumpData, toKey, toReturnFormat, toReturnFormat, toReturnFormat, toString, writeExternal
 
Methods inherited from class railo.runtime.component.MemberSupport
setAccess, setAccess
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UDFSetterProperty

public UDFSetterProperty(ComponentImpl component,
                         Property prop)
                  throws PageException
Throws:
PageException
Method Detail

duplicate

public UDF duplicate(ComponentImpl c)
Overrides:
duplicate in class UDFImpl

duplicate

public UDF duplicate()
Specified by:
duplicate in interface UDF
Overrides:
duplicate in class UDFImpl

call

public Object call(PageContext pageContext,
                   Object[] args,
                   boolean doIncludePath)
            throws PageException
Description copied from interface: UDF
call user defined Funcion with parameters as Object Array

Specified by:
call in interface UDF
Overrides:
call in class UDFImpl
args - parameters for the function
Returns:
return value of the function
Throws:
PageException

callWithNamedValues

public Object callWithNamedValues(PageContext pageContext,
                                  Struct values,
                                  boolean doIncludePath)
                           throws PageException
Description copied from interface: UDF
call user defined Funcion with a hashmap of named values

Specified by:
callWithNamedValues in interface UDF
Overrides:
callWithNamedValues in class UDFImpl
values - named values
Returns:
return value of the function
Throws:
PageException

getDefaultValue

public Object getDefaultValue(PageContext pc,
                              int index)
                       throws PageException
Specified by:
getDefaultValue in interface UDF
Overrides:
getDefaultValue in class UDFImpl
Returns:
default value
Throws:
PageException

getDefaultValue

public Object getDefaultValue(PageContext pc,
                              int index,
                              Object defaultValue)
                       throws PageException
Specified by:
getDefaultValue in interface UDFPlus
Overrides:
getDefaultValue in class UDFImpl
Throws:
PageException

getReturnTypeAsString

public String getReturnTypeAsString()
Specified by:
getReturnTypeAsString in interface UDF
Overrides:
getReturnTypeAsString in class UDFImpl
Returns:
Returns the returnType.

implementation

public Object implementation(PageContext pageContext)
                      throws Throwable
Description copied from interface: UDF
abstract method for the function Body

Specified by:
implementation in interface UDF
Overrides:
implementation in class UDFImpl
Throws:
Throwable


Copyright © 2012 Railo