Source for java.lang.management.ClassLoadingMXBean

   1: /* ClassLoadingMXBean.java - Interface for a class loading 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 class loading
  42:  * behaviour of the current invocation of the virtual
  43:  * machine.  An instance of this bean is obtained by calling
  44:  * {@link ManagementFactory#getClassLoadingMXBean()}.
  45:  *
  46:  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  47:  * @since 1.5
  48:  */
  49: public interface ClassLoadingMXBean
  50: {
  51: 
  52:   /**
  53:    * Returns the number of classes currently loaded by
  54:    * the virtual machine.
  55:    *
  56:    * @return the number of loaded classes.
  57:    */
  58:   int getLoadedClassCount();
  59: 
  60:   /**
  61:    * Returns the total number of classes loaded by the
  62:    * virtual machine since it was started.  This is the
  63:    * sum of the currently loaded classes and those that
  64:    * have been unloaded.
  65:    *
  66:    * @return the total number of classes that have been
  67:    *         loaded by the virtual machine since it started.
  68:    */
  69:   long getTotalLoadedClassCount();
  70: 
  71:   /**
  72:    * Returns the number of classes that have been unloaded
  73:    * by the virtual machine since it was started.
  74:    *
  75:    * @return the number of unloaded classes.
  76:    */
  77:   long getUnloadedClassCount();
  78: 
  79:   /**
  80:    * Returns true if the virtual machine will emit additional
  81:    * information when classes are loaded and unloaded.  The
  82:    * format of the output is left up to the virtual machine.
  83:    *
  84:    * @return true if verbose class loading output is on.
  85:    */
  86:   boolean isVerbose();
  87: 
  88:   /**
  89:    * Turns on or off the emission of additional information
  90:    * when classes are loaded and unloaded.  The format of the
  91:    * output is left up to the virtual machine.  This method
  92:    * may be called by multiple threads concurrently, but there
  93:    * is only one global setting of verbosity that is affected.
  94:    *
  95:    * @param verbose the new setting for verbose class loading
  96:    *                output.
  97:    * @throws SecurityException if a security manager exists and
  98:    *                           denies ManagementPermission("control").
  99:    */
 100:   void setVerbose(boolean verbose);
 101: 
 102: }