org.opengion.fukurou.model

## クラス DefaultFileOperation

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

- すべての実装されたインタフェース:
    FileOperation

      public class DefaultFileOperation
      extends AbstractFileOperation

  ローカルサーバのファイル操作クラス FileOperationFactoryでデフォルトとして設定されており、 ローカルサーバでのファイル操作を行います。 ※java.io.Fileと同等のファイル操作になります。
  変更履歴:

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

  機能分類
    ファイル操作
  作成者
    oota

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

    - ### クラスから継承されたフィールド org.opengion.fukurou.model.AbstractFileOperation

      `bucket, path`

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

    コンストラクタ
    コンストラクタと説明
    `DefaultFileOperation(java.lang.String inPath)` コンストラクタ 引数のパスから、java.io.Fileインスタンスを生成します。
    `DefaultFileOperation(java.lang.String buket, java.lang.String inPath)` コンストラクタ 引数のパスから、java.io.Fileインスタンスを生成します。

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `canRead()` 読み取り可能フラグ ※クラウドストレージの場合は、 必ずtrueを返します。
    `boolean` | `canWrite()` 書き込み可能フラグ ※クラウドストレージの場合は、 必ずtrueを返します。
    `boolean` | `copy(java.lang.String afPath)` ファイルを指定先に、コピーします。
    `boolean` | `createNewFile()` 新規ファイル作成 既にファイルが存在しない場合のみ、 空のファイルを作成します。
    `boolean` | `delete()` ファイルを削除します。
    `boolean` | `exists()` 存在する場合は、trueを返します。
    `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)` パスのファイルとディレクトリ一覧を取得して、 引数でフィルターを行います。
    `static void` | `main(java.lang.String[] args)` テスト用メソッドです
    `boolean` | `mkdir()` ディレクトリを作成します。
    `boolean` | `mkdirs()` ディレクトリを作成します。
    `boolean` | `move(java.lang.String afPath)` ファイルを指定先に、移動します。
    `java.io.InputStream` | `read()` データを読み込み、InputStreamとして、返します。
    `boolean` | `renameTo(FileOperation dest)` 指定のファイル情報のファイル名に変更します。
    `boolean` | `setLastModified(long time)` 最終更新時刻の更新 最終更新時刻の更新を行います。
    `java.lang.String` | `toString()` toStringでは、パスを返します。
    `void` | `write(java.io.InputStream is)` InputStreamのデータを書き込みます。

    - ### クラスから継承されたメソッド org.opengion.fukurou.model.AbstractFileOperation

      `drawName, drawParent, editPath, filter, replaceFileSeparetor, rTrim, setDirTail, toByteArray`

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

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

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

    - #### DefaultFileOperation

          public DefaultFileOperation(java.lang.String inPath)

      コンストラクタ 引数のパスから、java.io.Fileインスタンスを生成します。
      パラメータ:
        `inPath` - ファイルパス

    - #### DefaultFileOperation

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

      コンストラクタ 引数のパスから、java.io.Fileインスタンスを生成します。 FileOperationFactoryからの呼び出し用で、 このクラスではbuketは使用しません。
      パラメータ:
        `buket` - バケット
        `inPath` - ファイルパス

  - ### メソッドの詳細

    - #### write

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

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

    - #### read

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

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

    - #### delete

          public boolean delete()

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

    - #### copy

          public boolean copy(java.lang.String afPath)

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

    - #### move

          public boolean move(java.lang.String afPath)

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

    - #### getPath

          public java.lang.String getPath()

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

    - #### getAbsolutePath

          public java.lang.String getAbsolutePath()

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

    - #### getName

          public java.lang.String getName()

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

    - #### getParent

          public java.lang.String getParent()

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

    - #### length

          public long length()

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

    - #### lastModified

          public long lastModified()

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

    - #### isFile

          public boolean isFile()

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

    - #### isDirectory

          public boolean isDirectory()

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

    - #### exists

          public boolean exists()

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

    - #### listFiles

          public FileOperation[] listFiles()

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

    - #### listFiles

          public FileOperation[] listFiles(FileOperationFileFilter filter)

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

    - #### mkdir

          public boolean mkdir()

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

    - #### mkdirs

          public boolean mkdirs()

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

    - #### renameTo

          public boolean renameTo(FileOperation dest)

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

    - #### getParentFile

          public FileOperation getParentFile()

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

    - #### canWrite

          public boolean canWrite()

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

    - #### canRead

          public boolean canRead()

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

    - #### isHidden

          public boolean isHidden()

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

    - #### createNewFile

          public boolean createNewFile()
                                throws java.io.IOException

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

    - #### setLastModified

          public boolean setLastModified(long time)

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

    - #### getCanonicalFile

          public FileOperation getCanonicalFile()
                                         throws java.io.IOException

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

    - #### toString

          public java.lang.String toString()

      toStringでは、パスを返します。
      オーバーライド:
        `toString` クラス内 `AbstractFileOperation`
      戻り値:
        パス

    - #### main

          public static void main(java.lang.String[] args)

      テスト用メソッドです
      パラメータ:
        `args` -

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