org.opengion.fukurou.model

## クラス AbstractFileOperation

- java.lang.Object
- - org.opengion.fukurou.model.AbstractFileOperation

- すべての実装されたインタフェース:
    FileOperation
  直系の既知のサブクラス:
    DefaultFileOperation, FileOperation_AWS, FileOperation_AZURE, FileOperation_IBM, FileOperation_ORACLE, FileOperationInfo

      public abstract class AbstractFileOperation
      extends java.lang.Object
      implements FileOperation

  ファイル操作の抽象クラス 共通の処理等を実装しています。
  変更履歴:

    5.10.8.0 (2019/02/01) 新規作成

  機能分類
    ファイル操作
  導入されたバージョン:
    JDK7.0

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

    フィールド
    修飾子とタイプ | フィールドと説明
    --- | ---
    `protected java.lang.String` | `bucket`
    `protected java.lang.String` | `path`

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

    コンストラクタ
    コンストラクタと説明
    `AbstractFileOperation()` コンストラクタ ローカルサーバ用
    `AbstractFileOperation(java.lang.String buket, java.lang.String inPath)` コンストラクタ クラウドストレージ用

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `canRead()` 読み取り可能フラグ ※クラウドストレージの場合は、 必ずtrueを返します。
    `boolean` | `canWrite()` 書き込み可能フラグ ※クラウドストレージの場合は、 必ずtrueを返します。
    `boolean` | `copy(java.lang.String afPath)` ファイルを指定先に、コピーします。
    `boolean` | `createNewFile()` 新規ファイル作成 既にファイルが存在しない場合のみ、 空のファイルを作成します。
    `boolean` | `delete()` ファイルを削除します。
    `protected java.lang.String` | `drawName(java.lang.String key)` 引数のkeyから名称を抽出します。
    `protected java.lang.String` | `drawParent(java.lang.String key)` キーから親のパスを抽出します。
    `protected java.lang.String` | `editPath(java.lang.String path)` ファイルパスの編集 2018/05/07 ADD パスの先頭が「/」の場合は「/」の除去と、「//」を「/」に置換処理の追加。
    `boolean` | `exists()` 存在する場合は、trueを返します。
    `protected FileOperation[]` | `filter(java.util.List<FileOperationInfo> list, FileOperationFileFilter filter)` フィルター処理を行う
    `java.lang.String` | `getAbsolutePath()` 絶対パスを取得します。
    `FileOperation` | `getCanonicalFile()` カノニカルファイル情報の取得 ※ローカルサーバのみ通常ファイルと、 カノニカルファイルで異なります。
    `java.lang.String` | `getName()` 名称を取得します。
    `java.lang.String` | `getParent()` 親のパスを取得します。
    `FileOperation` | `getParentFile()` 親のディレクトリを返します。
    `java.lang.String` | `getPath()` 設定パスを取得します。
    `boolean` | `isDirectory()` ディレクトリの場合は、trueを返します。
    `boolean` | `isFile()` ファイルの場合は、trueを返します。
    `boolean` | `isHidden()` 隠しファイルフラグ ※クラウドストレージの場合は、 必ずfalseを返します。
    `long` | `lastModified()` 最終更新時刻を取得します。
    `long` | `length()` ファイルサイズを返します
    `FileOperation[]` | `listFiles()` パスのファイルとディレクトリ一覧を取得します。
    `FileOperation[]` | `listFiles(FileOperationFileFilter filter)` パスのファイルとディレクトリ一覧を取得して、 引数でフィルターを行います。
    `boolean` | `mkdir()` ディレクトリを作成します。
    `boolean` | `mkdirs()` ディレクトリを作成します。
    `boolean` | `move(java.lang.String afPath)` ファイルを指定先に、移動します。
    `java.io.InputStream` | `read()` データを読み込み、InputStreamとして、返します。
    `boolean` | `renameTo(FileOperation dest)` 指定のファイル情報のファイル名に変更します。
    `protected java.lang.String` | `replaceFileSeparetor(java.lang.String path)` ファイル区切り文字を変換します。
    `protected java.lang.String` | `rTrim(java.lang.String str, char chr)` 右側の文字が、指定の文字の場合、除去します。
    `protected java.lang.String` | `setDirTail(java.lang.String path)` 後尾に「/」がない場合は、付与します。
    `boolean` | `setLastModified(long time)` 最終更新時刻の更新 最終更新時刻の更新を行います。
    `protected byte[]` | `toByteArray(java.io.InputStream is)` InputStreamをbyte[]に変換。
    `java.lang.String` | `toString()` toStringメソッド パスを返します。
    `void` | `write(java.io.InputStream is)` InputStreamのデータを書き込みます。

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

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

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

    - #### path

          protected final java.lang.String path

    - #### bucket

          protected final java.lang.String bucket

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

    - #### AbstractFileOperation

          public AbstractFileOperation()

      コンストラクタ ローカルサーバ用

    - #### AbstractFileOperation

          public AbstractFileOperation(java.lang.String buket,
                               java.lang.String inPath)

      コンストラクタ クラウドストレージ用
      パラメータ:
        `buket` - バケット
        `inPath` - パス

  - ### メソッドの詳細

    - #### write

          public void write(java.io.InputStream is)
                     throws java.io.IOException

      InputStreamのデータを書き込みます。
      定義:
        `write` インタフェース内 `FileOperation`
      パラメータ:
        `is` - 書き込みデータのInputStream
      例外:
        `java.io.IOException`

    - #### read

          public java.io.InputStream read()
                                   throws java.io.FileNotFoundException

      データを読み込み、InputStreamとして、返します。
      定義:
        `read` インタフェース内 `FileOperation`
      戻り値:
        読み込みデータのInputStream
      例外:
        `java.io.FileNotFoundException`

    - #### delete

          public boolean delete()

      ファイルを削除します。
      定義:
        `delete` インタフェース内 `FileOperation`
      戻り値:
        成否フラグ

    - #### copy

          public boolean copy(java.lang.String afPath)

      ファイルを指定先に、コピーします。
      定義:
        `copy` インタフェース内 `FileOperation`
      パラメータ:
        `afPath` - コピー先
      戻り値:
        成否フラグ

    - #### move

          public boolean move(java.lang.String afPath)

      ファイルを指定先に、移動します。
      定義:
        `move` インタフェース内 `FileOperation`
      パラメータ:
        `afPath` - 移動先
      戻り値:
        成否フラグ

    - #### getPath

          public java.lang.String getPath()

      設定パスを取得します。
      定義:
        `getPath` インタフェース内 `FileOperation`
      戻り値:
        設定パス

    - #### getAbsolutePath

          public java.lang.String getAbsolutePath()

      絶対パスを取得します。
      定義:
        `getAbsolutePath` インタフェース内 `FileOperation`
      戻り値:
        絶対パス

    - #### getName

          public java.lang.String getName()

      名称を取得します。
      定義:
        `getName` インタフェース内 `FileOperation`
      戻り値:
        名称

    - #### getParent

          public java.lang.String getParent()

      親のパスを取得します。
      定義:
        `getParent` インタフェース内 `FileOperation`
      戻り値:
        親のパス

    - #### length

          public long length()

      ファイルサイズを返します
      定義:
        `length` インタフェース内 `FileOperation`
      戻り値:
        ファイルサイズ

    - #### lastModified

          public long lastModified()

      最終更新時刻を取得します。
      定義:
        `lastModified` インタフェース内 `FileOperation`
      戻り値:
        最終更新時刻

    - #### isFile

          public boolean isFile()

      ファイルの場合は、trueを返します。
      定義:
        `isFile` インタフェース内 `FileOperation`
      戻り値:
        ファイルフラグ

    - #### isDirectory

          public boolean isDirectory()

      ディレクトリの場合は、trueを返します。
      定義:
        `isDirectory` インタフェース内 `FileOperation`
      戻り値:
        ディレクトリフラグ

    - #### exists

          public boolean exists()

      存在する場合は、trueを返します。
      定義:
        `exists` インタフェース内 `FileOperation`
      戻り値:
        存在フラグ

    - #### listFiles

          public FileOperation[] listFiles()

      パスのファイルとディレクトリ一覧を取得します。
      定義:
        `listFiles` インタフェース内 `FileOperation`
      戻り値:
        ファイルとティレクトリ一覧

    - #### listFiles

          public FileOperation[] listFiles(FileOperationFileFilter filter)

      パスのファイルとディレクトリ一覧を取得して、 引数でフィルターを行います。
      定義:
        `listFiles` インタフェース内 `FileOperation`
      パラメータ:
        `filter` - フィルター
      戻り値:
        ファイルとディレクトリ一覧

    - #### mkdir

          public boolean mkdir()

      ディレクトリを作成します。 ※１つのディレクトリのみ作成します。 (クラウドストレージにはディレクトリの概念が無いため、 作成は行わず、trueを返します)
      定義:
        `mkdir` インタフェース内 `FileOperation`
      戻り値:
        成否フラグ

    - #### mkdirs

          public boolean mkdirs()

      ディレクトリを作成します。 ※複数のディレクトリを作成します。 (クラウドストレージにはディレクトリの概念が無いため、 作成は行わず、trueを返します)
      定義:
        `mkdirs` インタフェース内 `FileOperation`
      戻り値:
        成否フラグ

    - #### renameTo

          public boolean renameTo(FileOperation dest)

      指定のファイル情報のファイル名に変更します。
      定義:
        `renameTo` インタフェース内 `FileOperation`
      パラメータ:
        `dest` - 変更後のファイル情報
      戻り値:
        成否フラグ

    - #### getParentFile

          public FileOperation getParentFile()

      親のディレクトリを返します。
      定義:
        `getParentFile` インタフェース内 `FileOperation`
      戻り値:
        親のディレクトリ

    - #### canWrite

          public boolean canWrite()

      書き込み可能フラグ ※クラウドストレージの場合は、 必ずtrueを返します。
      定義:
        `canWrite` インタフェース内 `FileOperation`
      戻り値:
        書き込み可能フラグ

    - #### canRead

          public boolean canRead()

      読み取り可能フラグ ※クラウドストレージの場合は、 必ずtrueを返します。
      定義:
        `canRead` インタフェース内 `FileOperation`
      戻り値:
        読み取り可能フラグ

    - #### isHidden

          public boolean isHidden()

      隠しファイルフラグ ※クラウドストレージの場合は、 必ずfalseを返します。
      定義:
        `isHidden` インタフェース内 `FileOperation`
      戻り値:
        隠しファイルフラグ

    - #### createNewFile

          public boolean createNewFile()
                                throws java.io.IOException

      新規ファイル作成 既にファイルが存在しない場合のみ、 空のファイルを作成します。
      定義:
        `createNewFile` インタフェース内 `FileOperation`
      戻り値:
        成否フラグ
      例外:
        `java.io.IOException`

    - #### setLastModified

          public boolean setLastModified(long time)

      最終更新時刻の更新 最終更新時刻の更新を行います。 ※クラウドストレージの場合は、 最終更新時刻の更新を行えません。
      定義:
        `setLastModified` インタフェース内 `FileOperation`
      パラメータ:
        `time` - 更新する最終更新時刻
      戻り値:
        成否フラグ

    - #### getCanonicalFile

          public FileOperation getCanonicalFile()
                                         throws java.io.IOException

      カノニカルファイル情報の取得 ※ローカルサーバのみ通常ファイルと、 カノニカルファイルで異なります。
      定義:
        `getCanonicalFile` インタフェース内 `FileOperation`
      戻り値:
        カノニカルファイル情報
      例外:
        `java.io.IOException`

    - #### toString

          public java.lang.String toString()

      toStringメソッド パスを返します。
      オーバーライド:
        `toString` クラス内 `java.lang.Object`

    - #### editPath

          protected java.lang.String editPath(java.lang.String path)

      ファイルパスの編集 2018/05/07 ADD パスの先頭が「/」の場合は「/」の除去と、「//」を「/」に置換処理の追加。
      パラメータ:
        `path` -
      戻り値:
        変更後パス
      変更履歴:

        5.9.32.1 (2018/05/11)

    - #### drawParent

          protected java.lang.String drawParent(java.lang.String key)

      キーから親のパスを抽出します。
      パラメータ:
        `key` - キー
      戻り値:
        親のパス

    - #### drawName

          protected java.lang.String drawName(java.lang.String key)

      引数のkeyから名称を抽出します。
      パラメータ:
        `key` - キー(パス)
      戻り値:
        名称

    - #### setDirTail

          protected java.lang.String setDirTail(java.lang.String path)

      後尾に「/」がない場合は、付与します。
      パラメータ:
        `path` - パス
      戻り値:
        後尾に「/」ありのパス

    - #### rTrim

          protected java.lang.String rTrim(java.lang.String str,
                               char chr)

      右側の文字が、指定の文字の場合、除去します。
      パラメータ:
        `str` - 対象文字列
        `chr` - 指定文字
      戻り値:
        右側から指定文字を除去後の文字列

    - #### replaceFileSeparetor

          protected java.lang.String replaceFileSeparetor(java.lang.String path)

      ファイル区切り文字を変換します。
      パラメータ:
        `path` - 変換前文字列
      戻り値:
        返還後文字列

    - #### filter

          protected FileOperation[] filter(java.util.List<FileOperationInfo> list,
                               FileOperationFileFilter filter)

      フィルター処理を行う
      パラメータ:
        `list` - フィルタを行うリスト
        `filter` - フィルタ情報
      戻り値:
        フィルタ後のリスト

    - #### toByteArray

          protected byte[] toByteArray(java.io.InputStream is)
                                throws java.io.IOException

      InputStreamをbyte[]に変換。 InputStreamのサイズ計算に利用。
      パラメータ:
        `is` - byte[]変換するInputStream
      戻り値:
        InpusStreamをbyte[]に変換した値
      例外:
        `java.io.IOException`

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.