Source for java.lang.management.CompilationMXBean

   1: /* CompilationMXBean.java - Interface for a compilation bean
   2:    Copyright (C) 2006 Free Software Foundation
   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: package java.lang.management;
  39: 
  40: /**
  41:  * Provides access to information about the Just-In-Time
  42:  * (JIT) compiler provided by the virtual machine, if one
  43:  * exists.  An instance of this bean is obtainable by
  44:  * calling {@link ManagementFactory#getCompilationMXBean()}
  45:  * if a JIT is available.  Otherwise, the method returns
  46:  * <code>null</code>.
  47:  *
  48:  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  49:  * @since 1.5
  50:  */
  51: public interface CompilationMXBean
  52: {
  53:   
  54:   /**
  55:    * Returns the name of the Just-In-Time (JIT) compiler.
  56:    *
  57:    * @return the name of the JIT compiler.
  58:    */
  59:   String getName();
  60: 
  61:   /**
  62:    * Returns true if the virtual machine's JIT compiler
  63:    * supports monitoring of the time spent compiling.
  64:    *
  65:    * @return true if the JIT compiler can be monitored
  66:    *         for time spent compiling.
  67:    */
  68:   boolean isCompilationTimeMonitoringSupported();
  69: 
  70:   /**
  71:    * Returns the accumulated time, in milliseconds, that
  72:    * the JIT compiler has spent compiling Java bytecodes
  73:    * to native machine code.  This value represents a single
  74:    * time measurement for the whole virtual machine, including
  75:    * all multiple threads of operation.  The value is not
  76:    * intended as a performance measurement.
  77:    *
  78:    * @return the accumulated number of milliseconds the JIT
  79:    *         compiler has spent compiling.
  80:    * @throws UnsupportedOperationException if time monitoring
  81:    *                                       is not supported.
  82:    */
  83:   long getTotalCompilationTime();
  84: 
  85: }