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

## com.JRcServer.commons.resource
クラス BinFileResource

    java.lang.Object
      com.JRcServer.commons.resource.BinFileResource

すべての実装されたインタフェース:
  BinResource

    public class BinFileResource

extends java.lang.Object
implements BinResource

ファイル領域を利用したバイナリオブジェクト.
ファイル領域を利用したバイナリオブジェクトを生成します.

導入されたバージョン:
  JRcCommons 1.00
バージョン:
  1.00, 2005/04/01
作成者:
  Masahito Suzuki

フィールドの概要

インタフェース com.JRcServer.commons.resource.BinResource から継承されたフィールド
`BIN_RESOURCE_TYPE_CACHE, BIN_RESOURCE_TYPE_FILE, BIN_RESOURCE_TYPE_MEMORY`

コンストラクタの概要
`BinFileResource()` コンストラクタ.
`BinFileResource(boolean mode, java.lang.String name)` コンストラクタ.
`BinFileResource(java.lang.String name)` コンストラクタ.
`BinFileResource(java.lang.String dir, int size)` コンストラクタ.

メソッドの概要
`void` | `clear()` 情報クリア.
`void` | `create(boolean mode, java.lang.String name)` 情報生成.
`void` | `create(java.lang.String name)` 情報生成.
`void` | `create(java.lang.String dir, int size)` 情報生成.
`int` | `get(int no)` 情報取得.
`int` | `getAllSize()` 現在のバイナリ長を取得.
`byte[]` | `getBinary()` バイナリ情報を取得.
`int` | `getBinary(BinResource out)` バイナリ情報を取得.
`int` | `getBinary(BinResource out, int no)` バイナリ情報を取得.
`int` | `getBinary(BinResource out, int no, int off, int len)` バイナリ情報を取得.
`int` | `getBinary(byte[] out)` バイナリ情報を取得.
`int` | `getBinary(byte[] out, int no)` バイナリ情報を取得.
`int` | `getBinary(byte[] out, int no, int off, int len)` バイナリ情報を取得.
`byte[]` | `getBinary(int no)` バイナリ情報を取得.
`byte[]` | `getBinary(int no, int len)` バイナリ情報を取得.
`int` | `getType()` オブジェクトタイプを取得.
`boolean` | `isUse()` オブジェクト有効チェック.
`void` | `reset()` リセット処理.
`void` | `set(int no, int b)` 情報設定.
`int` | `setBinary(int no, BinResource bin)` バイナリ情報設定.
`int` | `setBinary(int no, BinResource bin, int off, int len)` バイナリ情報設定.
`int` | `setBinary(int no, byte[] bin)` バイナリ情報設定.
`int` | `setBinary(int no, byte[] bin, int off, int len)` バイナリ情報設定.
`int` | `size()` 現在の有効バイナリ長を取得.

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

コンストラクタの詳細

### BinFileResource

    public BinFileResource()

  コンストラクタ.

### BinFileResource

    public BinFileResource(java.lang.String dir,
                           int size)
                    throws InputException

  コンストラクタ.
  ディレクトリ名を設定して、バイナリオブジェクトを生成します.
  また、生成されるファイル名はランダムで生成されます.

  パラメータ:
    `dir` - 対象ディレクトリ名を設定します.
    `size` - 生成ファイルサイズを設定します.
  例外:
    `InputException` - 入力例外.

### BinFileResource

    public BinFileResource(java.lang.String name)
                    throws InputException

  コンストラクタ.
  対象ファイル名を設定してバイナリリソースを生成します.

  パラメータ:
    `name` - 対象のファイル名を設定します.
  例外:
    `InputException` - 入力例外.

### BinFileResource

    public BinFileResource(boolean mode,
                           java.lang.String name)
                    throws InputException

  コンストラクタ.
  対象ファイル名を設定してバイナリリソースを生成します.

  パラメータ:
    `mode` - 生成モードを設定します.
    [true]を設定した場合、対象ファイル名を示すファイルが 存在しない場合、新規に作成します.
    [false]を設定した場合、対象ファイル名を示すファイルが 存在しない場合、エラーとします.
    `name` - 対象のファイル名を設定します.
  例外:
    `InputException` - 入力例外.

メソッドの詳細

### create

    public final void create(java.lang.String dir,
                             int size)
                      throws InputException

  情報生成.
  ディレクトリ名を設定して、バイナリオブジェクトを生成します.
  また、生成されるファイル名はランダムで生成されます.

  パラメータ:
    `dir` - 対象ディレクトリ名を設定します.
    `size` - 生成ファイルサイズを設定します.
  例外:
    `InputException` - 入力例外.

### create

    public final void create(java.lang.String name)
                      throws InputException

  情報生成.
  対象ファイル名を設定してバイナリリソースを生成します.

  パラメータ:
    `name` - 対象のファイル名を設定します.
  例外:
    `InputException` - 入力例外.

