com.ibm.etools.iseries.rse.util.clprompter
Class ClBuiltInFunction

java.lang.Object
  com.ibm.etools.iseries.rse.util.clprompter.ClBuiltInFunction

public class ClBuiltInFunction
extends Object

This class is used to parse CL built-in functions;

Since:

6.0

Field Summary

static String

Copyright

Constructor Summary

ClBuiltInFunction(String text)
The constructor for this class.

ClBuiltInFunction(String text, String kwd, int nestingLevel)
The constructor for this class.

Method Summary

int	getType() Indicates the type of built-in function
String	toString() Returns the formatted version of this built-in expression

Methods inherited from class java.lang.Object

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

Field Detail

Copyright

public static final String Copyright

See Also:

Constant Field Values

Constructor Detail

ClBuiltInFunction

public ClBuiltInFunction(String text)
                  throws ClSyntaxException,
                         ClParseException

The constructor for this class. Used to parse CL Built-in Functions.

Parameters:

text - The string to parse as a built-in function

Throws:

ClSyntaxException - This exception is issued when the built-in function has problems with its syntax. The message contained in this exception can be displayed.

ClParseException - This exception is issued when string provided isn't really a built-in function. The message contained in this exception is not for display.

ClBuiltInFunction

public ClBuiltInFunction(String text,
                         String kwd,
                         int nestingLevel)
                  throws ClSyntaxException,
                         ClParseException

The constructor for this class. Used to parse CL Built-in Functions.

Parameters:

text - The string to parse as a built-in function

kwd - The keyword that this built-in function is being parsed for - used for error message text.

nestingLevel - The nesting level of this built-in function

Throws:

ClSyntaxException - This exception is issued when the built-in function has problems with its syntax. The message contained in this exception can be displayed.

ClParseException - This exception is issued when string provided isn't really a built-in function. The message contained in this exception is not for display.

Method Detail

toString

public String toString()

Returns the formatted version of this built-in expression

Overrides:

toString in class Object

getType

public int getType()

Indicates the type of built-in function

Returns:

One of ClExpression.ARITHMATIC, ClExpression.CHARACTER, ClExpression.LOGICAL