HFile (Unnamed - jp.hrtdotnet:hdnlibrary:jar:2.1.2 2.1.2 API)
Date: 2011-05-25

概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## jp.hrtdotnet.java.io
クラス HFile

    java.lang.Object
      java.io.File
          jp.hrtdotnet.java.io.HFile

すべての実装されたインタフェース:
  java.io.Serializable, java.lang.Comparable

    public class HFile

extends java.io.File

ファイルの操作をするクラスです。 このクラスを利用してディレクトリを操作することは禁止されています。

導入されたバージョン:
  2.0
作成者:
  hrtdotnet.jp
  http://www.hrtdotnet.jp/
関連項目:
  直列化された形式

フィールドの概要

クラス java.io.File から継承されたフィールド
`pathSeparator, pathSeparatorChar, separator, separatorChar`

コンストラクタの概要
`HFile(java.lang.String filePath)` コンストラクタ。
`HFile(java.lang.String parent, java.lang.String child)` コンストラクタ。

メソッドの概要
`static boolean` | `checkFileName(java.lang.String fileName)` ファイル名が不正でない形式かどうかチェックをします。
`void` | `copy(java.io.File out)` オブジェクトに関連しているファイルをコピー元としてコピーします。
`static void` | `copy(java.io.File in, java.io.File out)` ファイルをコピーします。
`static void` | `copy(java.io.File in, java.io.File out, boolean overwrite)` ファイルをコピーします。
`static void` | `copy(java.io.InputStream in, java.io.OutputStream out)` 入力ストリームを出力ストリームに出力します。
`void` | `copy(java.io.OutputStream out)` オブジェクトに関連しているファイルをストリームに出力します。
`java.lang.String` | `getExtension()` オブジェクトに関連したファイルの拡張子を取得します。
`static java.lang.String` | `getExtension(java.lang.String fileName)` ファイル名から拡張子を抽出します。
`java.lang.String` | `getOtherFileName(java.lang.String alias)` ファイルオブジェクトと同じパスのファイルが存在する場合、 「ファイル名」+「エイリアス」+「シーケンス番号」+「拡張子」の文字列を取得します。
`java.lang.String` | `getOtherFileName(java.lang.String alias, int digit)` ファイルオブジェクトと同じパスのファイルが存在する場合、 「ファイルパス」+「エイリアス」+「指定桁数分のシーケンス番号 」+「拡張子」の文字列を取得します。
`boolean` | `mkdir()` 推奨されていません。 このメソッドは利用してはなりません。
`boolean` | `mkdirs()` 推奨されていません。 このメソッドは利用してはなりません。
`boolean` | `renameExtension(java.lang.String newExtension)` ファイルオブジェクトとそのファイルの拡張子を指定した拡張子に変換します。

クラス java.io.File から継承されたメソッド
`canExecute, canRead, canWrite, compareTo, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, exists, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getCanonicalPath, getFreeSpace, getName, getParent, getParentFile, getPath, getTotalSpace, getUsableSpace, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, length, list, list, listFiles, listFiles, listFiles, listRoots, renameTo, setExecutable, setExecutable, setLastModified, setReadable, setReadable, setReadOnly, setWritable, setWritable, toString, toURI, toURL`

クラス java.lang.Object から継承されたメソッド
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

コンストラクタの詳細

### HFile

    public HFile(java.lang.String filePath)
          throws java.io.IOException

  コンストラクタ。

  パラメータ:
    `filePath` - ファイルパス
  例外:
    `java.io.IOException` - filePathが不正な場合
  導入されたバージョン:
    2.0

### HFile

    public HFile(java.lang.String parent,
                 java.lang.String child)
          throws java.io.IOException

  コンストラクタ。

  パラメータ:
    `parent` - ディレクトリパス
    `child` - ファイル名
  例外:
    `java.io.IOException` - 指定したファイルが不正な場合
  導入されたバージョン:
    2.0

メソッドの詳細

### getExtension

    public java.lang.String getExtension()

  オブジェクトに関連したファイルの拡張子を取得します。 拡張子がないファイルに関しては空文字を取得します。

  戻り値:
    拡張子
  導入されたバージョン:
    2.0

### getOtherFileName

    public java.lang.String getOtherFileName(java.lang.String alias,
                                             int digit)

  ファイルオブジェクトと同じパスのファイルが存在する場合、 「ファイルパス」+「エイリアス」+「指定桁数分のシーケンス番号 」+「拡張子」の文字列を取得します。 同名のファイルが存在しない場合はファイルオブジェクトのファイルパスを取得します。
  なおオブジェクト自身のファイルパスを変更するわけではありません。

  パラメータ:
    `alias` - エイリアス
    `digit` - シーケンス番号分の桁数
  戻り値:
    「ファイル名」+「エイリアス」+「指定桁数分のシーケンス番号」+「拡張子の文字列」
  導入されたバージョン:
    2.0

### getOtherFileName

    public java.lang.String getOtherFileName(java.lang.String alias)

  ファイルオブジェクトと同じパスのファイルが存在する場合、 「ファイル名」+「エイリアス」+「シーケンス番号」+「拡張子」の文字列を取得します。 同名のファイルが存在しない場合はファイルオブジェクトのファイルパスを取得します。
  なおオブジェクト自身のファイルパスを変更するわけではありません。

  パラメータ:
    `alias` - エイリアス
  戻り値:
    「ファイル名」+「エイリアス」+「シーケンス番号」+「拡張子」の文字列
  導入されたバージョン:
    2.0

