パッケージ org.opengion.fukurou.fileexec

## クラス BasePath

- java.lang.Object
- - org.opengion.fukurou.fileexec.BasePath

-     public final class BasePath
      extends Object

  システムのベースフォルダ基準で、各種パスを管理するクラスです。

       本システムでは、ベースフォルダを基準として、各種管理フォルダを規定しています。
       それらのパスオブジェクトを管理します。

  各種管理フォルダの規定
  フォルダ | 説明
  --- | ---
  BASE_PATH | 基本となるフォルダパス
  SUB_PATH | ベースパスの下位のサブパス。これがスキャン対象になる。
  WORK_PATH | 中間パス。サブパスのファイルを一旦このワークに移動してから、取込処理を行います
  OK_PATH | 処理が成功した場合のファイルの移動先
  NG_PATH | 処理が失敗した場合のファイルの移

  変更履歴:
    7.0.0.0 (2017/07/07) 新規作成
  バージョン
    7.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK1.8,

- - ### フィールドの概要

    フィールド
    修飾子とタイプ | フィールド | 説明
    --- | --- | ---
    `Path` | `BASE_PATH` | ベースパス
    `static String` | `CR` | システム依存の改行記号(String)。
    `static String` | `DEF_NG_DIR` | BASEフォルダの相対パスの処理済ﾌｫﾙﾀﾞ(異常)の初期値 "bkup_ng"
    `static String` | `DEF_OK_DIR` | BASEフォルダの相対パスの処理済ﾌｫﾙﾀﾞ(正常)の初期値 "bkup_ok"
    `static String` | `DEF_WORK_DIR` | BASEフォルダの相対パスの処理ﾌｫﾙﾀﾞ(WORK)の初期値 "work"
    `Path` | `NG_PATH` | 処理済ﾌｫﾙﾀﾞ(異常)のパス
    `Path` | `OK_PATH` | 処理済ﾌｫﾙﾀﾞ(正常)のパス
    `Path` | `SUB_PATH` | サブパス(実際にｽｷｬﾝを行うﾄｯﾌﾟﾊﾟｽ)
    `Path` | `WORK_PATH` | 処理ﾌｫﾙﾀﾞ(WORK)のパス

  - ### コンストラクタの概要

    コンストラクタ
    コンストラクタ | 説明
    --- | ---
    `BasePath​(String... dirs)` | フォルダを指定して、オブジェクトを作成します。

  - ### メソッドの概要

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッド | 説明
    --- | --- | ---
    `boolean` | `isScanPath​(Path path)` | WORK,OK,NG,LOG をスキャン対象外にするための簡易判定メソッド。

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### フィールドの詳細

    - #### CR

          public static final String CR

      システム依存の改行記号(String)。

    - #### DEF_WORK_DIR

          public static final String DEF_WORK_DIR

      BASEフォルダの相対パスの処理ﾌｫﾙﾀﾞ(WORK)の初期値 "work"
      関連項目:
        定数フィールド値

    - #### DEF_OK_DIR

          public static final String DEF_OK_DIR

      BASEフォルダの相対パスの処理済ﾌｫﾙﾀﾞ(正常)の初期値 "bkup_ok"
      関連項目:
        定数フィールド値

    - #### DEF_NG_DIR

          public static final String DEF_NG_DIR

      BASEフォルダの相対パスの処理済ﾌｫﾙﾀﾞ(異常)の初期値 "bkup_ng"
      関連項目:
        定数フィールド値

    - #### BASE_PATH

          public final Path BASE_PATH

      ベースパス

    - #### SUB_PATH

          public final Path SUB_PATH

      サブパス(実際にｽｷｬﾝを行うﾄｯﾌﾟﾊﾟｽ)

    - #### WORK_PATH

          public final Path WORK_PATH

      処理ﾌｫﾙﾀﾞ(WORK)のパス

    - #### OK_PATH

          public final Path OK_PATH

      処理済ﾌｫﾙﾀﾞ(正常)のパス

    - #### NG_PATH

          public final Path NG_PATH

      処理済ﾌｫﾙﾀﾞ(異常)のパス

  - ### コンストラクタの詳細

    - #### BasePath

          public BasePath​(String... dirs)

      フォルダを指定して、オブジェクトを作成します。 DIR_BASE,DIR_SUB,DIR_WORK,DIR_BKUP_OK,DIR_BKUP_NG の順にセットされます。 指定されていない(null)の場合は、初期設定を使用します。
      パラメータ:
        `dirs` - フォルダ配列
      変更履歴:
        7.2.1.0 (2020/03/13) FileUtil#isAbsolute(String)を利用します。, 7.2.2.0 (2020/03/27) javadoc用のjdk8に対応します。, 7.2.9.4 (2020/11/20) スキャン除外判定は、Path を直接管理します。

  - ### メソッドの詳細

    - #### isScanPath

          public boolean isScanPath​(Path path)

      WORK,OK,NG,LOG をスキャン対象外にするための簡易判定メソッド。 指定のパスが、WORK_PATH,OK_PATH,NG_PATH,LOG_PATH の場合は、false を返します。
      パラメータ:
        `path` - 判定するパス
      戻り値:
        スキャン対象なら、true
      変更履歴:
        7.2.9.4 (2020/11/20) スキャン除外判定は、Path を直接管理します。