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

## com.JRcServer.commons.net
クラス TelegramResourceRoll

    java.lang.Object
      com.JRcServer.commons.net.TelegramResourceRoll

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

    public class TelegramResourceRoll

extends java.lang.Object
implements Roll

電文リソースロール.
電文リソース用のロール管理を行うオブジェクトです.

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

コンストラクタの概要
`TelegramResourceRoll(boolean mode, ResourceType resType, int max)` コンストラクタ.
`TelegramResourceRoll(ResourceType resType, int max)` コンストラクタ.

メソッドの概要
`boolean` | `add(BinResource value, java.net.InetAddress addr, int port)` 情報追加.
`boolean` | `add(BinResource value, java.net.InetAddress addr, int port, int resendCnt)` 情報追加.
`boolean` | `add(byte[] value, java.net.InetAddress addr, int port)` 情報追加.
`boolean` | `add(byte[] value, java.net.InetAddress addr, int port, int resendCnt)` 情報追加.
`boolean` | `add(int id, BinResource value, java.net.InetAddress addr, int port)` 情報追加.
`boolean` | `add(int id, BinResource value, java.net.InetAddress addr, int port, int resendCnt)` 情報追加.
`boolean` | `add(int id, byte[] value, java.net.InetAddress addr, int port)` 情報追加.
`boolean` | `add(int id, byte[] value, java.net.InetAddress addr, int port, int resendCnt)` 情報追加.
`boolean` | `addHead(BinResource value, java.net.InetAddress addr, int port)` 情報追加.
`boolean` | `addHead(BinResource value, java.net.InetAddress addr, int port, int resendCnt)` 情報追加.
`boolean` | `addHead(byte[] value, java.net.InetAddress addr, int port)` 情報追加.
`boolean` | `addHead(byte[] value, java.net.InetAddress addr, int port, int resendCnt)` 情報追加.
`boolean` | `addHead(int id, BinResource value, java.net.InetAddress addr, int port)` 情報追加.
`boolean` | `addHead(int id, BinResource value, java.net.InetAddress addr, int port, int resendCnt)` 情報追加.
`boolean` | `addHead(int id, byte[] value, java.net.InetAddress addr, int port)` 情報追加.
`boolean` | `addHead(int id, byte[] value, java.net.InetAddress addr, int port, int resendCnt)` 情報追加.
`void` | `addReservationByOFF()` 追加予約をOFFにセット.
`void` | `addReservationByON()` 追加予約をONにセット.
`void` | `destroy()` オブジェクト破棄.
`boolean` | `get(TelegramValue out)` 情報取得.
`int` | `getMax()` 対象の管理サイズを取得.
`int` | `getSize()` 現在の格納数を取得.
`boolean` | `isAdd()` データが追加できるかチェック.
`boolean` | `isAddReservation()` 追加予約が行われているかチェック.
`boolean` | `isMode()` キャッシュモードを取得.

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

コンストラクタの詳細

### TelegramResourceRoll

    public TelegramResourceRoll(ResourceType resType,
                                int max)
                         throws InputException

  コンストラクタ.
  ロール管理数を設定して生成します.
  また、このコンストラクタで生成されるキャッシュモードは キャッシュ非再作成モードです.

  パラメータ:
    `resType` - 対象のリソースタイプを設定します.
    `max` - ロール管理数を設定します.
    設定値は[255]以下を設定した場合、その値となります.
  例外:
    `InputException` - 入力例外.

