< prev index next >

src/java.management/share/classes/java/lang/management/MemoryUsage.java

Print this page


   1 /*
   2  * Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  85  * </table>
  86  *
  87  * Below is a picture showing an example of a memory pool:
  88  *
  89  * <pre>
  90  *        +----------------------------------------------+
  91  *        +////////////////           |                  +
  92  *        +////////////////           |                  +
  93  *        +----------------------------------------------+
  94  *
  95  *        |--------|
  96  *           init
  97  *        |---------------|
  98  *               used
  99  *        |---------------------------|
 100  *                  committed
 101  *        |----------------------------------------------|
 102  *                            max
 103  * </pre>
 104  *
 105  * <h2>MXBean Mapping</h2>
 106  * {@code MemoryUsage} is mapped to a {@link CompositeData CompositeData}
 107  * with attributes as specified in the {@link #from from} method.
 108  *
 109  * @author   Mandy Chung
 110  * @since   1.5
 111  */
 112 public class MemoryUsage {
 113     private final long init;
 114     private final long used;
 115     private final long committed;
 116     private final long max;
 117 
 118     /**
 119      * Constructs a {@code MemoryUsage} object.
 120      *
 121      * @param init      the initial amount of memory in bytes that
 122      *                  the Java virtual machine allocates;
 123      *                  or {@code -1} if undefined.
 124      * @param used      the amount of used memory in bytes.
 125      * @param committed the amount of committed memory in bytes.


   1 /*
   2  * Copyright (c) 2003, 2017, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  85  * </table>
  86  *
  87  * Below is a picture showing an example of a memory pool:
  88  *
  89  * <pre>
  90  *        +----------------------------------------------+
  91  *        +////////////////           |                  +
  92  *        +////////////////           |                  +
  93  *        +----------------------------------------------+
  94  *
  95  *        |--------|
  96  *           init
  97  *        |---------------|
  98  *               used
  99  *        |---------------------------|
 100  *                  committed
 101  *        |----------------------------------------------|
 102  *                            max
 103  * </pre>
 104  *
 105  * <h3>MXBean Mapping</h3>
 106  * {@code MemoryUsage} is mapped to a {@link CompositeData CompositeData}
 107  * with attributes as specified in the {@link #from from} method.
 108  *
 109  * @author   Mandy Chung
 110  * @since   1.5
 111  */
 112 public class MemoryUsage {
 113     private final long init;
 114     private final long used;
 115     private final long committed;
 116     private final long max;
 117 
 118     /**
 119      * Constructs a {@code MemoryUsage} object.
 120      *
 121      * @param init      the initial amount of memory in bytes that
 122      *                  the Java virtual machine allocates;
 123      *                  or {@code -1} if undefined.
 124      * @param used      the amount of used memory in bytes.
 125      * @param committed the amount of committed memory in bytes.


< prev index next >