IOUtil (eglibrary-java-core API)

java.lang.Object
- com.eaglesakura.io.IOUtil

public class IOUtil
extends java.lang.Object

File関連の便利メソッドを提供する

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

コンストラクタ
コンストラクタと説明

IOUtil()

コンストラクタ
コンストラクタと説明
`IOUtil()`

メソッドのサマリー

All Methods Static Methods Concrete Methods Deprecated Methods
修飾子とタイプ	メソッドと説明
`static java.io.File`	`cleanDirectory(java.io.File dir)` ディレクトリの中身を完全削除する。
`static void`	`close(java.io.InputStream is)` Streamを閉じる
`static void`	`close(java.io.OutputStream os)` Streamを閉じる
`static byte[]`	`compressGzip(byte[] raw)` rawバッファをGZIPに圧縮して返却する
`static void`	`copy(java.io.File src, java.io.File dst)` 指定箇所へファイルをコピーする。
`static void`	`copyOrUpdate(java.io.File src, java.io.File dst)` コピー先が存在しない、もしくはMD5が一致しない場合のみコピーを行い、それ以外はコピーを行わない
`static void`	`copyTo(java.io.InputStream input, boolean closeInput, java.io.OutputStream output, boolean closeOutput)` inputのバッファを全てoutputへコピーする。
`static void`	`copyTo(java.io.InputStream input, java.io.OutputStream output)` inputのバッファを全てoutputへコピーする。
`static byte[]`	`decompressGzipOrNull(byte[] gzip)` GZIPバッファをデコードする。
`static void`	`delete(java.io.File root)` ディレクトリを再帰的に削除する。
`static boolean`	`equals(java.io.File a, java.io.File b)` 同じ内容を指していた場合はtrue
`static java.lang.String`	`genMD5(java.io.File file)` ファイルからMD5を求める。
`static java.lang.String`	`genPathSHA1(java.io.File file)` ファイルパスからSHA1を得る。
`static java.lang.String`	`genSHA1(java.io.File file)` ファイルからSHA1を求める。
`static java.lang.String`	`genShortHash(java.io.File file, int checkLength)` 末尾・先端のバイト列を用いた単純なハッシュを生成するファイルフォーマットによっては衝突の可能性が非常に高いため、利用する場合は十分に検討を行うこと。
`static java.io.File`	`getCurrentDirectory()` 現在のディレクトリを取得する
`static java.lang.String`	`getCurrentDirectoryPath()` カレントディレクトリのパスを取得する。
`static java.util.List<java.io.File>`	`getDirectoryRoute(java.io.File target, java.io.File parent)` parentからtargetに到達するまでの全てのファイルを取得する。
`static java.lang.String`	`getFileExt(java.lang.String fileName)` ファイル拡張子を取得する。
`static java.lang.String`	`getFileName(java.lang.String fileName)` 拡張子付のファイル名からファイル名のみを抜き出す
`static boolean`	`isDirectory(java.io.File file)`
`static boolean`	`isFile(java.io.File file)`
`static boolean`	`isGzip(byte[] buffer)` GZIPバッファであればtrueを返却する。
`static java.io.File`	`mkdir(java.io.File dir)` 非推奨です。
`static java.lang.String`	`normalizeFileName(java.lang.String origin)` 比較等の処理を行うために文字列を正規化する
`static java.io.File[]`	`sort(java.io.File[] files)` ファイルを名前順にソートする。
`static byte[]`	`toByteArray(java.io.InputStream is, boolean close)` InputStreamを全てメモリ上に展開する。
`static byte[]`	`toByteArray(int[] array)` int配列をbit状態を保ってbyte配列へ変換する
`static byte[]`	`toByteArray(int[] array, byte[] result)` int配列をbit状態を保ってbyte配列へ変換する
`static byte[]`	`toByteArrayOrNull(java.io.File file)` ファイルをbyte列 or null
`static java.lang.String`	`toString(java.io.InputStream is, boolean close)` InputStreamから文字列へ変換する
`static java.lang.String`	`toStringOrNull(java.io.File file)` ファイルを文字列 or null
`static void`	`unzip(java.io.File zipFile, java.io.File outDirectory)` ZIPの解凍を行う
`static void`	`unzip(java.io.InputStream stream, java.io.File outDirectory)` InputStream経由でUnzipを行う

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

- コンストラクタの詳細
  - IOUtil
```
public IOUtil()
```
- メソッドの詳細
  - copyTo
```
public static void copyTo(java.io.InputStream input,
                          java.io.OutputStream output)
                   throws java.io.IOException
```
    inputのバッファを全てoutputへコピーする。完了した時点でストリームはcloseされる。
    
    パラメータ:
    
    input - コピー元
    
    output - コピー先
    
    例外:
    
    java.io.IOException
  - copyTo
