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()

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

オーバーライド:

toString、クラス: Object

戻り値:

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

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 を表さない場合。