Rational Developer for Power Systems Software
V7.6

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

java.lang.Object
  extended by com.ibm.etools.iseries.rse.util.clprompter.ClVariable

public class ClVariable
extends Object

Used to parse variable names!


Field Summary
static String Copyright
           
static int DCL_VARIABLE_NAME_LENGTH
          the length CL allows for declared variable names
static int VARIABLE_NAME_LENGTH
          the length CL allows for variable names
 
Constructor Summary
ClVariable(String text)
          Constructor for this class.
ClVariable(String text, String kwd)
          Constructor for this class.
 
Method Summary
 String toString()
          returns the uppercased variable name
 
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

VARIABLE_NAME_LENGTH

public static final int VARIABLE_NAME_LENGTH
the length CL allows for variable names

See Also:
Constant Field Values

DCL_VARIABLE_NAME_LENGTH

public static final int DCL_VARIABLE_NAME_LENGTH
the length CL allows for declared variable names

See Also:
Constant Field Values
Constructor Detail

ClVariable

public ClVariable(String text)
           throws ClParseException,
                  ClSyntaxException
Constructor for this class. Parses the text for a variable name.

Parameters:
text - The text to parse as a variable.
Throws:
ClParseException - This exception is thrown when the text supplied isn't a correct CL variable. The message contained in this exception is not for display.
ClSyntaxException - Never is issued for this constructor

ClVariable

public ClVariable(String text,
                  String kwd)
           throws ClParseException,
                  ClSyntaxException
Constructor for this class.

Parameters:
text - The text to parse as a variable.
kwd - The keyword that this variable is being parsed for. Used in the message for the ClSyntaxException.
Throws:
ClParseException - This exception is thrown when the text supplied isn't a correct CL variable. The message contained in this exception is not for display.
ClSyntaxException - This exception is thrown when the variable name is too long, and kwd is specified. The message contained in this exception can be displayed.
Method Detail

toString

public String toString()
returns the uppercased variable name

Overrides:
toString in class Object

Rational Developer for Power Systems Software
V7.6

Copyright 2011 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.