```
public static void copyTo(java.io.InputStream input,
                          boolean closeInput,
                          java.io.OutputStream output,
                          boolean closeOutput)
                   throws java.io.IOException
```
    inputのバッファを全てoutputへコピーする。完了した時点でストリームはcloseされる。
    
    パラメータ:
    
    input - コピー元
    
    closeInput - 終了時にinputを閉じる
    
    output - コピー先
    
    closeOutput - 終了時にoutputを閉じる
    
    例外:
    
    java.io.IOException
  - toByteArray
```
public static final byte[] toByteArray(int[] array)
```
    int配列をbit状態を保ってbyte配列へ変換する
    
    パラメータ:
    
    array - 変換元のint配列
    
    戻り値:
    
    コピーされたbyte配列
  - toByteArray
```
public static final byte[] toByteArray(int[] array,
                                       byte[] result)
```
    int配列をbit状態を保ってbyte配列へ変換する
    
    パラメータ:
    
    array - 変換元のint配列
    
    result - 変換先のbyte配列
    
    戻り値:
    
    resultオブジェクト
  - toString
```
public static java.lang.String toString(java.io.InputStream is,
                                        boolean close)
                                 throws java.io.IOException
```
    InputStreamから文字列へ変換する
    
    パラメータ:
    
    is - 読み込み対象のstream
    
    close - closeする場合はtrue
    
    戻り値:
    
    読み取った文字列
    
    例外:
    
    java.io.IOException
  - toByteArrayOrNull
```
public static byte[] toByteArrayOrNull(java.io.File file)
```
    ファイルをbyte列 or null
    
    パラメータ:
    
    file - ファイルパス
    
    戻り値:
    
    ファイルが読み込めればbyte配列
  - toStringOrNull
```
public static java.lang.String toStringOrNull(java.io.File file)
```
    ファイルを文字列 or null
    
    パラメータ:
    
    file - ファイルパス
    
    戻り値:
    
    文字列に変換できれば文字列
  - toByteArray
```
public static byte[] toByteArray(java.io.InputStream is,
                                 boolean close)
                          throws java.io.IOException
```
    InputStreamを全てメモリ上に展開する。 isの長さがOOMにならないように調整すること。
    
    パラメータ:
    
    is - 読み込み対象
    
    close - isを閉じるならtrue
    
    戻り値:
    
    読み込んだbyte配列
    
    例外:
    
    java.io.IOException
  - copy
```
public static final void copy(java.io.File src,
                              java.io.File dst)
                       throws java.io.IOException
```
    指定箇所へファイルをコピーする。
    
    パラメータ:
    
    src - コピー元
    
    dst - コピー先
    
    例外:
    
    java.io.IOException
  - copyOrUpdate
```
public static final void copyOrUpdate(java.io.File src,
                                      java.io.File dst)
                               throws java.io.IOException
```
    コピー先が存在しない、もしくはMD5が一致しない場合のみコピーを行い、それ以外はコピーを行わない
    
    パラメータ:
    
    src - コピー元
    
    dst - コピー先
    
    例外:
    
    java.io.IOException
  - genMD5
```
public static java.lang.String genMD5(java.io.File file)
```
    ファイルからMD5を求める。
    
    パラメータ:
    
    file - 生成元ファイル
    
    戻り値:
    
    MD5
  - genShortHash
```
public static java.lang.String genShortHash(java.io.File file,
                                            int checkLength)
```
    末尾・先端のバイト列を用いた単純なハッシュを生成するファイルフォーマットによっては衝突の可能性が非常に高いため、利用する場合は十分に検討を行うこと。
    
    パラメータ:
    
    file - ファイルパス
    
    checkLength - 確認容量
    
    戻り値:
    
    ハッシュ値
  - genSHA1
```
public static java.lang.String genSHA1(java.io.File file)
```
    ファイルからSHA1を求める。
    
    パラメータ:
    
    file - 生成するファイル
    
    戻り値:
    
    SHA1
  - delete
```
public static void delete(java.io.File root)
```
    ディレクトリを再帰的に削除する。
    
    パラメータ:
    
    root - 削除するディレクトリ
  - getFileExt
```
public static java.lang.String getFileExt(java.lang.String fileName)
```
    ファイル拡張子を取得する。
    
    パラメータ:
    
    fileName - ファイル名
    
    戻り値:
    
    ドットを含まない拡張子
  - getFileName
```
public static java.lang.String getFileName(java.lang.String fileName)
```
    拡張子付のファイル名からファイル名のみを抜き出す
    
    パラメータ:
    
    fileName - ファイル名
    
    戻り値:
    
    拡張子を取り除いたファイル名
  - genPathSHA1
```
public static java.lang.String genPathSHA1(java.io.File file)
```
    ファイルパスからSHA1を得る。
    
    パラメータ:
    
    file - 生成するファイル
    
    戻り値:
    
    SHA1
  - getCurrentDirectoryPath
