SystemUtil (Unnamed - jp.hrtdotnet:hdnlibrary:jar:2.1.2 2.1.2 API)
Date: 2011-05-25

概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## jp.hrtdotnet.java.util
クラス SystemUtil

    java.lang.Object
      jp.hrtdotnet.java.util.SystemUtil

    public class SystemUtil

extends java.lang.Object

主にメモリチェックに関する処理を実装したシステム管理クラスです。 メモリ使用量のチェックを現在、もしくは定期的に行うことが可能で、チェック結果に応じた処理をさせることができます。 またメモリチェックの他、仕様メモリや利用可能メモリを取得することもできます。
基本的に拡張することを考えて作られていませんが、定期的なメモリチェックを させるためにはチェック後の処理部分をオーバーライドして独自の実装をさせる必要があります。

導入されたバージョン:
  2.0
作成者:
  hrtdotnet.jp
  http://www.hrtdotnet.jp/

フィールドの概要
`static int` | `MAXIMIZE_USEDMEMORY_PERCENTAGE` 最大メモリ使用率のチェックを行うステータスコードです。
`static int` | `MAXIMIZE_USEDMEMORY_SIZE` 最大メモリ使用量のチェックを行うステータスコードです。
`protected int` | `maximizeMemoryPercentage` 最大メモリ使用率です。
`protected long` | `maximizeMemorySize` 最大メモリ使用量です。

コンストラクタの概要
`SystemUtil(int status, long maximizeMemorySize, int maximizeMemoryPercentage)` メモリチェック用のオブジェクトを生成します。

メソッドの概要
`boolean` | `check()` 設定情報を元にメモリのチェックをし、その結果を取得します。
`static long` | `getFreeMemory()` JavaVMが現在確保しているメモリ領域のうち利用可能なメモリサイズを取得します。
`static long` | `getMaxMemory()` JavaVMが利用可能なメモリの上限値を取得します。
`static long` | `getTotalMemory()` JavaVMが現在確保しているメモリ領域のサイズを取得します。
`static long` | `getUsedMemory()` JavaVMが現在利用しているメモリサイズを取得します。
`boolean` | `isRunTimer()` タイマーが動作中（開始している）かどうかを判定します。
`protected void` | `runCheckFalse()` タイマーによる定期的なメモリチェックをさせた場合に メモリの上限値が範囲内であればこのメソッドが処理されます。
`protected void` | `runCheckTrue()` タイマーによる定期的なメモリチェックをさせた場合に メモリの上限値が範囲外であればこのメソッドが処理されます。
`protected void` | `setStatus()` チェック項目を設定するためのステータスを指定します。
`void` | `timerCancel()` メモリチェックのタイマーを終了します。
`void` | `timerStart(long period)` メモリチェックのタイマーを開始します。
`boolean` | `usedMemoryPercentageCheck()` メモリの使用率が指定した指定した上限値を超えていないかをチェックします。
`static boolean` | `usedMemoryPercentageCheck(int maximizeMemoryPercentage)` メモリの使用率が指定した指定した上限値を超えていないかをチェックします。
`boolean` | `usedMemorySizeCheck()` メモリの使用量が指定した上限値を超えていないかをチェックします。
`static boolean` | `usedMemorySizeCheck(long maximizeMemorySize)` メモリの使用量が指定した上限値を超えていないかをチェックします。

クラス java.lang.Object から継承されたメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

フィールドの詳細

### MAXIMIZE_USEDMEMORY_SIZE

    public static final int MAXIMIZE_USEDMEMORY_SIZE

  最大メモリ使用量のチェックを行うステータスコードです。

  関連項目:
    定数フィールド値

### MAXIMIZE_USEDMEMORY_PERCENTAGE

    public static final int MAXIMIZE_USEDMEMORY_PERCENTAGE

  最大メモリ使用率のチェックを行うステータスコードです。

  関連項目:
    定数フィールド値

### maximizeMemorySize

    protected long maximizeMemorySize

  最大メモリ使用量です。

### maximizeMemoryPercentage

    protected int maximizeMemoryPercentage

  最大メモリ使用率です。

コンストラクタの詳細

### SystemUtil

    public SystemUtil(int status,
                      long maximizeMemorySize,
                      int maximizeMemoryPercentage)

  メモリチェック用のオブジェクトを生成します。 チェックする項目のステータスコードやメモリの使用量や使用率の上限値を設定し、 チェックをかけることができます。なお設定値はコンストラクタ引数でのみ 設定することができます。
  ステータスコードを各項目のステータスコードの論理和を指定します。 ステータスコードは以下の通りです。
  - MAXIMIZE_USEDMEMORY_SIZE：メモリ使用量の上限値のチェック
  - MAXIMIZE_USEDMEMORY_PERCENTAGE：メモリ使用率の上限値のチェック
  例えばメモリの使用量と使用率の両方をチェックしたい場合は、 statusにMAXIMIZE_USEDMEMORY_SIZEとMAXIMIZE_USEDMEMORY_PERCENTAGEの和を指定します。

  パラメータ:
    `status` - チェックをする項目のステータスコード
    `maximizeMemorySize` - メモリ使用量の上限値
    `maximizeMemoryPercentage` - メモリ使用率の上限値
  導入されたバージョン:
    2.0

