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

## com.JRcServer.commons.io
クラス RandomIO

    java.lang.Object
      com.JRcServer.commons.io.RandomIO

    public class RandomIO

extends java.lang.Object

ランダムなファイルアクセスを制御します.
ランダムなファイルアクセスを制御するオブジェクトです.

導入されたバージョン:
  JRcCommons 1.00
バージョン:
  1.0.0 2004/10/26
作成者:
  masahito suzuki

コンストラクタの概要
`RandomIO()` コンストラクタ.
`RandomIO(java.lang.String fileName, boolean newFlg)` コンストラクタ.

メソッドの概要
`void` | `close()` ファイルをクローズします.
`java.lang.String` | `getFileName()` 現在オープンされているファイル名の取得.
`java.io.InputStream` | `getInputStream(long seek)` 読み込み用オブジェクトを取得.
`java.io.InputStream` | `getInputStream(long seek, long length)` 読み込み用オブジェクトを取得.
`long` | `getLength()` ファイルサイズの取得.
`java.io.OutputStream` | `getOutputStream(long seek)` 書き込み用オブジェクトを取得.
`long` | `getPoint()` 現在ファイルポインタ位置の取得.
`Synchronized` | `getSynchronized()` 同期オブジェクトを取得.
`boolean` | `isOpen()` ファイルオープンチェック.
`void` | `open(java.lang.String fileName, boolean newFlg)` ファイルをオープンします.
`byte[]` | `read()` ファイルの読み込み処理を行います.
`int` | `read(byte[] out)` ファイルの読み込み処理を行います.
`int` | `read(byte[] out, long point)` ファイルの読み込み処理を行います.
`int` | `read(byte[] out, long point, int offset)` ファイルの読み込み処理を行います.
`int` | `read(byte[] out, long point, int offset, int length)` ファイルの読み込み処理を行います.
`byte[]` | `read(int size)` ファイルの読み込み処理を行います.
`byte[]` | `read(long point, int size)` ファイルの読み込み処理を行います.
`void` | `setLength(long length)` ファイルサイズの設定.
`void` | `setPoint(long point)` ファイルポインタ位置の設定.
`void` | `write(byte[] binary)` ファイルの書き込み処理を行います.
`void` | `write(byte[] binary, int offset, int size)` ファイルの書き込み処理を行います.
`void` | `write(byte[] binary, long point)` ファイルの書き込み処理を行います.
`void` | `write(byte[] binary, long point, int offset, int size)` ファイルの書き込み処理を行います.

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

コンストラクタの詳細

### RandomIO

    public RandomIO()

  コンストラクタ.

### RandomIO

    public RandomIO(java.lang.String fileName,
                    boolean newFlg)
             throws FileAccessException,
                    InputException

  コンストラクタ.
  ファイル名を指定してオープンします.

  パラメータ:
    `fileName` - オープン対象のファイル名を指定します.
    ファイルプロトコルは[Local]条件のみ指定可能です.
    `newFlg` - ファイルオープンモードを指定します.
    [true]を指定した場合、ファイルが存在しない場合、新規作成を行い、
    ファイルが存在する場合は、１度削除して新規に作成します.
    [false]を指定した場合、ファイルが存在しない場合、新規作成を行い、
    ファイルが存在する場合は、そのファイルを利用継続してオープンします.
  例外:
    `FileAccessException` - ファイルアクセス例外.
    `InputException` - 入力例外.

メソッドの詳細

### open

    public final void open(java.lang.String fileName,
                           boolean newFlg)
                    throws FileAccessException,
                           InputException

  ファイルをオープンします.
  ファイル名を指定してオープンします.

  パラメータ:
    `fileName` - オープン対象のファイル名を指定します.y
    `newFlg` - ファイルオープンモードを指定します.
    [true]を指定した場合、ファイルが存在しない場合、新規作成を行い、
    ファイルが存在する場合は、１度削除して新規に作成します.
    [false]を指定した場合、ファイルが存在しない場合、新規作成を行い、
    ファイルが存在する場合は、そのファイルを利用継続してオープンします.
  例外:
    `FileAccessException` - ファイルアクセス例外.
    `InputException` - 入力例外.

