パッケージ org.opengion.hayabusa.servlet

## クラス UploadedFile

- java.lang.Object
- - org.opengion.hayabusa.servlet.UploadedFile

- すべての実装されたインタフェース:
    `Comparable<UploadedFile>`

      public final class UploadedFile
      extends Object
      implements Comparable<UploadedFile>

  ファイルをサーバーにアップロードする場合に使用されるファイル管理クラスです。 HTML5 ファイルアップロードの複数選択（multiple）対応 に伴い、一つのクラスとして public化します。
  変更履歴:
    5.7.1.1 (2013/12/13) HTML5 ファイルアップロードの複数選択（multiple）対応, 5.9.25.0 (2017/10/06) クラウドストレージ追加対応
  機能分類
    その他機能
  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

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

    フィールド
    修飾子とタイプ | フィールド | 説明
    --- | --- | ---
    `static int` | `BUFFER_MIDDLE` | バッファの初期容量を通常より多い目に設定します。

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

    コンストラクタ
    コンストラクタ | 説明
    --- | ---
    `UploadedFile​(String uniqKey, String dir, String name, String original, String type)` | アップロードファイルの管理オブジェクトを作成します。

  - ### メソッドの概要

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッド | 説明
    --- | --- | ---
    `int` | `compareTo​(UploadedFile other)` | 自然比較メソッド インタフェース Comparable の 実装に関連して、再定義しています。
    `boolean` | `equals​(Object object)` | このオブジェクトと他のオブジェクトが等しいかどうかを示します。
    `String` | `getContentType()` | コンテントタイプを取得します。
    `String` | `getName()` | ファイルアップロードされた時のname属性を取得します。
    `String` | `getOriginalFileName()` | ファイル名(オリジナル)を取得します。
    `String` | `getUploadFile()` | ファイル名(置き換え後)を取得します。
    `int` | `hashCode()` | オブジェクトのハッシュコード値を返します。
    `String` | `renameTo​(String newName, String prefix, String sufix, String useBackup, String fileURL, javax.servlet.http.HttpSession hsession)` | ファイル名(置き換え後)の置き換えを実行します。
    `String` | `toString()` | オブジェクトの識別子として，詳細な画面情報を返します。

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

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

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

    - #### BUFFER_MIDDLE

          public static final int BUFFER_MIDDLE

      バッファの初期容量を通常より多い目に設定します。 200
      関連項目:
        定数フィールド値

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

    - #### UploadedFile

          UploadedFile​(String uniqKey,
                       String dir,
                       String name,
                       String original,
                       String type)

      アップロードファイルの管理オブジェクトを作成します。
      パラメータ:
        `uniqKey` - ユニークキー(初期アップロードファイル名)
        `dir` - ファイルを保管するフォルダ
        `name` - ファイルアップロードされた時のname属性
        `original` - ファイル名(オリジナル)
        `type` - コンテントタイプ
      変更履歴:
        5.7.1.1 (2013/12/13) HTML5 ファイルアップロードの複数選択（multiple）対応

  - ### メソッドの詳細

    - #### getName

          public String getName()

      ファイルアップロードされた時のname属性を取得します。
      戻り値:
        ファイルアップロードされた時のname属性
      変更履歴:
        5.7.1.1 (2013/12/13) HTML5 ファイルアップロードの複数選択（multiple）対応

    - #### getContentType

          public String getContentType()

      コンテントタイプを取得します。
      戻り値:
        コンテントタイプ

    - #### getUploadFile

          public String getUploadFile()

      ファイル名(置き換え後)を取得します。
      戻り値:
        ファイル名(置き換え後)
      変更履歴:
        5.7.1.2 (2013/12/20) zip 対応で、Fileオブジェクトを返すようにします。, 5.9.25.0 (2017/10/06) FILE型をString型に変更

    - #### renameTo

          public String renameTo​(String newName,
                                 String prefix,
                                 String sufix,
                                 String useBackup,
                                 String fileURL,
                                 javax.servlet.http.HttpSession hsession)

      ファイル名(置き換え後)の置き換えを実行します。 useBackup = true にすると、dir の直下に、"_backup" フォルダを作成します。 バックアップファイル名は、元のファイル名(拡張子含む) ＋ "_" + 現在時刻のlong値 + "." + 元のファイルの拡張子 newName が null の場合は、original のファイル名に、変換します。 6.0.2.4 (2014/10/17) useBackup="rename" で、すでに同名のファイルが存在した場合に、"_001" のような文字列を追加したファイルにリネームします。 Windowsの " - コピー (2)" に近いですが、桁数を抑えるのと、useBackup="true" と異なり、過去の同一ファイル名は そのまま、有効になります。同一ファイルが同一フォルダに存在する場合のみ連番が付与されます。 newName の指定に、フォルダ名を含めることを可能にしました。
      パラメータ:
        `newName` - ファイル名(nullの場合は、オリジナル)
        `prefix` - 接頭辞(nullの場合は、何もつけない)
        `sufix` - 接尾辞(nullの場合は、何もつけない)
        `useBackup` - 置き換え後ファイルの処理方法(true:backupフォルダ/false:しない/rename:重複しない連番)
        `fileURL` - クラウドストレージ用のURL
        `hsession` - セッション
      戻り値:
        最終的に作成されたファイルオブジェクト
      変更履歴:
        5.7.1.1 (2013/12/13) 新規追加, 5.7.2.1 (2014/01/17) FileUtil.renameTo の引数の順番を間違えていた。, 6.0.2.4 (2014/10/17) useBackup 修正、newName に、フォルダ名を含めることが可能, 6.2.0.0 (2015/02/27) FileInfoクラスを使用。 (FileUtil#getExtension(String) の廃止), 5.9.25.0 (2017/10/06) returnをString型に変更。引数にfileURLとsessionを追加

    - #### getOriginalFileName

          public String getOriginalFileName()

      ファイル名(オリジナル)を取得します。
      戻り値:
        ファイル名(オリジナル)

    - #### compareTo

          public int compareTo​(UploadedFile other)

      自然比較メソッド インタフェース Comparable の 実装に関連して、再定義しています。 登録されたシーケンス(画面の表示順)で比較します。 equals メソッドでは、キーの同一性のみに着目して判定しています。 この比較では、(運用上同一キーは発生しませんが)たとえ同一キーが存在した としても、その比較値が同じになることを保証していません。
      定義:
        `compareTo` インタフェース内 `Comparable<UploadedFile>`
      パラメータ:
        `other` - 比較対象のObject
      戻り値:
        このオブジェクトが指定されたオブジェクトより小さい場合は負の整数、等しい場合はゼロ、大きい場合は正の整数
      例外:
        `ClassCastException` - 引数が UploadedFile ではない場合
        `IllegalArgumentException` - 引数が null の場合

    - #### equals

          public boolean equals​(Object object)

      このオブジェクトと他のオブジェクトが等しいかどうかを示します。 画面は、画面IDが等しければ、言語や表示順に関係なく同一とみなされます。 GUIInfo は、ユーザー個別に扱われ、そのグループには、key は唯一で、かつ 同一言語内で扱われるオブジェクトの為、同一とみなします。
      オーバーライド:
        `equals` クラス内 `Object`
      パラメータ:
        `object` - 比較対象の参照オブジェクト
      戻り値:
        引数に指定されたオブジェクトとこのオブジェクトが等しい場合は true、そうでない場合は false

    - #### hashCode

          public int hashCode()

      オブジェクトのハッシュコード値を返します。 このメソッドは、java.util.Hashtable によって提供されるような ハッシュテーブルで使用するために用意されています。 equals( Object ) メソッドをオーバーライトした場合は、hashCode() メソッドも 必ず 記述する必要があります。 この実装では、getKey().hashCode() と同値を返します。
      オーバーライド:
        `hashCode` クラス内 `Object`
      戻り値:
        このオブジェクトのハッシュコード値

    - #### toString

          public String toString()

      オブジェクトの識別子として，詳細な画面情報を返します。
      オーバーライド:
        `toString` クラス内 `Object`
      戻り値:
        詳細な画面情報
      このメソッドは、nullを返しません