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

クラス PtlEmbeddedFiles

java.lang.Object
jp.co.antenna.ptl.PtlEmbeddedFiles
すべての実装されたインタフェース:
AutoCloseable
public class PtlEmbeddedFiles extends Object implements AutoCloseable
添付ファイルのコンテナを表現するクラスです。
※ この添付ファイルコンテナには添付ファイル注釈の添付ファイルは含まれません。

  • コンストラクタの詳細

    • PtlEmbeddedFiles

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

    • PtlEmbeddedFiles

      public PtlEmbeddedFiles(PtlEmbeddedFiles 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 PtlEmbeddedFile get(int index) throws PtlException
      添付ファイルを取得。
      指定した番号の添付ファイルを取得します。
      パラメータ:
      index - Index番号。0が先頭。
      indexが負や添付ファイル数以上の場合は、例外が発生します。
      戻り値:
      添付ファイル。
      例外:
      PtlException - 例外

    • append

      public void append(PtlEmbeddedFile emfile) throws PtlException
      添付ファイルを追加。
      パラメータ:
      emfile - 追加する添付ファイル。
      例外:
      PtlException - 例外

    • remove

      public void remove(int index) throws PtlException
      添付ファイルを削除。

      指定した番号の添付ファイルを削除します。

      パラメータ:
      index - 削除するIndex番号。0が先頭。
      indexが負や添付ファイル数以上の場合は、例外が発生します。
      例外:
      PtlException - 例外

    • removeAll

      public void removeAll() throws PtlException
      添付ファイルの全てを削除。
      例外:
      PtlException - 例外