Source for java.lang.management.MemoryManagerMXBean

   1: /* MemoryManagerMXBean.java - Interface for a memory manager 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 memory managers
  42:  * of the virtual machine.  An instance of this bean for each
  43:  * memory manager is obtained by calling
  44:  * {@link ManagementFactory#getMemoryManagerMXBeans()}.
  45:  *
  46:  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  47:  * @since 1.5
  48:  */
  49: public interface MemoryManagerMXBean
  50: {
  51: 
  52:   /** 
  53:    * Returns an array containing the names of the memory pools
  54:    * this memory manager manages.
  55:    * 
  56:    * @return an array containing the name of each memory pool
  57:    *         this manager is responsible for.
  58:    */
  59:   String[] getMemoryPoolNames();
  60: 
  61:   /**
  62:    * Returns the name of the memory manager.
  63:    *
  64:    * @return the memory manager name.
  65:    */
  66:   String getName();
  67: 
  68:   /**
  69:    * Returns true if this memory manager is still valid.  A memory
  70:    * manager becomes invalid when it is removed by the virtual machine
  71:    * and no longer used.
  72:    *
  73:    * @return true if this memory manager is valid.
  74:    */
  75:   boolean isValid();
  76: 
  77: }