### create

    public final void create(boolean mode,
                             java.lang.String name)
                      throws InputException

  情報生成.
  対象ファイル名を設定してバイナリリソースを生成します.

  パラメータ:
    `mode` - 生成モードを設定します.
    [true]を設定した場合、対象ファイル名を示すファイルが 存在しない場合、新規に作成します.
    [false]を設定した場合、対象ファイル名を示すファイルが 存在しない場合、エラーとします.
    `name` - 対象のファイル名を設定します.
  例外:
    `InputException` - 入力例外.

### clear

    public final void clear()

  情報クリア.
  バイナリ情報をクリアします.

  定義:
    インタフェース `BinResource` 内の `clear`

### reset

    public final void reset()

  リセット処理.
  有効データ長をリセットします.

  定義:
    インタフェース `BinResource` 内の `reset`

### set

    public final void set(int no,
                          int b)

  情報設定.
  対象条件に情報を設定します.

  定義:
    インタフェース `BinResource` 内の `set`
  パラメータ:
    `no` - 設定対象項番を設定します.
    `b` - 設定対象のバイト情報を設定します.

### setBinary

    public final int setBinary(int no,
                               byte[] bin)
                        throws java.lang.ArrayIndexOutOfBoundsException

  バイナリ情報設定.
  対象のバイナリ情報を設定します.

  定義:
    インタフェース `BinResource` 内の `setBinary`
  パラメータ:
    `no` - 設定開始位置となる項番を設定します.
    `bin` - 設定対象のバイナリ情報を設定します.
  戻り値:
    int 設定されたバイナリ長が返されます.
  例外:
    `java.lang.ArrayIndexOutOfBoundsException` - 不正インデックス例外.

### setBinary

    public final int setBinary(int no,
                               byte[] bin,
                               int off,
                               int len)
                        throws java.lang.ArrayIndexOutOfBoundsException

  バイナリ情報設定.
  対象のバイナリ情報を設定します.

  定義:
    インタフェース `BinResource` 内の `setBinary`
  パラメータ:
    `no` - 設定開始位置となる項番を設定します.
    `bin` - 設定対象のバイナリ情報を設定します.
    `off` - 設定対象のオフセット値を設定します.
    `len` - 設定対象のバイナリ長を設定します.
  戻り値:
    int 設定されたバイナリ長が返されます.
  例外:
    `java.lang.ArrayIndexOutOfBoundsException` - 不正インデックス例外.

### setBinary

    public final int setBinary(int no,
                               BinResource bin)
                        throws java.lang.ArrayIndexOutOfBoundsException

  バイナリ情報設定.
  対象のバイナリ情報を設定します.

  定義:
    インタフェース `BinResource` 内の `setBinary`
  パラメータ:
    `no` - 設定開始位置となる項番を設定します.
    `bin` - 設定対象のバイナリオブジェクトを設定します.
  戻り値:
    int 設定されたバイナリ長が返されます.
  例外:
    `java.lang.ArrayIndexOutOfBoundsException` - 不正インデックス例外.

### setBinary

    public final int setBinary(int no,
                               BinResource bin,
                               int off,
                               int len)
                        throws java.lang.ArrayIndexOutOfBoundsException

  バイナリ情報設定.
  対象のバイナリ情報を設定します.

  定義:
    インタフェース `BinResource` 内の `setBinary`
  パラメータ:
    `no` - 設定開始位置となる項番を設定します.
    `bin` - 設定対象のバイナリオブジェクトを設定します.
    `off` - 設定対象のオフセット値を設定します.
    `len` - 設定対象のバイナリ長を設定します.
  戻り値:
    int 設定されたバイナリ長が返されます.
  例外:
    `java.lang.ArrayIndexOutOfBoundsException` - 不正インデックス例外.

### get

    public final int get(int no)
                  throws java.lang.ArrayIndexOutOfBoundsException

  情報取得.
  対象条件の情報を取得します.

  定義:
    インタフェース `BinResource` 内の `get`
  パラメータ:
    `no` - 取得対象項番を設定します.
  戻り値:
    int 対象のバイナリ情報が返されます.
  例外:
    `java.lang.ArrayIndexOutOfBoundsException` - 不正インデックス例外.

### getBinary

    public final byte[] getBinary()

  バイナリ情報を取得.
  格納されているバイナリ情報を取得します.

  定義:
    インタフェース `BinResource` 内の `getBinary`
  戻り値:
    byte[] 設定されているバイナリ情報が返されます.

### getBinary

    public final byte[] getBinary(int no)
                           throws java.lang.ArrayIndexOutOfBoundsException

  バイナリ情報を取得.
  対象のバイナリ情報を取得します.

  定義:
    インタフェース `BinResource` 内の `getBinary`
  パラメータ:
    `no` - 取得開始位置となる項番を設定します.
  戻り値:
    byte[] 取得されたバイナリ情報が返されます.
  例外:
    `java.lang.ArrayIndexOutOfBoundsException` - 不正インデックス例外.

### getBinary

    public final byte[] getBinary(int no,
                                  int len)
                           throws java.lang.ArrayIndexOutOfBoundsException

  バイナリ情報を取得.
  対象のバイナリ情報を取得します.

  定義:
    インタフェース `BinResource` 内の `getBinary`
  パラメータ:
    `no` - 取得開始位置となる項番を設定します.
    `len` - 取得対象のバイナリ長を設定します.
  戻り値:
    byte[] 取得されたバイナリ情報が返されます.
  例外:
    `java.lang.ArrayIndexOutOfBoundsException` - 不正インデックス例外.

