org.opengion.fukurou.model

## クラス FileOperation

- java.lang.Object
- - java.io.File
  - - org.opengion.fukurou.model.FileOperation

- すべての実装されたインタフェース:
    java.io.Serializable, java.lang.Comparable
  直系の既知のサブクラス:
    CloudFileOperation

      public class FileOperation
      extends java.io.File

       ファイル操作のインタフェース

       ローカルサーバ、クラウドストレージ(AWS,AZURE,BLUEMIX,ORACLE)のファイル操作用です。
       FileOperationFactoryを通して、インスタンスを生成可能です。
       Fileクラスを継承しているため、通常のFileとしても扱えます。

  関連項目:
    直列化された形式
  機能分類
    ファイル操作
  変更履歴:
    5.10.8.0 (2019/02/01) 新規作成, 5.10.9.0 (2019/03/01) 変更対応
  作成者
    oota
  導入されたバージョン:
    JDK7.0

- - ### フィールドのサマリー

    - ### クラスから継承されたフィールド java.io.File

      `pathSeparator, pathSeparatorChar, separator, separatorChar`

  - ### コンストラクタのサマリー

    コンストラクタ
    コンストラクタと説明
    `FileOperation(java.lang.String path)` コンストラクタ 初期化処理。
    `FileOperation(java.lang.String bucket, java.lang.String path)` コンストラクタ FileOperationクラスでは、buketは使用しません。

  - ### メソッドのサマリー

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `copy(java.lang.String afPath)` コピー処理 ファイルを指定先にコピーします。
    `java.lang.String` | `getBucket()` バケット名取得。
    `FileOperation` | `getCanonicalFile()` カノニカルファイル取得。
    `java.lang.String` | `getPlugin()` プラグイン名取得。
    `boolean` | `isLocal()` 保存先のローカル判定。
    `boolean` | `move(java.lang.String afPath)` ファイル移動 ファイルを指定先に移動します。
    `java.io.InputStream` | `read()` 読み込み処理 データを読み込み、InputStreamとして、返します。
    `protected void` | `setPlugin(java.lang.String plugin)` プラグイン名のセット。
    `void` | `write(java.io.InputStream is)` 書き込み処理 InputStreamのデータを書き込みます。

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

      `canExecute, canRead, canWrite, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, exists, getAbsoluteFile, getAbsolutePath, getCanonicalPath, getFreeSpace, getName, getParent, getParentFile, getPath, getTotalSpace, getUsableSpace, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, length, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, setExecutable, setExecutable, setLastModified, setReadable, setReadable, setReadOnly, setWritable, setWritable, toPath, toString, toURI, toURL`

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

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

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

    - #### FileOperation

          public FileOperation(java.lang.String path)

      コンストラクタ 初期化処理。
      パラメータ:
        `path` - ファイルパス

    - #### FileOperation

          public FileOperation(java.lang.String bucket,
                               java.lang.String path)

      コンストラクタ FileOperationクラスでは、buketは使用しません。
      パラメータ:
        `bucket` - バケット名
        `path` - ファイルパス

  - ### メソッドの詳細

    - #### write

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

      書き込み処理 InputStreamのデータを書き込みます。
      パラメータ:
        `is` - 書き込みデータのInputStream
      例外:
        `java.io.IOException` - ファイル関連エラー情報

    - #### read

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

      読み込み処理 データを読み込み、InputStreamとして、返します。
      戻り値:
        読み込みデータのInputStream
      例外:
        `java.io.FileNotFoundException` - ファイル非存在エラー情報

    - #### copy

          public boolean copy(java.lang.String afPath)

      コピー処理 ファイルを指定先にコピーします。
      パラメータ:
        `afPath` - コピー先
      戻り値:
        成否フラグ

    - #### move

          public boolean move(java.lang.String afPath)

      ファイル移動 ファイルを指定先に移動します。
      パラメータ:
        `afPath` - 移動先
      戻り値:
        成否フラグ

    - #### isLocal

          public boolean isLocal()

      保存先のローカル判定。 判定結果を返します。 trueの場合は、ローカル保存。 falseの場合は、クラウドストレージに保存です。
      戻り値:
        ローカルフラグ

    - #### getCanonicalFile

          public FileOperation getCanonicalFile()
                                         throws java.io.IOException

      カノニカルファイル取得。 カノニカルファイル情報を取得します。
      オーバーライド:
        `getCanonicalFile` クラス内 `java.io.File`
      戻り値:
        カノニカルファイル情報
      例外:
        `java.io.IOException` - ファイル関連エラー情報

    - #### getBucket

          public java.lang.String getBucket()

      バケット名取得。 バケット名を取得します。
      戻り値:
        バケット名

    - #### getPlugin

          public java.lang.String getPlugin()

      プラグイン名取得。 プラグイン名を取得します。
      戻り値:
        プラグイン名

    - #### setPlugin

          protected void setPlugin(java.lang.String plugin)

      プラグイン名のセット。 プラグイン名をセットします。
      パラメータ:
        `plugin` - プラグイン名

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