|
JDeveloper SCM API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.ide.scm.util.SCMAssert
The version control framework's assertion and exception handler. Use this class to test code states, raising runtime exceptions if conditions fail. Serious exceptions should always be reported through this class.
Method Summary | |
static void |
check(boolean condition)
Check a condition within a method body. |
static void |
check(boolean condition,
java.lang.String description)
Check a condition within a method body. |
static void |
checkAWTThread()
Checks that the current thread is the AWT event dispatcher. |
static void |
fail()
Shorthand for causing a check exception if the code reaches an unexpected location. |
static void |
fail(java.lang.Exception ex)
Shorthand for causing a check exception if the code reaches an unexpected location. |
static void |
fail(java.lang.String description)
Shorthand for causing a check exception if the code reaches an unexpected location. |
static boolean |
isEnabled()
Asks whether assertion checking and message reporting is enabled. |
static void |
precondition(boolean condition)
Assert a precondition before a method body run. |
static void |
precondition(boolean condition,
java.lang.String description)
Assert a precondition before a method body run. |
static void |
print(boolean condition,
java.lang.String s)
Print a string to standard error if a condition is true. |
static void |
print(boolean condition,
java.lang.String trueString,
java.lang.String falseString)
Print a string to standard error based on the evaluation of a condition. |
static void |
print(java.lang.String s)
Print a string to standard error. |
static void |
println(boolean condition,
java.lang.String s)
Print a string and a newline to standard error if a condition is true |
static void |
println(boolean condition,
java.lang.String trueString,
java.lang.String falseString)
Print a string and a newline to standard error based on the evaluation of a condition. |
static void |
println(java.lang.String s)
Print a string and a newline to standard error. |
static void |
printStackTrace()
Print a diagnostic stack trace of the current thread. |
static void |
printStackTrace(boolean condition,
java.lang.String s)
Print a diagnostic stack trace if the specified condition is true. |
static void |
printStackTrace(java.lang.Throwable ex)
Print the stack trace of a Throwable. |
static void |
report(java.lang.Throwable t)
Reports the given exception through the UI. |
static void |
report(java.lang.Throwable t,
java.awt.Component parent)
Reports the given exception through the UI, parented to the given component. |
static void |
setEnabled(boolean enabled)
Sets whether assertion checking and message printing is enabled. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public static void setEnabled(boolean enabled)
Note that errors can be reported in the form of stack traces to the console (runtime exceptions only) and UI dialogs without enabling this property.
enabled
- the enablement value to set.public static boolean isEnabled()
public static void precondition(boolean condition, java.lang.String description) throws oracle.ide.scm.util.SCMAssert.PreconditionException
condition
- The condition being asserted.description
- The description of the failed assertionpublic static void precondition(boolean condition) throws oracle.ide.scm.util.SCMAssert.PreconditionException
condition
- The condition being asserted.public static void check(boolean condition, java.lang.String description) throws oracle.ide.scm.util.SCMAssert.CheckException
condition
- The condition being asserted.description
- The description of the failed assertionpublic static void check(boolean condition) throws oracle.ide.scm.util.SCMAssert.CheckException
condition
- The condition being asserted.public static void checkAWTThread() throws oracle.ide.scm.util.SCMAssert.CheckException
public static void fail(java.lang.String description) throws oracle.ide.scm.util.SCMAssert.CheckException
description
- The description of the failurepublic static void fail() throws oracle.ide.scm.util.SCMAssert.CheckException
public static void fail(java.lang.Exception ex) throws oracle.ide.scm.util.SCMAssert.CheckException
ex
- An exception encapsulating the failurepublic static void printStackTrace()
public static void printStackTrace(java.lang.Throwable ex)
This method does not require the assertion class to be enabled if the given exception is an instance of RuntimeException.
ex
- The Throwable with the stack trace info.public static void printStackTrace(boolean condition, java.lang.String s)
condition
- the condition that determines whether to print the
stack trace.s
- the string to print before the stack trace.public static void print(java.lang.String s)
s
- the string to print.public static void print(boolean condition, java.lang.String s)
condition
- the condition to evaluates
- the string to print.public static void print(boolean condition, java.lang.String trueString, java.lang.String falseString)
condition
- the condition to evaluatetrueString
- the string to print if condition
is
true.falseString
- the string to print if condition
is
false.public static void println(java.lang.String s)
s
- the string to printpublic static void println(boolean condition, java.lang.String s)
condition
- the condition to evaluates
- the string to print.public static void println(boolean condition, java.lang.String trueString, java.lang.String falseString)
condition
- the condition to evaluatetrueString
- the string to print if condition
is
true.falseString
- the string to print if condition
is
false.public static void report(java.lang.Throwable t)
This method does not require the assertion class to be enabled.
t
- the exception to report.public static void report(java.lang.Throwable t, java.awt.Component parent)
This method does not require the assertion class to be enabled.
t
- the exception to report.parent
- the component parent for the exception report dialog.
|
Copyright © 2002 Oracle Corporation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |