railo.runtime.type
Class FunctionArgumentLight

java.lang.Object
  extended by railo.runtime.type.FunctionArgumentLight
All Implemented Interfaces:
Externalizable, Serializable, FunctionArgument

public final class FunctionArgumentLight
extends Object
implements FunctionArgument, Externalizable

a single argument of a function, this is lightway function, just contain name and type (return default value for the rest)

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface railo.runtime.type.FunctionArgument
DEFAULT_TYPE_LITERAL, DEFAULT_TYPE_NULL, DEFAULT_TYPE_RUNTIME_EXPRESSION
 
Constructor Summary
FunctionArgumentLight()
          NEVER USE THIS CONSTRUCTOR, this constructor is only for deserialize this object from stream
FunctionArgumentLight(Collection.Key name)
           
FunctionArgumentLight(Collection.Key name, short type)
           
FunctionArgumentLight(Collection.Key name, String strType, short type)
           
 
Method Summary
 int getDefaultType()
           
 String getDisplayName()
           
 String getDspName()
          Deprecated. replaced with getDisplayName();
 String getHint()
           
 Struct getMetaData()
           
 Collection.Key getName()
           
 short getType()
           
 String getTypeAsString()
           
 boolean isPassByReference()
           
 boolean isRequired()
           
 void readExternal(ObjectInput in)
           
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FunctionArgumentLight

public FunctionArgumentLight()
NEVER USE THIS CONSTRUCTOR, this constructor is only for deserialize this object from stream


FunctionArgumentLight

public FunctionArgumentLight(Collection.Key name)

FunctionArgumentLight

public FunctionArgumentLight(Collection.Key name,
                             short type)

FunctionArgumentLight

public FunctionArgumentLight(Collection.Key name,
                             String strType,
                             short type)
Method Detail

getDefaultType

public int getDefaultType()
Specified by:
getDefaultType in interface FunctionArgument
Returns:
the defaultType

getName

public Collection.Key getName()
Specified by:
getName in interface FunctionArgument
Returns:
Returns the name of the argument.
See Also:
FunctionArgument.getName()

isRequired

public boolean isRequired()
Specified by:
isRequired in interface FunctionArgument
Returns:
Returns if argument is required or not.
See Also:
FunctionArgument.isRequired()

getType

public short getType()
Specified by:
getType in interface FunctionArgument
Returns:
Returns the type of the argument.
See Also:
FunctionArgument.getType()

getTypeAsString

public String getTypeAsString()
Specified by:
getTypeAsString in interface FunctionArgument
Returns:
Returns the type of the argument.
See Also:
FunctionArgument.getTypeAsString()

getHint

public String getHint()
Specified by:
getHint in interface FunctionArgument
Returns:
Returns the Hint of the argument.
See Also:
FunctionArgument.getHint()

getDisplayName

public String getDisplayName()
Specified by:
getDisplayName in interface FunctionArgument
Returns:
Returns the Display name of the argument.
See Also:
FunctionArgument.getDisplayName()

getDspName

public String getDspName()
Deprecated. replaced with getDisplayName();

Specified by:
getDspName in interface FunctionArgument
Returns:
Returns the display name (Label) of the argument.
See Also:
FunctionArgument.getDspName()

getMetaData

public Struct getMetaData()
Specified by:
getMetaData in interface FunctionArgument
Returns:
the meta data defined
See Also:
FunctionArgument.getMetaData()

isPassByReference

public boolean isPassByReference()
Specified by:
isPassByReference in interface FunctionArgument

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException


Copyright © 2012 Railo