パッケージ jp.co.antenna.ptl

クラス PtlCustomProperties

java.lang.Object
jp.co.antenna.ptl.PtlCustomProperties
すべての実装されたインタフェース:
AutoCloseable
public class PtlCustomProperties extends Object implements AutoCloseable
カスタムプロパティのコンテナを表現するクラスです。

  • コンストラクタの詳細

    • PtlCustomProperties

      public PtlCustomProperties() throws PtlException
      コンストラクタ
      例外:
      PtlException - 例外

    • PtlCustomProperties

      public PtlCustomProperties(PtlCustomProperties obj) throws PtlException
      コピーコンストラクタ
      alias copy
      パラメータ:
      obj - コピー元オブジェクト。
      例外:
      PtlException - 例外

  • メソッドの詳細

    • close

      public void close()
      終了処理。

      このオブジェクトが抱えているネイティブ側にあるリソースなどを廃棄して終了処理を行ないます。
      このオブジェクトを使い終わったら必ず呼ばなければなりません。

      定義:
      close インタフェース内 AutoCloseable

    • isEmpty

      public boolean isEmpty() throws PtlException
      空かどうか。
      戻り値:
      true: 空、false: 空ではない。
      例外:
      PtlException - 例外

    • getCount

      public int getCount() throws PtlException
      カスタムプロパティ数を取得。
      戻り値:
      カスタムプロパティ数。
      例外:
      PtlException - 例外

    • get

      public PtlCustomProperty get(int index) throws PtlException
      カスタムプロパティを取得。

      指定した番号のカスタムプロパティを取得します。

      パラメータ:
      index - Index番号。0が先頭。
      indexが負やカスタムプロパティ数以上の場合は、例外が発生します。
      戻り値:
      カスタムプロパティ。
      例外:
      PtlException - 例外

    • append

      public void append(PtlCustomProperty custProp) throws PtlException
      カスタムプロパティを追加。
      パラメータ:
      custProp - 追加するカスタムプロパティ。
      例外:
      PtlException - 例外

    • remove

      public void remove(int index) throws PtlException
      カスタムプロパティを削除。

      指定した番号のカスタムプロパティを削除します。

      パラメータ:
      index - 削除するIndex番号。0が先頭。
      indexが負やカスタムプロパティ数以上の場合は、例外が発生します。
      例外:
      PtlException - 例外

    • removeAll

      public void removeAll() throws PtlException
      カスタムプロパティを全て削除。
      例外:
      PtlException - 例外