View Javadoc

1   /*
2    * Jour - java profiler and monitoring library
3    *
4    * Copyright (C) 2004 Jour team
5    *
6    * This library is free software; you can redistribute it and/or
7    * modify it under the terms of the GNU Library General Public
8    * License as published by the Free Software Foundation; either
9    * version 2 of the License, or (at your option) any later version.
10   *
11   * This library is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14   * Library General Public License for more details.
15   *
16   * You should have received a copy of the GNU Library General Public
17   * License along with this library; if not, write to the
18   * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19   * Boston, MA  02111-1307, USA.
20   */
21  package net.sf.jour;
22  
23  /***
24   * Conditional compile.
25   * 
26   *  The conditional compilation practice is used to optionally 
27   * remove chunks of code from the compiled version of a class. 
28   * It uses the fact that compilers will ignore any unreachable branches of code. 
29   * 
30   *  To implement conditional compilation,
31   * place code which is to be conditionally compiled in an if block which 
32   * evaluates the boolean Debug.ON 
33   * 
34   *  With the advent of assert in JDK 1.4, the utility of conditional 
35   * compilation is probably reduced. 
36   * But we need to support Java 1.3 compilation for now.
37   * 
38   * Created on 04.12.2004
39   *
40   * Contributing Author(s):
41   *
42   *   Misha Lifschitz <mishalifschitz at users.sourceforge.net> (Inital implementation)
43   *   Vlad Skarzhevskyy <vlads at users.sourceforge.net> (Inital implementation)
44   *
45   * @author vlads
46   * @version $Revision: 1.1 $ ($Author: vlads $) $Date: 2004/12/05 02:17:08 $
47   */
48  public final class Debug {
49      //set to false to allow compiler to identify and eliminate
50      //unreachable code
51      public static final boolean ON = true;
52  }