org.quattor.pan.dml.functions

Class BuiltInFunction

java.lang.Object

org.quattor.pan.dml.AbstractOperation

org.quattor.pan.dml.functions.BuiltInFunction

All Implemented Interfaces:

Operation

Direct Known Subclasses:

AbstractMatcher, Append, Base64Decode, Base64Encode, Clone, Create, Debug, DebugSuppressed, Delete, Deprecated, Digest, ErrorMessage, Escape, Exists, FileContents, FileExists, First, Format, Hash, IfExists, Index, IpToLong, IsOfType, Key, Length, List, LongToIp, Merge, Next, PathExists, Prepend, Replace, Return, Splice, Split, Substitute, Substr, ToBoolean, ToDouble, ToLong, ToLongRadix, ToLowerCase, ToString, ToUpperCase, Traceback, TracebackSuppressed, Unescape, Value

public abstract class BuiltInFunction
extends AbstractOperation

This is just a marker class to identify those classes that are built-in functions in the pan language. All built-in functions must have a factory method getInstance(SourceRange, Operation, ...) that allows an instance to be created. The return value must be an Operation to allow the method to optimize the given function call. These restrictions cannot be enforced by the java language itself. They are enforced through the JUnit test functions associated with this class.

Author:

loomis

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name

Fields inherited from class org.quattor.pan.dml.AbstractOperation

ops, sourceRange

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BuiltInFunction(String name, SourceRange sourceRange, Operation... operations)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	throwExceptionIfCompileTimeContext(Context context)
String	toString() Default string representation of an operation is the class' simple name.

Methods inherited from class org.quattor.pan.dml.AbstractOperation

calculateArgs, calculateTerms, checkInvalidSelfContext, checkRestrictedContext, execute, getOperations, getSourceRange

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

protected final String name

Constructor Detail

BuiltInFunction

protected BuiltInFunction(String name,
               SourceRange sourceRange,
               Operation... operations)

Method Detail

throwExceptionIfCompileTimeContext

protected void throwExceptionIfCompileTimeContext(Context context)

toString

public String toString()

Description copied from class: AbstractOperation

Default string representation of an operation is the class' simple name.

Overrides:

toString in class AbstractOperation

Returns:

string of class' simple name