Rational Developer for Power Systems Software
V7.6

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

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.ibm.etools.iseries.rse.util.clprompter.ClSyntaxException
All Implemented Interfaces:
Serializable

public class ClSyntaxException
extends Exception

See Also:
Serialized Form

Field Summary
static String Copyright
           
 
Constructor Summary
ClSyntaxException()
          Constructor for ClSyntaxException.
ClSyntaxException(String arg0)
          Constructor for ClSyntaxException.
ClSyntaxException(SystemMessage msg)
          Constructor for ClSyntaxException.
ClSyntaxException(SystemMessage msg, boolean terminal)
          Constructor for ClSyntaxException.
ClSyntaxException(SystemMessage msg, boolean terminal, boolean stripOuterBrackets, boolean isVarException, boolean isBifException, boolean isExpressionException)
          A constructor for this class.
ClSyntaxException(SystemMessage msg, boolean terminal, boolean stripOuterBrackets, boolean isVarException, boolean isBifException, boolean isExpressionException, boolean isCharExpression)
          A constructor for this class.
 
Method Summary
 SystemMessage getSystemMessage()
          Used to retrieve the system message
 boolean isBifException()
          Indicates whether or not the exception is related to a BIF
 boolean isCharException()
           
 boolean isExpressionException()
          Indicates whether or not the exception is related to an expression
 boolean isTerminal()
          indicates whether or not the exception should be treated as terminal
 boolean isVarException()
          Indicates whether or not the exception is related to a variable
 boolean shouldStripOuterBrackets()
          indicates whether outer brackets should get stripped.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
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

ClSyntaxException

public ClSyntaxException()
Constructor for ClSyntaxException.


ClSyntaxException

public ClSyntaxException(String arg0)
Constructor for ClSyntaxException.

Parameters:
arg0 -

ClSyntaxException

public ClSyntaxException(SystemMessage msg)
Constructor for ClSyntaxException. terminal and stripOuterBrackets are set to false;

Parameters:
msg - the SystemMessage for the exception

ClSyntaxException

public ClSyntaxException(SystemMessage msg,
                         boolean terminal)
Constructor for ClSyntaxException. stripOuterBrackets is set to false.

Parameters:
msg - the SystemMessage for the exception
terminal - Whether or not the exception is terminal
Since:
6.0 @V1A

ClSyntaxException

public ClSyntaxException(SystemMessage msg,
                         boolean terminal,
                         boolean stripOuterBrackets,
                         boolean isVarException,
                         boolean isBifException,
                         boolean isExpressionException)
A constructor for this class.

Parameters:
msg - the SystemMessage for the exception
terminal - Whether or not the exception is terminal
stripOuterBrackets - Whether or not the exception indicates that outer brackets should be stripped.
isVarException - Indicates whether or not the exception is variable related
isBifException - Indicates whether or not the exception is related to a built-in function.
isExpressionException - Indicates whether or not the exception is related to an expression
Since:
6.0 @V1A

ClSyntaxException

public ClSyntaxException(SystemMessage msg,
                         boolean terminal,
                         boolean stripOuterBrackets,
                         boolean isVarException,
                         boolean isBifException,
                         boolean isExpressionException,
                         boolean isCharExpression)
A constructor for this class.

Parameters:
msg - the SystemMessage for the exception
terminal - Whether or not the exception is terminal
stripOuterBrackets - Whether or not the exception indicates that outer brackets should be stripped.
isVarException - Indicates whether or not the exception is variable related
isBifException - Indicates whether or not the exception is related to a built-in function.
isExpressionException - Indicates whether or not the exception is related to an expression
Since:
6.0 @V1A
Method Detail

getSystemMessage

public SystemMessage getSystemMessage()
Used to retrieve the system message

Returns:
The system message which is represented with this exception.

isTerminal

public boolean isTerminal()
indicates whether or not the exception should be treated as terminal

Returns:
true if the exception is terminal, false otherwise
Since:
6.0 @V1A

shouldStripOuterBrackets

public boolean shouldStripOuterBrackets()
indicates whether outer brackets should get stripped.

Returns:
True if the outer brackets should get stripped, false otherwise.
Since:
6.0 @V1A

isExpressionException

public boolean isExpressionException()
Indicates whether or not the exception is related to an expression

Returns:
true if this an expression related exception
Since:
6.0 @V1A

isBifException

public boolean isBifException()
Indicates whether or not the exception is related to a BIF

Returns:
true if this a built-in-function exception
Since:
6.0 @V1A

isVarException

public boolean isVarException()
Indicates whether or not the exception is related to a variable

Returns:
true if this exception is variable related
Since:
6.0 @V1A

isCharException

public boolean isCharException()

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.