### TelegramResourceRoll

    public TelegramResourceRoll(boolean mode,
                                ResourceType resType,
                                int max)
                         throws InputException

  コンストラクタ.
  ロール管理数を設定して生成します.
  また、キャッシュモードの選択が可能です.
  キャッシュモードは、(1)キャッシュ再作成モードと(2)キャッシュ非再作成モードの ２つのモードが存在します.
  これは、渡されるキャッシュサイズに設定するバイナリサイズの上限が一定の場合は、(2)を 利用したほうが効率がよくなります.
  その反対にキャッシュサイズに設定するバイナリサイズの上限が一定では内場合は、(1)を 利用したほうが効率よくなります.
  また設定した値を受け取るオブジェクト(TelegramValue)はキャッシュモードによって 戻り値のオブジェクト型が変わります.
  (1)の場合[TelegramValue.getBinary()]において、戻り値は(BinResource)となります.
  (2)の場合[TelegramValue.getBinary()]において、戻り値は(byte[])となります.
  このため、キャッシュモードを選択する場合は利用条件に合わせて定義してください.

  パラメータ:
    `mode` - キャッシュモードを設定します.
    [true]を設定した場合、キャッシュ再作成モードとします.
    [false]を設定した場合、キャッシュ非再作成モードとします.
    `resType` - 対象のリソースタイプを設定します.
    `max` - ロール管理数を設定します.
    設定値は[32]以下を設定した場合、その値となります.
  例外:
    `InputException` - 入力例外.

メソッドの詳細

### destroy

    public final void destroy()

  オブジェクト破棄.
  オブジェクトを破棄します.

  定義:
    インタフェース `Roll` 内の `destroy`

### addReservationByON

    public final void addReservationByON()

  追加予約をONにセット.
  追加予約をONにセットします.

  定義:
    インタフェース `Roll` 内の `addReservationByON`

### addReservationByOFF

    public final void addReservationByOFF()

  追加予約をOFFにセット.
  追加予約をOFFにセットします.

  定義:
    インタフェース `Roll` 内の `addReservationByOFF`

### add

    public final boolean add(byte[] value,
                             java.net.InetAddress addr,
                             int port)
                      throws InputException

  情報追加.
  対象情報を追加します.
  この処理は最後のロールに情報を追加します.

  パラメータ:
    `value` - 対象の情報を設定します.
    `addr` - 対象のIPアドレスを設定します.
    `port` - 対象のポート番号を設定します.
  戻り値:
    boolean 設定の合否が返されます.
    [true]が返された場合、正しく設定されました.
    [false]が返された場合、空き情報が存在しないことから、 正しく設定できませんでした.
  例外:
    `InputException` - 入力例外.

### add

    public final boolean add(byte[] value,
                             java.net.InetAddress addr,
                             int port,
                             int resendCnt)
                      throws InputException

  情報追加.
  対象情報を追加します.
  この処理は最後のロールに情報を追加します.

  パラメータ:
    `value` - 対象の情報を設定します.
    `addr` - 対象のIPアドレスを設定します.
    `port` - 対象のポート番号を設定します.
    `resendCnt` - 再送カウントを設定します.
  戻り値:
    boolean 設定の合否が返されます.
    [true]が返された場合、正しく設定されました.
    [false]が返された場合、空き情報が存在しないことから、 正しく設定できませんでした.
  例外:
    `InputException` - 入力例外.

### add

    public final boolean add(int id,
                             byte[] value,
                             java.net.InetAddress addr,
                             int port)
                      throws InputException

  情報追加.
  対象情報を追加します.
  この処理は最後のロールに情報を追加します.

  パラメータ:
    `id` - 対象のID情報を設定します.
    `value` - 対象の情報を設定します.
    `addr` - 対象のIPアドレスを設定します.
    `port` - 対象のポート番号を設定します.
  戻り値:
    boolean 設定の合否が返されます.
    [true]が返された場合、正しく設定されました.
    [false]が返された場合、空き情報が存在しないことから、 正しく設定できませんでした.
  例外:
    `InputException` - 入力例外.

