java.lang.management
クラス MemoryUsage

java.lang.Object
  java.lang.management.MemoryUsage

public class MemoryUsage
extends Object

MemoryUsage オブジェクトは、メモリ使用量のスナップショットを表します。通常、MemoryUsage クラスのインスタンスは、Java 仮想マシンの個々のメモリプールや Java 仮想マシンのヒープまたはヒープ以外のメモリに関するメモリ使用量情報を総括して取得するのに使用されるメソッドにより成り立っています。

MemoryUsage オブジェクトには、以下の 4 つの値があります。

init	起動中に Java 仮想マシンがオペレーティングシステムから要求するメモリ管理のための初期メモリ量 (バイト単位) を表す。Java 仮想マシンは、オペレーティングシステムから追加のメモリを要求したり、システム時間の経過とともにメモリを解放したりすることもできる。init の値は指定しなくてもかまわない
used	現在使用されているメモリの量 (バイト単位) を表す
committed	Java 仮想マシンが使用できることが保証されているメモリの量 (バイト単位) を表す。コミットされたメモリの量は、時間の経過とともに変化 (増減) する。Java 仮想マシンはシステムに対してメモリを解放できる。committed は init 未満であることも可能。committed は、常に used 以上になる
max	メモリ管理に使用できる最大メモリ量 (バイト単位) を表す。この値は定義しないことも可能。定義する場合、メモリの最大量は時間の経過とともに変化する可能性がある。max が定義された場合、used および committed メモリの量は常に max 以下になる。used <= max が true の場合でも used > committed などのように、used メモリを増やそうとするとメモリの割り当てが失敗する可能性がある (たとえば、システムの仮想メモリが少ない場合)

メモリプールの例を以下に示します。

        +----------------------------------------------+
        +////////////////           |                  +
        +////////////////           |                  +
        +----------------------------------------------+

        |--------|
           init
        |---------------|
               used
        |---------------------------|
                  committed 
        |----------------------------------------------|
                            max 
 

MXBean のマッピング

MemoryUsage は、from メソッドで指定された属性を持つ CompositeData にマッピングされます。

導入されたバージョン:

1.5

コンストラクタの概要

MemoryUsage(long init, long used, long committed, long max)
MemoryUsage オブジェクトを構築します。

メソッドの概要

static MemoryUsage	from(CompositeData cd) 指定された CompositeData によって表される MemoryUsage オブジェクトを返します。
long	getCommitted() Java 仮想マシンが使用するようコミットされたメモリの量 (バイト単位) を返します。
long	getInit() Java 仮想マシンが初期にメモリ管理についてオペレーティングシステムから要求するメモリの量 (バイト単位) を返します。
long	getMax() メモリ管理に使用できる最大メモリ量 (バイト単位) を返します。
long	getUsed() used メモリの量 (バイト単位) を返します。
String	toString() このメモリの使用量の説明的表現を返します。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

MemoryUsage

public MemoryUsage(long init,
                   long used,
                   long committed,
                   long max)

MemoryUsage オブジェクトを構築します。

パラメータ:

init - Java 仮想マシンが割り当てる初期メモリ量 (バイト単位)。定義されていない場合は -1

used - used メモリの量 (バイト単位)

committed - committed メモリの量 (バイト単位)

max - 使用可能な最大メモリ量。定義されていない場合は -1

例外:

IllegalArgumentException - 次の条件が成立する場合:

• init または max が負の値で、-1 ではない
• used または committed が負の値である
• used が committed の値より大きい
• committed が max の値より大きい (max が定義されている場合)

メソッドの詳細

getInit

public long getInit()

Java 仮想マシンが初期にメモリ管理についてオペレーティングシステムから要求するメモリの量 (バイト単位) を返します。初期メモリサイズが未定義の場合、このメソッドは -1 を返します。

戻り値:

メモリの初期サイズ (バイト単位)。未定義の場合は -1

getUsed

public long getUsed()

used メモリの量 (バイト単位) を返します。

戻り値:

used メモリの量 (バイト単位)

getCommitted

public long getCommitted()

Java 仮想マシンが使用するようコミットされたメモリの量 (バイト単位) を返します。このメモリの量は、Java 仮想マシンが使用するよう保証された量です。

戻り値:

committed メモリの量 (バイト単位)

getMax

public long getMax()

メモリ管理に使用できる最大メモリ量 (バイト単位) を返します。最大メモリサイズが未定義の場合、このメソッドは -1 を返します。

このメモリの量が committed メモリの量より大きい場合、このメモリ量はメモリ管理に利用できることが保証されません。used メモリの量がこの最大サイズを超えない場合でも、Java 仮想マシンはメモリの割り当てに失敗する可能性があります。

戻り値:

メモリの最大量 (バイト単位)。未定義の場合は -1

toString

public String toString()

このメモリの使用量の説明的表現を返します。

オーバーライド:

クラス Object 内の toString

戻り値:

このオブジェクトの文字列表現

from

public static MemoryUsage from(CompositeData cd)

指定された CompositeData によって表される MemoryUsage オブジェクトを返します。指定された CompositeData は、次の属性を含む必要があります。

属性名	型
init	java.lang.Long
used	java.lang.Long
committed	java.lang.Long
max	java.lang.Long

パラメータ:

cd - MemoryUsage を表す CompositeData

戻り値:

cd が null でない場合は、cd により表される MemoryUsage オブジェクト。そうでない場合は null

例外:

IllegalArgumentException - cd が、上記の属性を持つ MemoryUsage を表さない場合