メソッドの詳細

### getMaxMemory

    public static long getMaxMemory()

  JavaVMが利用可能なメモリの上限値を取得します。 ただし常にJavaVMが上限値分のメモリ領域を確保しているわけではなく、 実際の値は物理メモリや仮想メモリの空き具合にもよります。

  戻り値:
    メモリを確保し続けることで利用可能なメモリの上限値
  導入されたバージョン:
    2.0

### getFreeMemory

    public static long getFreeMemory()

  JavaVMが現在確保しているメモリ領域のうち利用可能なメモリサイズを取得します。

  戻り値:
    現在利用できるメモリサイズ
  導入されたバージョン:
    2.0

### getTotalMemory

    public static long getTotalMemory()

  JavaVMが現在確保しているメモリ領域のサイズを取得します。

  戻り値:
    現在確保しているメモリサイズ
  導入されたバージョン:
    2.0

### getUsedMemory

    public static long getUsedMemory()

  JavaVMが現在利用しているメモリサイズを取得します。

  戻り値:
    利用しているメモリサイズ
  導入されたバージョン:
    2.0

### check

    public boolean check()

  設定情報を元にメモリのチェックをし、その結果を取得します。

  戻り値:
    メモリチェックで範囲内であればtrue、範囲外であればfalse
  導入されたバージョン:
    2.0

### usedMemorySizeCheck

    public boolean usedMemorySizeCheck()

  メモリの使用量が指定した上限値を超えていないかをチェックします。

  戻り値:
    メモリチェックで範囲内であればtrue、範囲外であればfalse
  導入されたバージョン:
    2.0

### usedMemorySizeCheck

    public static boolean usedMemorySizeCheck(long maximizeMemorySize)

  メモリの使用量が指定した上限値を超えていないかをチェックします。 使用量と上限値が等しい場合は範囲内となります。

  パラメータ:
    `maximizeMemorySize` - メモリ使用量の上限値
  戻り値:
    メモリチェックで範囲内であればtrue、範囲外であればfalse
  導入されたバージョン:
    2.0

### usedMemoryPercentageCheck

    public boolean usedMemoryPercentageCheck()

  メモリの使用率が指定した指定した上限値を超えていないかをチェックします。

  戻り値:
    メモリチェックで範囲内であればtrue、範囲外であればfalse
  導入されたバージョン:
    2.0

### usedMemoryPercentageCheck

    public static boolean usedMemoryPercentageCheck(int maximizeMemoryPercentage)

  メモリの使用率が指定した指定した上限値を超えていないかをチェックします。

  パラメータ:
    `maximizeMemoryPercentage` - チェックするメモリ使用率の上限値
  戻り値:
    メモリチェックで範囲内であればtrue、範囲外であればfalse
  導入されたバージョン:
    2.0

### timerStart

    public void timerStart(long period)

  メモリチェックのタイマーを開始します。 ただし同一オブジェクトのタイマーがすでに開始している場合はIllegalStateExceptionを返します。 またメモリチェックする間隔が0ミリ秒以下の場合はIllegalArgumentExceptionを返します。

  パラメータ:
    `period` - チェックするタイマーの間隔（ミリ秒数）
  例外:
    `java.lang.IllegalArgumentException` - タイマーの間隔が 0 以下 (<= 0) の場合
    `java.lang.IllegalStateException` - タイマーがすでに開始している場合
  導入されたバージョン:
    2.0

### timerCancel

    public void timerCancel()

  メモリチェックのタイマーを終了します。 ただし同一オブジェクトのタイマーが開始していない場合はIllegalStateExceptionを返します。

  例外:
    `java.lang.IllegalStateException` - タイマーが開始していない場合
  導入されたバージョン:
    2.0

### isRunTimer

    public boolean isRunTimer()

  タイマーが動作中（開始している）かどうかを判定します。

  戻り値:
    動作中であればtrue、開始していなければfalse
  導入されたバージョン:
    2.0

### setStatus

    protected void setStatus()

  チェック項目を設定するためのステータスを指定します。

  導入されたバージョン:
    2.0

### runCheckFalse

    protected void runCheckFalse()

  タイマーによる定期的なメモリチェックをさせた場合に メモリの上限値が範囲内であればこのメソッドが処理されます。
  利用者で特定の処理をさせる場合はこのメソッドをオーバーライドする必要があります。

  導入されたバージョン:
    2.0

### runCheckTrue

    protected void runCheckTrue()

  タイマーによる定期的なメモリチェックをさせた場合に メモリの上限値が範囲外であればこのメソッドが処理されます。
  利用者で特定の処理をさせる場合はこのメソッドをオーバーライドする必要があります。

  導入されたバージョン:
    2.0

概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

Copyright © 2011. All Rights Reserved.