```
public static java.lang.String getCurrentDirectoryPath()
```
    カレントディレクトリのパスを取得する。
    
    戻り値:
    
    現在のディレクトリ
  - getCurrentDirectory
```
public static java.io.File getCurrentDirectory()
```
    現在のディレクトリを取得する
    
    戻り値:
    
    カレントディレクトリ
  - sort
```
public static java.io.File[] sort(java.io.File[] files)
```
    ファイルを名前順にソートする。 inの中身がソートされるため、戻り値は同じ参照となる。
    
    パラメータ:
    
    files - ファイルを名前順にソートする
    
    戻り値:
    
    filesオブジェクト
  - normalizeFileName
```
public static java.lang.String normalizeFileName(java.lang.String origin)
```
    比較等の処理を行うために文字列を正規化する
    
    パラメータ:
    
    origin - 元の文字列
    
    戻り値:
    
    比較用に変換した文字列
  - mkdir
```
@Deprecated
public static java.io.File mkdir(java.io.File dir)
```
    非推奨です。
    
    そこまでの道を含めてディレクトリを作成する。 File.mkdirs() を使用すべき
    
    パラメータ:
    
    dir -
    
    戻り値:
  - getDirectoryRoute
```
public static java.util.List<java.io.File> getDirectoryRoute(java.io.File target,
                                                             java.io.File parent)
```
    parentからtargetに到達するまでの全てのファイルを取得する。戻り値にtargetとparentも含まれる。階層が上にあるFileがindexの0に近くなる。
    
    パラメータ:
    
    target - 探すファイル
    
    parent - 親ディレクトリ
    
    戻り値:
    
    探索できた全てのファイル
  - cleanDirectory
```
public static java.io.File cleanDirectory(java.io.File dir)
```
    ディレクトリの中身を完全削除する。 dirフォルダ自体は残る。
    
    パラメータ:
    
    dir - 削除対象のディレクトリ
    
    戻り値:
    
    dirオブジェクト
  - equals
```
public static boolean equals(java.io.File a,
                             java.io.File b)
```
    同じ内容を指していた場合はtrue
    
    パラメータ:
    
    a - ファイルA
    
    b - ファイルB
    
    戻り値:
    
    同じパスである場合はtrue
  - isGzip
```
public static boolean isGzip(byte[] buffer)
```
    GZIPバッファであればtrueを返却する。
    ただし、これはヘッダのみをチェックするため、簡易的なチェックしか行えない。
    
    パラメータ:
    
    buffer - ヘッダ
    
    戻り値:
    
    GZIPであればtrue
  - compressGzip
```
public static byte[] compressGzip(byte[] raw)
```
    rawバッファをGZIPに圧縮して返却する
    
    パラメータ:
    
    raw - 元ファイル配列
    
    戻り値:
    
    GZIP配列
  - decompressGzipOrNull
```
public static byte[] decompressGzipOrNull(byte[] gzip)
```
    GZIPバッファをデコードする。失敗したらnullを返却する。
    
    パラメータ:
    
    gzip - GZIPバッファ
    
    戻り値:
    
    解凍したバッファ
  - unzip
```
public static void unzip(java.io.InputStream stream,
                         java.io.File outDirectory)
                  throws java.io.IOException
```
    InputStream経由でUnzipを行う
    
    パラメータ:
    
    stream - 読み込み対象
    
    outDirectory - 書き込み対象
    
    例外:
    
    java.io.IOException
  - unzip
```
public static void unzip(java.io.File zipFile,
                         java.io.File outDirectory)
                  throws java.io.IOException
```
    ZIPの解凍を行う
    
    パラメータ:
    
    zipFile - ZIPファイル
    
    outDirectory - 解凍ディレクトリ
    
    例外:
    
    java.io.IOException
  - close
```
public static void close(java.io.InputStream is)
```
    Streamを閉じる
    
    パラメータ:
    
    is - 対象
  - close
```
public static void close(java.io.OutputStream os)
```
    Streamを閉じる
    
    パラメータ:
    
    os - 対象
  - isFile
```
public static boolean isFile(java.io.File file)
```
  - isDirectory
```
public static boolean isDirectory(java.io.File file)
```

クラス IOUtil

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

メソッドのサマリー

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

コンストラクタの詳細

IOUtil

メソッドの詳細

copyTo

copyTo

toByteArray

toByteArray

toString

toByteArrayOrNull

toStringOrNull

toByteArray

copy

copyOrUpdate

genMD5

genShortHash

genSHA1

delete

getFileExt

getFileName

genPathSHA1

getCurrentDirectoryPath

getCurrentDirectory

sort

normalizeFileName

mkdir

getDirectoryRoute

cleanDirectory

equals

isGzip

compressGzip

decompressGzipOrNull

unzip

unzip

close

close

isFile

isDirectory