### close

    public final void close()

  ファイルをクローズします.
  オープンしたファイルをクローズします.

### read

    public final byte[] read()
                      throws InputException,
                             FileAccessException

  ファイルの読み込み処理を行います.
  現在のファイルポイントからファイル内容を取得します.

  戻り値:
    byte[] 読み込まれたバイナリ情報が返されます.
  例外:
    `InputException` - 入力例外.
    `FileAccessException` - ファイルアクセス例外.

### read

    public final byte[] read(int size)
                      throws InputException,
                             FileAccessException

  ファイルの読み込み処理を行います.
  指定ファイルポイントからファイル内容を取得します.

  パラメータ:
    `size` - 読み込み情報サイズを指定します.
  戻り値:
    byte[] 読み込まれたバイナリ情報が返されます.
  例外:
    `InputException` - 入力例外.
    `FileAccessException` - ファイルアクセス例外.

### read

    public final int read(byte[] out)
                   throws InputException,
                          FileAccessException

  ファイルの読み込み処理を行います.
  指定ファイルポイントからファイル内容を取得します.

  パラメータ:
    `out` - 読み込まれた情報が格納されます.
  戻り値:
    int 読み込まれたバイナリ情報数が返されます.
  例外:
    `InputException` - 入力例外.
    `FileAccessException` - ファイルアクセス例外.

### read

    public final byte[] read(long point,
                             int size)
                      throws InputException,
                             FileAccessException

  ファイルの読み込み処理を行います.
  指定ファイルポイントからファイル内容を取得します.

  パラメータ:
    `point` - 読み込みファイルポイントを指定します.
    `size` - 読み込み情報サイズを指定します.
  戻り値:
    byte[] 読み込まれたバイナリ情報が返されます.
  例外:
    `InputException` - 入力例外.
    `FileAccessException` - ファイルアクセス例外.

### read

    public final int read(byte[] out,
                          long point)
                   throws InputException,
                          FileAccessException

  ファイルの読み込み処理を行います.
  指定ファイルポイントからファイル内容を取得します.

  パラメータ:
    `out` - 読み込まれた情報が格納されます.
    `point` - 読み込みファイルポイントを指定します.
  戻り値:
    int 読み込まれたバイナリ情報数が返されます.
  例外:
    `InputException` - 入力例外.
    `FileAccessException` - ファイルアクセス例外.

### read

    public final int read(byte[] out,
                          long point,
                          int offset)
                   throws InputException,
                          FileAccessException

  ファイルの読み込み処理を行います.
  指定ファイルポイントからファイル内容を取得します.

  パラメータ:
    `out` - 読み込まれた情報が格納されます.
    `point` - 読み込みファイルポイントを指定します.
    `offset` - 読み込みオフセット値を設定します.
  戻り値:
    int 読み込まれたバイナリ情報数が返されます.
  例外:
    `InputException` - 入力例外.
    `FileAccessException` - ファイルアクセス例外.

### read

    public final int read(byte[] out,
                          long point,
                          int offset,
                          int length)
                   throws InputException,
                          FileAccessException

  ファイルの読み込み処理を行います.
  指定ファイルポイントからファイル内容を取得します.

  パラメータ:
    `out` - 読み込まれた情報が格納されます.
    `point` - 読み込みファイルポイントを指定します.
    `offset` - 読み込みオフセット値を設定します.
    `length` - 読み込みファイルサイズを設定します.
  戻り値:
    int 読み込まれたバイナリ情報数が返されます.
  例外:
    `InputException` - 入力例外.
    `FileAccessException` - ファイルアクセス例外.

### write

    public final void write(byte[] binary)
                     throws InputException,
                            FileAccessException

  ファイルの書き込み処理を行います.
  指定されたバイナリ情報をファイルに出力します.

  パラメータ:
    `binary` - ファイルに書き込むバイナリ情報を指定します.
  例外:
    `InputException` - 入力例外.
    `FileAccessException` - ファイルアクセス例外.

