X-Git-Url: http://git.phpeclipse.com diff --git a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/corext/Assert.java b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/corext/Assert.java index 8b3356a..662ccdc 100644 --- a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/corext/Assert.java +++ b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/corext/Assert.java @@ -4,19 +4,20 @@ */ package net.sourceforge.phpdt.internal.corext; -//import org.phpeclipse.phpdt.internal.corext.refactoring.RefactoringCoreMessages; +// import +// org.phpeclipse.phpdt.internal.corext.refactoring.RefactoringCoreMessages; /** - * Assert is useful for for embedding runtime sanity checks - * in code. The static predicate methods all test a condition and throw some - * type of unchecked exception if the condition does not hold. + * Assert is useful for for embedding runtime sanity checks in + * code. The static predicate methods all test a condition and throw some type + * of unchecked exception if the condition does not hold. *

- * Assertion failure exceptions, like most runtime exceptions, are - * thrown when something is misbehaving. Assertion failures are invariably - * unspecified behavior; consequently, clients should never rely on - * these being thrown (or not thrown). If you find yourself in the - * position where you need to catch an assertion failure, you have most - * certainly written your program incorrectly. + * Assertion failure exceptions, like most runtime exceptions, are thrown when + * something is misbehaving. Assertion failures are invariably unspecified + * behavior; consequently, clients should never rely on these being thrown (or + * not thrown). If you find yourself in the position where you need to catch + * an assertion failure, you have most certainly written your program + * incorrectly. *

*

* Note that an assert statement is slated to be added to the @@ -26,12 +27,12 @@ package net.sourceforge.phpdt.internal.corext; public final class Assert { /** - * AssertionFailedException is a runtime exception thrown - * by some of the methods in Assert. + * AssertionFailedException is a runtime exception thrown by + * some of the methods in Assert. *

- * This class is not declared public to prevent some misuses; programs that catch - * or otherwise depend on assertion failures are susceptible to unexpected - * breakage when assertions in the code are added or removed. + * This class is not declared public to prevent some misuses; programs that + * catch or otherwise depend on assertion failures are susceptible to + * unexpected breakage when assertions in the code are added or removed. *

*/ public static class AssertionFailedException extends RuntimeException { @@ -55,19 +56,20 @@ public final class Assert { } /** - * Asserts that the given object is not null. If this - * is not the case, some kind of unchecked exception is thrown. + * Asserts that the given object is not null. If this is not + * the case, some kind of unchecked exception is thrown. *

* As a general rule, parameters passed to API methods must not be * null unless explicitly allowed in the method's * specification. Similarly, results returned from API methods are never * null unless explicitly allowed in the method's - * specification. Implementations are encouraged to make regular use of - * Assert.isNotNull to ensure that null + * specification. Implementations are encouraged to make regular use of + * Assert.isNotNull to ensure that null * parameters are detected as early as possible. *

* - * @param object the value to test + * @param object + * the value to test */ public static void isNotNull(Object object) { // succeed as quickly as possible @@ -78,34 +80,37 @@ public final class Assert { } /** - * Asserts that the given object is not null. If this - * is not the case, some kind of unchecked exception is thrown. - * The given message is included in that exception, to aid debugging. + * Asserts that the given object is not null. If this is not + * the case, some kind of unchecked exception is thrown. The given message + * is included in that exception, to aid debugging. *

* As a general rule, parameters passed to API methods must not be * null unless explicitly allowed in the method's * specification. Similarly, results returned from API methods are never * null unless explicitly allowed in the method's - * specification. Implementations are encouraged to make regular use of - * Assert.isNotNull to ensure that null + * specification. Implementations are encouraged to make regular use of + * Assert.isNotNull to ensure that null * parameters are detected as early as possible. *

* - * @param object the value to test - * @param message the message to include in the exception + * @param object + * the value to test + * @param message + * the message to include in the exception */ - public static void isNotNull(Object object, String message) { + public static void isNotNull(Object object, String message) { if (object == null) throw new AssertionFailedException("nullargument" + message); //$NON-NLS-1$ } /** - * Asserts that the given boolean is true. If this - * is not the case, some kind of unchecked exception is thrown. - * - * @param expression the outcome of the check - * @return true if the check passes (does not return - * if the check fails) + * Asserts that the given boolean is true. If this is not + * the case, some kind of unchecked exception is thrown. + * + * @param expression + * the outcome of the check + * @return true if the check passes (does not return if the + * check fails) */ public static boolean isTrue(boolean expression) { // succeed as quickly as possible @@ -116,14 +121,16 @@ public final class Assert { } /** - * Asserts that the given boolean is true. If this - * is not the case, some kind of unchecked exception is thrown. - * The given message is included in that exception, to aid debugging. - * - * @param expression the outcome of the check - * @param message the message to include in the exception - * @return true if the check passes (does not return - * if the check fails) + * Asserts that the given boolean is true. If this is not + * the case, some kind of unchecked exception is thrown. The given message + * is included in that exception, to aid debugging. + * + * @param expression + * the outcome of the check + * @param message + * the message to include in the exception + * @return true if the check passes (does not return if the + * check fails) */ public static boolean isTrue(boolean expression, String message) { if (!expression)