### add

    public final boolean add(int id,
                             byte[] value,
                             java.net.InetAddress addr,
                             int port,
                             int resendCnt)
                      throws InputException

  情報追加.
  対象情報を追加します.
  この処理は最後のロールに情報を追加します.

  パラメータ:
    `id` - 対象のID情報を設定します.
    `value` - 対象の情報を設定します.
    `addr` - 対象のIPアドレスを設定します.
    `port` - 対象のポート番号を設定します.
    `resendCnt` - 再送カウントを設定します.
  戻り値:
    boolean 設定の合否が返されます.
    [true]が返された場合、正しく設定されました.
    [false]が返された場合、空き情報が存在しないことから、 正しく設定できませんでした.
  例外:
    `InputException` - 入力例外.

### add

    public final boolean add(BinResource value,
                             java.net.InetAddress addr,
                             int port)
                      throws InputException

  情報追加.
  対象情報を追加します.
  この処理は最後のロールに情報を追加します.
  またこのメソッドはキャッシュモードが、キャッシュ再作成モードでないと 処理できません.

  パラメータ:
    `value` - 対象の情報を設定します.
    `addr` - 対象のIPアドレスを設定します.
    `port` - 対象のポート番号を設定します.
  戻り値:
    boolean 設定の合否が返されます.
    [true]が返された場合、正しく設定されました.
    [false]が返された場合、空き情報が存在しないことから、 正しく設定できませんでした.
  例外:
    `InputException` - 入力例外.

### add

    public final boolean add(BinResource value,
                             java.net.InetAddress addr,
                             int port,
                             int resendCnt)
                      throws InputException

  情報追加.
  対象情報を追加します.
  この処理は最後のロールに情報を追加します.
  またこのメソッドはキャッシュモードが、キャッシュ再作成モードでないと 処理できません.

  パラメータ:
    `value` - 対象の情報を設定します.
    `addr` - 対象のIPアドレスを設定します.
    `port` - 対象のポート番号を設定します.
    `resendCnt` - 再送カウントを設定します.
  戻り値:
    boolean 設定の合否が返されます.
    [true]が返された場合、正しく設定されました.
    [false]が返された場合、空き情報が存在しないことから、 正しく設定できませんでした.
  例外:
    `InputException` - 入力例外.

### add

    public final boolean add(int id,
                             BinResource value,
                             java.net.InetAddress addr,
                             int port)
                      throws InputException

  情報追加.
  対象情報を追加します.
  この処理は最後のロールに情報を追加します.
  またこのメソッドはキャッシュモードが、キャッシュ再作成モードでないと 処理できません.

  パラメータ:
    `id` - 対象のID情報を設定します.
    `value` - 対象の情報を設定します.
    `addr` - 対象のIPアドレスを設定します.
    `port` - 対象のポート番号を設定します.
  戻り値:
    boolean 設定の合否が返されます.
    [true]が返された場合、正しく設定されました.
    [false]が返された場合、空き情報が存在しないことから、 正しく設定できませんでした.
  例外:
    `InputException` - 入力例外.

### add

    public final boolean add(int id,
                             BinResource value,
                             java.net.InetAddress addr,
                             int port,
                             int resendCnt)
                      throws InputException

  情報追加.
  対象情報を追加します.
  この処理は最後のロールに情報を追加します.
  またこのメソッドはキャッシュモードが、キャッシュ再作成モードでないと 処理できません.

  パラメータ:
    `id` - 対象のID情報を設定します.
    `value` - 対象の情報を設定します.
    `addr` - 対象のIPアドレスを設定します.
    `port` - 対象のポート番号を設定します.
    `resendCnt` - 再送カウントを設定します.
  戻り値:
    boolean 設定の合否が返されます.
    [true]が返された場合、正しく設定されました.
    [false]が返された場合、空き情報が存在しないことから、 正しく設定できませんでした.
  例外:
    `InputException` - 入力例外.

### addHead

    public final boolean addHead(byte[] value,
                                 java.net.InetAddress addr,
                                 int port)
                          throws InputException

  情報追加.
  対象情報を追加します.
  この処理は最初のロールに情報を追加します.

  パラメータ:
    `value` - 対象の情報を設定します.
    `addr` - 対象のIPアドレスを設定します.
    `port` - 対象のポート番号を設定します.
  戻り値:
    boolean 設定の合否が返されます.
    [true]が返された場合、正しく設定されました.
    [false]が返された場合、空き情報が存在しないことから、 正しく設定できませんでした.
  例外:
    `InputException` - 入力例外.

