001/* MemoryManagerMXBean.java - Interface for a memory manager bean
002   Copyright (C) 2006 Free Software Foundation
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package java.lang.management;
039
040/**
041 * Provides access to information about the memory managers
042 * of the virtual machine.  An instance of this bean for each
043 * memory manager is obtained by calling
044 * {@link ManagementFactory#getMemoryManagerMXBeans()}.
045 *
046 * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
047 * @since 1.5
048 */
049public interface MemoryManagerMXBean
050{
051
052  /**
053   * Returns an array containing the names of the memory pools
054   * this memory manager manages.
055   *
056   * @return an array containing the name of each memory pool
057   *         this manager is responsible for.
058   */
059  String[] getMemoryPoolNames();
060
061  /**
062   * Returns the name of the memory manager.
063   *
064   * @return the memory manager name.
065   */
066  String getName();
067
068  /**
069   * Returns true if this memory manager is still valid.  A memory
070   * manager becomes invalid when it is removed by the virtual machine
071   * and no longer used.
072   *
073   * @return true if this memory manager is valid.
074   */
075  boolean isValid();
076
077}