1 /*
2 * Scope: a generic MVC framework.
3 * Copyright (c) 2000-2002, The Scope team
4 * All rights reserved.
5 *
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 *
14 * Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 *
18 * Neither the name "Scope" nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
27 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
28 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
29 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
30 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 *
35 *
36 * $Id: Debug.java,v 1.6 2002/09/05 15:41:46 ludovicc Exp $
37 */
38 package org.scopemvc.util;
39
40
41 import org.apache.commons.logging.Log;
42 import org.apache.commons.logging.LogFactory;
43
44 /***
45 * <P>
46 *
47 * A (very simple) general purpose Debug class for assertion checking. e.g.
48 * <PRE>
49 * if (Debug.ON) Debug.assert(thing != null);
50 * if (Debug.ON) Debug.assert(thing != null, "thing is null");
51 * </PRE> The ON boolean is a <CODE>static final</CODE> so that setting it to
52 * false and rebuilding the project will strip all debug code from the binaries.
53 * </P>
54 *
55 * @author <A HREF="mailto:smeyfroi@users.sourceforge.net">Steve Meyfroidt</A>
56 * @created 05 September 2002
57 * @version $Revision: 1.6 $ $Date: 2002/09/05 15:41:46 $
58 */
59 public final class Debug {
60
61 /***
62 * Global debug flag to switch debug code on and off. This must be a <CODE>static final</CODE>
63 * for the compiler to dead-strip all debug statements, which must be
64 * prefixed with: <CODE>if (Debug.ON)</CODE>
65 */
66 public final static boolean ON = true;
67
68 private final static Log LOG = LogFactory.getLog(Debug.class);
69
70
71 /***
72 * Don't create a Debug -- use static methods.
73 */
74 private Debug() { }
75
76
77 /***
78 * Test preconditions and postconditions like this (but don't include code
79 * in the assertion that changes the state of anything because it'll be
80 * stripped in non-debug versions): <pre>
81 * if (Debug.ON) Debug.assert(thing != null);
82 * </pre>
83 *
84 * @param inCondition TODO: Describe the Parameter
85 */
86 public static void assertTrue(boolean inCondition) {
87 if (!inCondition) {
88 LOG.fatal(">>> Assertion failed >>>");
89 LOG.fatal(">>> at >>>", new Throwable());
90 throw new RuntimeException("Assertion failure");
91 }
92 }
93
94
95 // public static void assert(boolean inCondition) {
96 // assertTrue(inCondition);
97 // }
98
99
100 /***
101 * TODO: document the method
102 *
103 * @param inCondition TODO: Describe the Parameter
104 * @param inMessage TODO: Describe the Parameter
105 */
106 public static void assertTrue(boolean inCondition, String inMessage) {
107 if (!inCondition) {
108 LOG.fatal(">>> Assertion failed: " + inMessage);
109 LOG.fatal(">>> at >>>", new Throwable());
110 throw new RuntimeException("Assertion failure: " + inMessage);
111 }
112 }
113
114 // public static void assert(boolean inCondition, String inMessage) {
115 // assertTrue(inCondition, inMessage);
116 // }
117 }
118
This page was automatically generated by Maven