### addHead

    public final boolean addHead(byte[] value,
                                 java.net.InetAddress addr,
                                 int port,
                                 int resendCnt)
                          throws InputException

  情報追加.
  対象情報を追加します.
  この処理は最初のロールに情報を追加します.

  パラメータ:
    `value` - 対象の情報を設定します.
    `addr` - 対象のIPアドレスを設定します.
    `port` - 対象のポート番号を設定します.
    `resendCnt` - 再送カウントを設定します.
  戻り値:
    boolean 設定の合否が返されます.
    [true]が返された場合、正しく設定されました.
    [false]が返された場合、空き情報が存在しないことから、 正しく設定できませんでした.
  例外:
    `InputException` - 入力例外.

### addHead

    public final boolean addHead(int id,
                                 byte[] value,
                                 java.net.InetAddress addr,
                                 int port)
                          throws InputException

  情報追加.
  対象情報を追加します.
  この処理は最初のロールに情報を追加します.

  パラメータ:
    `id` - 対象のID情報を設定します.
    `value` - 対象の情報を設定します.
    `addr` - 対象のIPアドレスを設定します.
    `port` - 対象のポート番号を設定します.
  戻り値:
    boolean 設定の合否が返されます.
    [true]が返された場合、正しく設定されました.
    [false]が返された場合、空き情報が存在しないことから、 正しく設定できませんでした.
  例外:
    `InputException` - 入力例外.

### addHead

    public final boolean addHead(int id,
                                 byte[] value,
                                 java.net.InetAddress addr,
                                 int port,
                                 int resendCnt)
                          throws InputException

  情報追加.
  対象情報を追加します.
  この処理は最初のロールに情報を追加します.

  パラメータ:
    `id` - 対象のID情報を設定します.
    `value` - 対象の情報を設定します.
    `addr` - 対象のIPアドレスを設定します.
    `port` - 対象のポート番号を設定します.
    `resendCnt` - 再送カウントを設定します.
  戻り値:
    boolean 設定の合否が返されます.
    [true]が返された場合、正しく設定されました.
    [false]が返された場合、空き情報が存在しないことから、 正しく設定できませんでした.
  例外:
    `InputException` - 入力例外.

### addHead

    public final boolean addHead(BinResource value,
                                 java.net.InetAddress addr,
                                 int port)
                          throws InputException

  情報追加.
  対象情報を追加します.
  この処理は最初のロールに情報を追加します.
  またこのメソッドはキャッシュモードが、キャッシュ再作成モードでないと 処理できません.

  パラメータ:
    `value` - 対象の情報を設定します.
    `addr` - 対象のIPアドレスを設定します.
    `port` - 対象のポート番号を設定します.
  戻り値:
    boolean 設定の合否が返されます.
    [true]が返された場合、正しく設定されました.
    [false]が返された場合、空き情報が存在しないことから、 正しく設定できませんでした.
  例外:
    `InputException` - 入力例外.

### addHead

    public final boolean addHead(BinResource value,
                                 java.net.InetAddress addr,
                                 int port,
                                 int resendCnt)
                          throws InputException

  情報追加.
  対象情報を追加します.
  この処理は最初のロールに情報を追加します.
  またこのメソッドはキャッシュモードが、キャッシュ再作成モードでないと 処理できません.

  パラメータ:
    `value` - 対象の情報を設定します.
    `addr` - 対象のIPアドレスを設定します.
    `port` - 対象のポート番号を設定します.
    `resendCnt` - 再送カウントを設定します.
  戻り値:
    boolean 設定の合否が返されます.
    [true]が返された場合、正しく設定されました.
    [false]が返された場合、空き情報が存在しないことから、 正しく設定できませんでした.
  例外:
    `InputException` - 入力例外.

