public class UDFImpl extends MemberSupport implements UDFPlus, Sizeable, Externalizable
RETURN_FORMAT_JAVA
RETURN_FORMAT_JSON, RETURN_FORMAT_PLAIN, RETURN_FORMAT_SERIALIZE, RETURN_FORMAT_WDDX, RETURN_FORMAT_XML
Constructor and Description |
---|
UDFImpl()
DO NOT USE THIS CONSTRUCTOR!
this constructor is only for deserialize process
|
UDFImpl(UDFProperties properties) |
Modifier and Type | Method and Description |
---|---|
Object |
call(PageContext pc,
Collection.Key calledName,
Object[] args,
boolean doIncludePath)
call user defined Funcion with parameters as Object Array
|
Object |
call(PageContext pc,
Object[] args,
boolean doIncludePath)
call user defined Funcion with parameters as Object Array
|
Object |
callWithNamedValues(PageContext pc,
Collection.Key calledName,
Struct values,
boolean doIncludePath)
call user defined Funcion with a struct
|
Object |
callWithNamedValues(PageContext pc,
Struct values,
boolean doIncludePath)
call user defined Funcion with a hashmap of named values
|
Object |
clone() |
UDF |
duplicate() |
UDF |
duplicate(boolean deepCopy) |
UDF |
duplicate(ComponentImpl cfc) |
boolean |
equals(Object obj) |
static boolean |
equals(UDF left,
UDF right) |
Boolean |
getBufferOutput() |
Object |
getDefaultValue(PageContext pc,
int index) |
Object |
getDefaultValue(PageContext pc,
int index,
Object defaultValue) |
String |
getDescription() |
String |
getDisplayName() |
FunctionArgument[] |
getFunctionArguments()
return all function arguments of this UDF
|
String |
getFunctionName() |
String |
getHint() |
int |
getIndex() |
Struct |
getMeta() |
Struct |
getMetaData(PageContext pc) |
boolean |
getOutput() |
Component |
getOwnerComponent()
it is the component in whitch this udf is constructed, must not be the same as active udf
|
PageSource |
getPageSource() |
int |
getReturnFormat() |
int |
getReturnFormat(int defaultValue) |
String |
getReturnFormatAsString() |
int |
getReturnType() |
String |
getReturnTypeAsString() |
Boolean |
getSecureJson()
returns null when not defined
|
Object |
getValue()
return the value itself
|
Boolean |
getVerifyClient()
returns null when not defined
|
Object |
implementation(PageContext pageContext)
abstract method for the function Body
|
void |
readExternal(ObjectInput in) |
void |
setOwnerComponent(ComponentImpl component) |
long |
sizeOf()
return the size of the object
|
DumpData |
toDumpData(PageContext pageContext,
int maxlevel,
DumpProperties dp)
method to print out information to a object as HTML
|
static Collection.Key |
toKey(Object obj) |
String |
toString() |
void |
writeExternal(ObjectOutput out) |
getAccess, setAccess, setAccess
public UDFImpl()
public UDFImpl(UDFProperties properties)
public long sizeOf()
Sizeable
public UDF duplicate(ComponentImpl cfc)
public UDF duplicate(boolean deepCopy)
duplicate
in interface Duplicable
public Object implementation(PageContext pageContext) throws Throwable
UDF
implementation
in interface UDF
Throwable
public static Collection.Key toKey(Object obj)
public Object callWithNamedValues(PageContext pc, Struct values, boolean doIncludePath) throws PageException
UDF
callWithNamedValues
in interface UDF
values
- named valuesPageException
public Object callWithNamedValues(PageContext pc, Collection.Key calledName, Struct values, boolean doIncludePath) throws PageException
UDFPlus
callWithNamedValues
in interface UDFPlus
values
- named valuesPageException
public Object call(PageContext pc, Object[] args, boolean doIncludePath) throws PageException
UDF
call
in interface UDF
args
- parameters for the functionPageException
public Object call(PageContext pc, Collection.Key calledName, Object[] args, boolean doIncludePath) throws PageException
UDFPlus
call
in interface UDFPlus
args
- parameters for the functionPageException
public DumpData toDumpData(PageContext pageContext, int maxlevel, DumpProperties dp)
Dumpable
toDumpData
in interface Dumpable
public String getDisplayName()
getDisplayName
in interface UDF
public PageSource getPageSource()
getPageSource
in interface UDF
public Struct getMetaData(PageContext pc) throws PageException
getMetaData
in interface UDF
PageException
public void setOwnerComponent(ComponentImpl component)
setOwnerComponent
in interface UDFPlus
componentImpl
- the componentImpl to setinjected
- public Component getOwnerComponent()
UDF
getOwnerComponent
in interface UDF
public Boolean getSecureJson()
UDF
getSecureJson
in interface UDF
public Boolean getVerifyClient()
UDF
getVerifyClient
in interface UDF
public FunctionArgument[] getFunctionArguments()
UDF
getFunctionArguments
in interface UDF
public Object getDefaultValue(PageContext pc, int index) throws PageException
getDefaultValue
in interface UDF
PageException
public Object getDefaultValue(PageContext pc, int index, Object defaultValue) throws PageException
getDefaultValue
in interface UDFPlus
PageException
public String getFunctionName()
getFunctionName
in interface UDF
public boolean getOutput()
public Boolean getBufferOutput()
public int getReturnType()
getReturnType
in interface UDF
public String getReturnTypeAsString()
getReturnTypeAsString
in interface UDF
public String getDescription()
getDescription
in interface UDF
public int getReturnFormat()
getReturnFormat
in interface UDF
public int getReturnFormat(int defaultValue)
getReturnFormat
in interface UDFPlus
public final String getReturnFormatAsString()
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
Copyright © 2015 Lucee