### checkFileName

    public static boolean checkFileName(java.lang.String fileName)

  ファイル名が不正でない形式かどうかチェックをします。
  以下の条件に当てはまるとき不正ファイル名と判断します。
  1. null
  2. 長さが0バイト（空文字）、256バイト以上
  3. 大小区別せずに頭文字が「CON.」「AUX.」「PRN.」「NUL.」から始まる
  4. 拡張子を除いた名前が「COM[0-9]」「LPT[0-9]」のもの（[0-9]は0?9のどれか）
  5. 「/」「\」「:」「*」「?」「"」「<」「>」「|」を含む
  6. 末尾が「.」（ドット）

  パラメータ:
    `fileName` - ファイル名
  戻り値:
    正常はtrue、不正はfalse
  導入されたバージョン:
    2.0

### renameExtension

    public boolean renameExtension(java.lang.String newExtension)
                            throws java.lang.IllegalArgumentException

  ファイルオブジェクトとそのファイルの拡張子を指定した拡張子に変換します。 オブジェクトのみの存在であればオブジェクトの拡張子を変換します。

  パラメータ:
    `newExtension` - 変換する拡張子
  戻り値:
    変換が成功すればtrue、失敗すればfalse
  例外:
    `java.lang.IllegalArgumentException` - newExtensionがnull、もしくは「.」(ドット)の場合
  導入されたバージョン:
    2.0

### mkdir

    public boolean mkdir()

  推奨されていません。 このメソッドは利用してはなりません。

  このメソッドは利用してはなりません。 利用した場合、File#mkdir()と同じ処理を行います。

  オーバーライド:
    クラス `java.io.File` 内の `mkdir`
  導入されたバージョン:
    2.0

### mkdirs

    public boolean mkdirs()

  推奨されていません。 このメソッドは利用してはなりません。

  このメソッドは利用してはなりません。 利用した場合、File#mkdirs()と同じ処理を行います。

  オーバーライド:
    クラス `java.io.File` 内の `mkdirs`
  導入されたバージョン:
    2.0

### copy

    public void copy(java.io.OutputStream out)
              throws java.io.IOException

  オブジェクトに関連しているファイルをストリームに出力します。

  パラメータ:
    `out` - 出力ストリーム
  例外:
    `java.io.IOException` - オブジェクトに関連しているファイルが存在しない、またはストリームのIOに失敗した場合
    `java.lang.NullPointerException` - outがnullの場合
  導入されたバージョン:
    2.0

### copy

    public void copy(java.io.File out)
              throws java.io.IOException

  オブジェクトに関連しているファイルをコピー元としてコピーします。 コピー先にファイルが存在していた場合に上書きすることなく例外をスローします。

  パラメータ:
    `out` - コピー先ファイル
  例外:
    `java.io.IOException` - outが既に存在する、もしくはコピー時のIOに失敗した場合
    `java.lang.NullPointerException` - outがnullの場合
  導入されたバージョン:
    2.0

### copy

    public static void copy(java.io.InputStream in,
                            java.io.OutputStream out)
                     throws java.io.IOException

  入力ストリームを出力ストリームに出力します。

  パラメータ:
    `in` - 入力ストリーム
    `out` - 出力ストリーム
  例外:
    `java.io.IOException` - IOに失敗した場合
    `java.lang.NullPointerException` - inもしくはoutがnullの場合
  導入されたバージョン:
    2.0

### copy

    public static void copy(java.io.File in,
                            java.io.File out)
                     throws java.io.IOException

  ファイルをコピーします。 コピー先にファイルが存在していた場合に上書きすることなく例外をスローします。

  パラメータ:
    `in` - コピー元ファイル
    `out` - コピー先ファイル
  例外:
    `java.io.IOException` - outが既に存在する、もしくはコピー時のIOに失敗した場合
    `java.io.FileNotFoundException` - inが存在しない場合
    `java.lang.NullPointerException` - inもしくはoutがnullの場合
  導入されたバージョン:
    2.0

### copy

    public static void copy(java.io.File in,
                            java.io.File out,
                            boolean overwrite)
                     throws java.io.IOException

  ファイルをコピーします。 コピー先にファイルが存在していた場合に上書きするかどうかを指定することができます。

  パラメータ:
    `in` - コピー元ファイル
    `out` - コピー先ファイル
    `overwrite` - 既にファイルが存在している場合に上書きするならば true、例外をスローするならば false
  例外:
    `java.io.IOException` - outが既に存在する、もしくはコピー時のIOに失敗した場合
    `java.io.FileNotFoundException` - inが存在しない場合
    `java.lang.NullPointerException` - inもしくはoutがnullの場合
  導入されたバージョン:
    2.0

### getExtension

    public static java.lang.String getExtension(java.lang.String fileName)
                                         throws java.lang.NullPointerException

  ファイル名から拡張子を抽出します。 なおディレクトリパスが含まれている場合は拡張子を正しく取得することはできません。

  パラメータ:
    `fileName` - ファイル名
  戻り値:
    抽出した拡張子
  例外:
    `java.lang.NullPointerException` - fileNameがnullの場合
  導入されたバージョン:
    2.0

概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

Copyright © 2011. All Rights Reserved.