Source for java.lang.Compiler

   1: /* Compiler.java -- placeholder for Java-to-native runtime compilers
   2:    Copyright (C) 1998, 1999, 2001, 2002, 2004, 2005  Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package java.lang;
  40: 
  41: /**
  42:  * The <code>Compiler</code> class is a placeholder for a JIT compiler
  43:  * implementation, and does nothing unless there is such a compiler.
  44:  *
  45:  * <p>The system property <code>java.compiler</code> may contain the name
  46:  * of a library to load with <code>System.loadLibrary</code> when the
  47:  * virtual machine first starts.  If so, and loading the library succeeds,
  48:  * then a function by the name of <code>java_lang_Compiler_start()</code>
  49:  * in that library is called.
  50:  *
  51:  * <p>Note that a VM might not have implemented any of this.
  52:  *
  53:  * @author Tom Tromey (tromey@cygnus.com)
  54:  * @see System#getProperty(String)
  55:  * @see System#getProperty(String, String)
  56:  * @see System#loadLibrary(String)
  57:  * @since JDK 1.0
  58:  * @status updated to 1.4
  59:  */
  60: public final class Compiler
  61: {
  62:   /**
  63:    * Don't allow new `Compiler's to be made.
  64:    */
  65:   private Compiler()
  66:   {
  67:   }
  68: 
  69:   /**
  70:    * Compile the class named by <code>oneClass</code>.
  71:    *
  72:    * @param oneClass the class to compile
  73:    * @return <code>false</code> if no compiler is available or
  74:    *         compilation failed, <code>true</code> if compilation succeeded
  75:    * @throws NullPointerException if oneClass is null
  76:    */
  77:   public static boolean compileClass(Class<?> oneClass)
  78:   {
  79:     return VMCompiler.compileClass(oneClass);
  80:   }
  81: 
  82:   /**
  83:    * Compile the classes whose name matches <code>classNames</code>.
  84:    *
  85:    * @param classNames the name of classes to compile
  86:    * @return <code>false</code> if no compiler is available or
  87:    *         compilation failed, <code>true</code> if compilation succeeded
  88:    * @throws NullPointerException if classNames is null
  89:    */
  90:   public static boolean compileClasses(String classNames)
  91:   {
  92:     return VMCompiler.compileClasses(classNames);
  93:   }
  94: 
  95:   /**
  96:    * This method examines the argument and performs an operation
  97:    * according to the compilers documentation.  No specific operation
  98:    * is required.
  99:    *
 100:    * @param arg a compiler-specific argument
 101:    * @return a compiler-specific value, including null
 102:    * @throws NullPointerException if the compiler doesn't like a null arg
 103:    */
 104:   public static Object command(Object arg)
 105:   {
 106:     return VMCompiler.command(arg);
 107:   }
 108: 
 109:   /**
 110:    * Calling <code>Compiler.enable()</code> will cause the compiler
 111:    * to resume operation if it was previously disabled; provided that a
 112:    * compiler even exists.
 113:    */
 114:   public static void enable()
 115:   {
 116:     VMCompiler.enable();
 117:   }
 118: 
 119:   /**
 120:    * Calling <code>Compiler.disable()</code> will cause the compiler
 121:    * to be suspended; provided that a compiler even exists.
 122:    */
 123:   public static void disable()
 124:   {
 125:     VMCompiler.disable();
 126:   }
 127: }