public static class DataHandling.is_numeric extends AbstractFunction implements Optimizable
Optimizable.OptimizationOption
Function.CodeBranch
PULL_ME_UP, REMOVE_ME
Constructor and Description |
---|
DataHandling.is_numeric() |
Modifier and Type | Method and Description |
---|---|
String |
docs()
If a user asks for information about a particular function, this method is called to obtain the functions
usage.
|
ExampleScript[] |
examples()
Returns an array of example scripts, which are used for documentation purposes.
|
Construct |
exec(Target t,
Environment environment,
Construct... args)
This function is invoked when the script is run.
|
String |
getName()
The name of this function, exactly as should be used in a script.
|
boolean |
isRestricted()
Whether or not a function needs to be checked against the permissions file, if there are possible security concerns
with a user compiling, or running this function.
|
Integer[] |
numArgs()
The number of arguments this function can accept.
|
Set<Optimizable.OptimizationOption> |
optimizationOptions()
Returns an array of optimization options that apply to this function.
|
Boolean |
runAsync()
Whether or not to run this function asynchronously from the main server thread.
|
CHVersion |
since()
Returns the version number of when this functionality was added.
|
Exceptions.ExceptionType[] |
thrown()
Returns the types of catchable exceptions this function can throw.
|
allowBraces, appearInDocumentation, execs, getBundledDocs, getBundledDocs, getPermission, optimize, optimizeDynamic, preResolveVariables, profileAt, profileMessage, profileMessageS, shouldProfile, useSpecialExec, varList
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
optimize, optimizeDynamic
allowBraces, execs, preResolveVariables, profileAt, profileMessage, profileMessageS, shouldProfile, useSpecialExec
appearInDocumentation, getPermission
public String getName()
FunctionBase
[a-zA-Z_][a-zA-Z_0-9]*In other words, it must start with a letter or underscore, and may have any number of letters, numbers, or underscores after it.
getName
in interface Documentation
getName
in interface FunctionBase
public Integer[] numArgs()
FunctionBase
numArgs
in interface FunctionBase
public String docs()
FunctionBase
docs
in interface Documentation
docs
in interface FunctionBase
public Exceptions.ExceptionType[] thrown()
Function
public boolean isRestricted()
Function
isRestricted
in interface Function
public Boolean runAsync()
Function
public Construct exec(Target t, Environment environment, Construct... args) throws ConfigRuntimeException
Function
execs
will be called instead. If exec is needed,
execs should return CVoid.exec
in interface Function
args
- An array of evaluated ConstructsConfigRuntimeException
public CHVersion since()
Documentation
since
in interface Documentation
public Set<Optimizable.OptimizationOption> optimizationOptions()
Optimizable
optimizationOptions
in interface Optimizable
public ExampleScript[] examples() throws ConfigCompileException
Function
examples
in interface Function
examples
in class AbstractFunction
ConfigCompileException
Copyright © 2010-2013 Mostly Layton Smith. All Rights Reserved.