### getBinary

    public final int getBinary(byte[] out)

  バイナリ情報を取得.
  格納されているバイナリ情報を取得します.

  定義:
    インタフェース `BinResource` 内の `getBinary`
  パラメータ:
    `out` - 取得対象のバイナリ情報が返されます.
  戻り値:
    int 取得されたバイナリ長が返されます.

### getBinary

    public final int getBinary(byte[] out,
                               int no)
                        throws java.lang.ArrayIndexOutOfBoundsException

  バイナリ情報を取得.
  対象のバイナリ情報を取得します.

  定義:
    インタフェース `BinResource` 内の `getBinary`
  パラメータ:
    `out` - 取得対象のバイナリ情報が返されます.
    `no` - 取得開始位置となる項番を設定します.
  戻り値:
    int 取得されたバイナリ長が返されます.
  例外:
    `java.lang.ArrayIndexOutOfBoundsException` - 不正インデックス例外.

### getBinary

    public final int getBinary(byte[] out,
                               int no,
                               int off,
                               int len)
                        throws java.lang.ArrayIndexOutOfBoundsException

  バイナリ情報を取得.
  対象のバイナリ情報を取得します.

  定義:
    インタフェース `BinResource` 内の `getBinary`
  パラメータ:
    `out` - 取得対象のバイナリ情報が返されます.
    `no` - 取得開始位置となる項番を設定します.
    `off` - 取得対象のバイナリオフセット値を設定します.
    `len` - 取得対象のバイナリ長を設定します.
  戻り値:
    int 取得されたバイナリ長が返されます.
  例外:
    `java.lang.ArrayIndexOutOfBoundsException` - 不正インデックス例外.

### getBinary

    public final int getBinary(BinResource out)

  バイナリ情報を取得.
  格納されているバイナリ情報を取得します.

  定義:
    インタフェース `BinResource` 内の `getBinary`
  パラメータ:
    `out` - 取得対象のバイナリ情報が返されます.
  戻り値:
    int 取得されたバイナリ長が返されます.

### getBinary

    public final int getBinary(BinResource out,
                               int no)
                        throws java.lang.ArrayIndexOutOfBoundsException

  バイナリ情報を取得.
  対象のバイナリ情報を取得します.

  定義:
    インタフェース `BinResource` 内の `getBinary`
  パラメータ:
    `out` - 取得対象のバイナリ情報が返されます.
    `no` - 取得開始位置となる項番を設定します.
  戻り値:
    int 取得されたバイナリ長が返されます.
  例外:
    `java.lang.ArrayIndexOutOfBoundsException` - 不正インデックス例外.

### getBinary

    public final int getBinary(BinResource out,
                               int no,
                               int off,
                               int len)
                        throws java.lang.ArrayIndexOutOfBoundsException

  バイナリ情報を取得.
  対象のバイナリ情報を取得します.

  定義:
    インタフェース `BinResource` 内の `getBinary`
  パラメータ:
    `out` - 取得対象のバイナリ情報が返されます.
    `no` - 取得開始位置となる項番を設定します.
    `off` - 取得対象のバイナリオフセット値を設定します.
    `len` - 取得対象のバイナリ長を設定します.
  戻り値:
    int 取得されたバイナリ長が返されます.
  例外:
    `java.lang.ArrayIndexOutOfBoundsException` - 不正インデックス例外.

### size

    public final int size()

  現在の有効バイナリ長を取得.
  現在の有効なバイナリ長を取得します.

  定義:
    インタフェース `BinResource` 内の `size`
  戻り値:
    int 現在の有効なバイナリ長が返されます.

### getAllSize

    public final int getAllSize()

  現在のバイナリ長を取得.
  現在のバイナリ長を取得します.

  定義:
    インタフェース `BinResource` 内の `getAllSize`
  戻り値:
    int 現在のバイナリ長が返されます.

### getType

    public final int getType()

  オブジェクトタイプを取得.
  オブジェクトタイプを取得します.

  定義:
    インタフェース `BinResource` 内の `getType`
  戻り値:
    int オブジェクトタイプが返されます.
    [BinResource#BIN_RESOURCE_TYPE_MEMORY]が返された場合、 [com.JRcServer.commons.resource.BinMemoryResource]オブジェクトです.
    [BinResource#BIN_RESOURCE_TYPE_FILE]が返された場合、 [com.JRcServer.commons.resource.BinFileResource]オブジェクトです.
    [BinResource#BIN_RESOURCE_TYPE_CACHE]が返された場合、 [com.JRcServer.commons.resource.BinCacheResource]オブジェクトです.

### isUse

    public final boolean isUse()

  オブジェクト有効チェック.
  オブジェクトが有効であるかチェックします.

  定義:
    インタフェース `BinResource` 内の `isUse`
  戻り値:
    boolean チェック結果が返されます.
    [true]が返された場合有効です.
    [false]が返された場合無効です.

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