### write

    public final void write(byte[] binary,
                            int offset,
                            int size)
                     throws InputException,
                            FileAccessException

  ファイルの書き込み処理を行います.
  指定されたバイナリ情報をファイルに出力します.

  パラメータ:
    `binary` - ファイルに書き込むバイナリ情報を指定します.
    `offset` - 書き込み元のバイナリ情報のオフセット値を指定します.
    `size` - 書き込み元のバイナリ情報サイズを指定します.
  例外:
    `InputException` - 入力例外.
    `FileAccessException` - ファイルアクセス例外.

### write

    public final void write(byte[] binary,
                            long point)
                     throws InputException,
                            FileAccessException

  ファイルの書き込み処理を行います.
  指定されたバイナリ情報をファイルに出力します.

  パラメータ:
    `binary` - ファイルに書き込むバイナリ情報を指定します.
    `point` - 書き込みファイルポイントを指定します.
  例外:
    `InputException` - 入力例外.
    `FileAccessException` - ファイルアクセス例外.

### write

    public final void write(byte[] binary,
                            long point,
                            int offset,
                            int size)
                     throws InputException,
                            FileAccessException

  ファイルの書き込み処理を行います.
  指定されたバイナリ情報をファイルに出力します.

  パラメータ:
    `binary` - ファイルに書き込むバイナリ情報を指定します.
    `point` - 書き込みファイルポイントを指定します.
    `offset` - 書き込み元のバイナリ情報のオフセット値を指定します.
    `size` - 書き込み元のバイナリ情報サイズを指定します.
  例外:
    `InputException` - 入力例外.
    `FileAccessException` - ファイルアクセス例外.

### setPoint

    public final void setPoint(long point)
                        throws FileAccessException

  ファイルポインタ位置の設定.
  ファイル書き込みポインタ位置の設定を行います.

  パラメータ:
    `point` - ファイルポインタ位置を設定します.
  例外:
    `FileAccessException` - ファイルアクセス例外.

### setLength

    public final void setLength(long length)
                         throws FileAccessException

  ファイルサイズの設定.
  現在ファイルサイズの設定を行います.

  パラメータ:
    `length` - 現在オープンされているファイルサイズを設定します.
  例外:
    `FileAccessException` - ファイルアクセス例外.

### getPoint

    public final long getPoint()

  現在ファイルポインタ位置の取得.
  現在設定されているファイルポインタ位置を取得します.

  戻り値:
    long 現在のファイルポインタ位置が返されます.

### getLength

    public final long getLength()

  ファイルサイズの取得.
  現在ファイルサイズを取得します.

  戻り値:
    long 現在オープンされているファイルサイズが返されます.

### getFileName

    public final java.lang.String getFileName()

  現在オープンされているファイル名の取得.
  現在オープンされているファイル名を取得します.

  戻り値:
    String オープン対象のファイル名が格納されます.
    ファイルがオープンされていない場合[null]が返されます.

### getInputStream

    public final java.io.InputStream getInputStream(long seek)

  読み込み用オブジェクトを取得.
  読み込み用オブジェクトを取得します.

  パラメータ:
    `seek` - 読み込み開始位置を設定します.
  戻り値:
    InputStream 読み込み用オブジェクトが返されます.

### getInputStream

    public final java.io.InputStream getInputStream(long seek,
                                                    long length)

  読み込み用オブジェクトを取得.
  読み込み用オブジェクトを取得します.

  パラメータ:
    `seek` - 読み込み開始位置を設定します.
    `length` - 読み込み終了長を設定します.
  戻り値:
    InputStream 読み込み用オブジェクトが返されます.

### getOutputStream

    public final java.io.OutputStream getOutputStream(long seek)

  書き込み用オブジェクトを取得.
  書き込み用オブジェクトを取得します.

  パラメータ:
    `seek` - 書き込み開始位置を設定します.
  戻り値:
    OutputStream 書き込み用オブジェクトが返されます.

### getSynchronized

    public final Synchronized getSynchronized()

  同期オブジェクトを取得.
  同期オブジェクトを取得します.

  戻り値:
    Synchronized 同期オブジェクトが返されます.

### isOpen

    public final boolean isOpen()

  ファイルオープンチェック.
  ファイルオープンチェックを行います.

  戻り値:
    boolean ファイルオープンチェックが返されます.
    [true]が返された場合、ファイルはオープン済みです.
    [false]が返された場合、ファイルはオープンされていません.

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