### addHead

    public final boolean addHead(int id,
                                 BinResource value,
                                 java.net.InetAddress addr,
                                 int port)
                          throws InputException

  情報追加.
  対象情報を追加します.
  この処理は最初のロールに情報を追加します.
  またこのメソッドはキャッシュモードが、キャッシュ再作成モードでないと 処理できません.

  パラメータ:
    `id` - 対象のID情報を設定します.
    `value` - 対象の情報を設定します.
    `addr` - 対象のIPアドレスを設定します.
    `port` - 対象のポート番号を設定します.
  戻り値:
    boolean 設定の合否が返されます.
    [true]が返された場合、正しく設定されました.
    [false]が返された場合、空き情報が存在しないことから、 正しく設定できませんでした.
  例外:
    `InputException` - 入力例外.

### addHead

    public final boolean addHead(int id,
                                 BinResource value,
                                 java.net.InetAddress addr,
                                 int port,
                                 int resendCnt)
                          throws InputException

  情報追加.
  対象情報を追加します.
  この処理は最初のロールに情報を追加します.
  またこのメソッドはキャッシュモードが、キャッシュ再作成モードでないと 処理できません.

  パラメータ:
    `id` - 対象のID情報を設定します.
    `value` - 対象の情報を設定します.
    `addr` - 対象のIPアドレスを設定します.
    `port` - 対象のポート番号を設定します.
    `resendCnt` - 再送カウントを設定します.
  戻り値:
    boolean 設定の合否が返されます.
    [true]が返された場合、正しく設定されました.
    [false]が返された場合、空き情報が存在しないことから、 正しく設定できませんでした.
  例外:
    `InputException` - 入力例外.

### get

    public final boolean get(TelegramValue out)

  情報取得.
  対象の情報を取得します.
  この処理はキャッシュモードによって、受け取られるオブジェクト型が 変わります.
  キャッシュ再作成モード(true)の場合、受け取り先のメソッド[TelegramValue.getBinary()] で受け取る戻り値のオブジェクト型は[BinResource]です.
  キャッシュ非再作成モード(false)の場合は、受け取る戻り値は[byte[]]です.

  パラメータ:
    `out` - 格納先の電文要素オブジェクトを設定します.
  戻り値:
    boolean 取得結果が返されます.
    [true]が返された場合取得されました.
    [false]が返された場合取得されませんでした.

### getMax

    public final int getMax()

  対象の管理サイズを取得.
  対象の管理サイズが返されます.

  定義:
    インタフェース `Roll` 内の `getMax`
  戻り値:
    int 管理サイズが返されます.

### getSize

    public final int getSize()

  現在の格納数を取得.
  現在の格納数を取得します.

  定義:
    インタフェース `Roll` 内の `getSize`
  戻り値:
    int 現在の格納数が返されます.

### isMode

    public final boolean isMode()

  キャッシュモードを取得.
  キャッシュモードを取得します.

  戻り値:
    boolean キャッシュモードを取得します.
    [true]が返された場合はキャッシュ再作成モードです.
    [false]が返された場合はキャッシュ非再作成モードです.

### isAdd

    public final boolean isAdd()

  データが追加できるかチェック.
  データが追加できるかチェックします.

  定義:
    インタフェース `Roll` 内の `isAdd`
  戻り値:
    boolean チェック結果が返されます.
    [true]が返された場合、設定可能です.
    [false]が返された場合、ロールは満杯のため設定はできません.

### isAddReservation

    public final boolean isAddReservation()

  追加予約が行われているかチェック.
  追加予約が行われているかチェックします.

  定義:
    インタフェース `Roll` 内の `isAddReservation`
  戻り値:
    boolean チェック結果が返されます.
    [true]が返された場合、追加予約されています.
    [false]が返された場合追加予約はされていません.

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