BufferPoolMXBean.java

/*[INCLUDE-IF JAVA_SPEC_VERSION >= 8]*/
/*
 *******************************************************************************
 * Copyright (c) 2011, 2022 IBM Corp. and others
 *
 * This program and the accompanying materials are made available under
 * the terms of the Eclipse Public License 2.0 which accompanies this
 * distribution and is available at https://www.eclipse.org/legal/epl-2.0/
 * or the Apache License, Version 2.0 which accompanies this distribution and
 * is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * This Source Code may also be made available under the following
 * Secondary Licenses when the conditions for such availability set
 * forth in the Eclipse Public License, v. 2.0 are satisfied: GNU
 * General Public License, version 2 with the GNU Classpath
 * Exception [1] and GNU General Public License, version 2 with the
 * OpenJDK Assembly Exception [2].
 *
 * [1] https://www.gnu.org/software/classpath/license.html
 * [2] http://openjdk.java.net/legal/assembly-exception.html
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 OR LicenseRef-GPL-2.0 WITH Assembly-exception
 *******************************************************************************/
package java.lang.management;

/**
 * The interface for the management buffer pool.
 */
public interface BufferPoolMXBean extends PlatformManagedObject {

	/**
	 * Returns the name of the buffer pool.
	 * 
	 * @return the name of the buffer pool.
	 */
	String getName();

	/**
	 * Returns the number of buffers of the pool.
	 * 
	 * @return the number of buffers of the pool.
	 */
	long getCount();

	/**
	 * Returns the total capacity of the buffers in this pool.
	 * 
	 * @return the total capacity of the buffers in this pool.
	 */
	long getTotalCapacity();

	/**
	 * Returns the count of used memory.
	 * 
	 * @return the count of used memory.
	 */
	long getMemoryUsed();

}