コンストラクタの概要

File (String path)
コンストラクタ。
File (String parent, String child)
コンストラクタ。

メソッドの概要

返却値の型 メソッド名
ByteWriter appendAsBinary (Function [callback])
ファイルを ByteWriter で開いて返します。
TextWriter appendAsText (Function [callback], String [charsetName])
ファイルを TextWriter で開いて返します。
Boolean append (String strm)
テキストのファイルへ追記を行います。
ByteWriter createAsBinary (Function [callback])
ファイルを ByteWriter で開いて返します。
TextWriter createAsText (Function [callback], String [charsetName])
ファイルを TextWriter で開いて返します。
File createTempFile (String [prefix], String [suffix], File [directory], Boolean [deleteOnExit]) static
新しい空のファイルを作成します。
Array directories ()
ディレクトリ一覧を取得します。
Boolean exist ()
ファイル(ディレクトリ)の存在確認を行います。
Array files ()
ファイル一覧を取得します。
Boolean isDirectory ()
ディレクトリの存在確認を行います。
Boolean isFile ()
ファイルの存在確認を行います。
Number lastModified ()
ファイルの最終更新日付を取得します。
String load ()
ファイルの内容を取得します。
Boolean makeDirectories ()
ディレクトリを作成します。
Boolean move (File newFile)
ファイル名を変更します。
ByteReader openAsBinary (Function [callback])
ファイルを ByteReader で開いて返します。
TextReader openAsText (Function [callback], String [charsetName])
ファイルを TextReader で開いて返します。
String path ()
パス名を取得します。
String read ()
テキストファイル内容を取得します。
Boolean remove ()
ファイルまたはディレクトリを削除します。
Boolean save (String strm)
ファイルへのデータ出力を行います。
Number size ()
ファイルサイズを取得します。
void toString ()
Boolean write (String strm)
テキストファイルの出力を行います。

コンストラクタの詳細

File (String path)
コンストラクタ。

指定のパスに対するファイル(ディレクトリ)操作を行うためのインスタンスを生成します。
このコンストラクタで生成されたインスタンスが、実際に操作する対象は、Application Runtime が動作している環境のファイルになります。
パスが相対パス形式で指定された場合、このコンストラクタは Application Runtime をインストールしたディレクトリ内にある work/ ディレクトリを親として絶対パスを解決します。
パラメータ
path : String
ファイルパス
File (String parent, String child)
コンストラクタ。

指定のパスに対するファイル(ディレクトリ)操作を行うためのインスタンスを生成します。
実際にアクセスするファイルは、parent + child が表すファイルまたはディレクトリになります。
このコンストラクタで生成されたインスタンスが、実際に操作する対象は、Application Runtime が動作している環境のファイルになります。
パラメータ
parent : String
親ディレクトリパス
child : String
ファイルパス

メソッドの詳細

ByteWriter appendAsBinary (Function [callback])
ファイルを ByteWriter で開いて返します。
パラメータ
[callback] : Function
ByteWriterとエラー情報を受け取るコールバック関数
返却値
ByteWriter
ByteWriter ファイル表すByteWriter
TextWriter appendAsText (Function [callback], String [charsetName])
ファイルを TextWriter で開いて返します。
パラメータ
[callback] : Function
TextWriterとエラー情報を受け取るコールバック関数
[charsetName] : String
エンコーディング名
返却値
TextWriter
TextWriter ファイルを表すTextWriter
Boolean append (String strm)
テキストのファイルへ追記を行います。

ファイルに対して指定のテキストデータを追記します。
引数 strm へは Unicode 体系のテキストデータを渡して下さい。
ファイルへの出力時に、Application Runtime の サーバ文字エンコーディング設定で解決される文字コードへ変換をしてファイルに出力します。
ファイルが存在しない場合には、新規にファイルを作成してデータ出力を行います。
パラメータ
strm : String
テキストデータ
返却値
Boolean
Boolean true : 成功 / false : 失敗
ByteWriter createAsBinary (Function [callback])
ファイルを ByteWriter で開いて返します。
パラメータ
[callback] : Function
ByteWriterとエラー情報を受け取るコールバック関数
返却値
ByteWriter
ByteWriter ファイル表すByteWriter
TextWriter createAsText (Function [callback], String [charsetName])
ファイルを TextWriter で開いて返します。
パラメータ
[callback] : Function
TextWriterとエラー情報を受け取るコールバック関数
[charsetName] : String
エンコーディング名
返却値
TextWriter
TextWriter ファイルを表すTextWriter
File createTempFile (String [prefix], String [suffix], File [directory], Boolean [deleteOnExit]) static
新しい空のファイルを作成します。

指定されたディレクトリで新しい空のファイルを生成し、その名前には、指定された接頭辞および接尾辞の文字列が使用されます。
パラメータ
[prefix] : String
ファイル名を生成するために使用される接頭辞文字列。(3文字以上の長さが必要です) 指定されなかった場合は、システム時刻を "yyyy-MM-dd_HHmmss" 形式で表現した文字列が使用されます。
[suffix] : String
ファイル名を生成するために使用される接尾辞文字列。
null も指定でき、その場合は、接尾辞 ".tmp" が使用されます。
指定されなかった場合は、".tmp" が使用されます。
[directory] : File
ファイルが生成されるディレクトリ。
指定されなかった場合、または、指定されたFileオブジェクトがディレクトリではなかった場合は、 Application Runtime をインストールしたディレクトリ内にある work/ ディレクトリが使用されます。
[deleteOnExit] : Boolean
JavaVMが終了したときに削除する場合は、true, それ以外はfalseを指定してください。
指定されなかった場合は、falseが使用されます。
返却値
File
File 新規作成された空のファイルを示すFileオブジェクト
Array directories ()
ディレクトリ一覧を取得します。

コンストラクタで指定されたディレクトリ・パスに含まれる全てのディレクトリ名称を返却します。
コンストラクタで指定されたパスが存在するディレクトリではなかった場合の動作は保証されません。
返却値
Array
Array ディレクトリ一覧(配列型)
Boolean exist ()
ファイル(ディレクトリ)の存在確認を行います。

コンストラクタで指定されたパスが存在しているかどうかをチェックした結果を返却します。
返却値
Boolean
Boolean true : 存在する / false : 存在しない
Array files ()
ファイル一覧を取得します。

コンストラクタで指定されたディレクトリ・パスに含まれる全てのファイル名称を返却します。
コンストラクタで指定されたパスが存在するディレクトリではなかった場合の動作は保証されません。
返却値
Array
Array ファイル一覧(配列型)
Boolean isDirectory ()
ディレクトリの存在確認を行います。

コンストラクタで指定されたパスがディレクトリとして存在しているかどうかをチェックした結果を返却します。
返却値
Boolean
Boolean true : 存在する / false : 存在しない
Boolean isFile ()
ファイルの存在確認を行います。

コンストラクタで指定されたパスがファイルとして存在しているかどうかをチェックした結果を返却します。
返却値
Boolean
Boolean true : 存在する / false : 存在しない
Number lastModified ()
ファイルの最終更新日付を取得します。

コンストラクタで指定されたパスの最終更新時刻を返却します。
返却値は、1970/01/01からのミリ秒で返す。
返却値
Number
Number 最終更新日付(ミリ秒)
String load ()
ファイルの内容を取得します。

コンストラクタで指定されたファイル内のデータをストリームとして返します。
ファイルの内容はバイナリとして扱われます。
返却値
String
String ファイルの内容
Boolean makeDirectories ()
ディレクトリを作成します。

コンストラクタで指定されたパスをディレクトリとして新規作成します。
存在していないが必要な親ディレクトリも一緒に作成されます。
このオペレーションが失敗した場合でも、いくつかの必要な親ディレクトリの作成には成功した場合があります。
返却値
Boolean
Boolean true : 成功 / false : 失敗
Boolean move (File newFile)
ファイル名を変更します。

コンストラクタで指定されたパスを引数 newPath に変更します。
引数 newFile には、File APIのインスタンスを渡して下さい。
パラメータ
newFile : File
新しいパス名
返却値
Boolean
Boolean true : 成功 / false : 失敗
ByteReader openAsBinary (Function [callback])
ファイルを ByteReader で開いて返します。
パラメータ
[callback] : Function
ByteReaderとエラー情報を受け取るコールバック関数
返却値
ByteReader
ByteReader ファイル表すByteReader
TextReader openAsText (Function [callback], String [charsetName])
ファイルを TextReader で開いて返します。
パラメータ
[callback] : Function
TextReaderとエラー情報を受け取るコールバック関数
[charsetName] : String
エンコーディング名
返却値
TextReader
TextReader ファイルを表すTextReader
String path ()
パス名を取得します。

このインスタンスの示すパス名を返却します。
返却値
String
String パス名
String read ()
テキストファイル内容を取得します。

このインスタンスの示すファイルの内容を返却します。
ファイルデータはテキストとして扱われます。
ファイルデータは、読込後、自動的に Unicode に変換されます。

ファイルデータは、ApplicationRuntime の conf/server-context-config.xml の「server-charset」で指定されている
文字エンコーディングで作成されている必要があります。(これに反する場合、文字化けが発生します)
返却値
String
String ファイルの内容
Boolean remove ()
ファイルまたはディレクトリを削除します。

このインスタンスの示すパスを削除します。
返却値
Boolean
Boolean true : 成功 / false : 失敗
Boolean save (String strm)
ファイルへのデータ出力を行います。

このインスタンスの示すファイル・パスに対して引数に指定されたデータを書き出します。
データはバイナリとして扱われます。
パラメータ
strm : String
データ
返却値
Boolean
Boolean true : 成功 / false : 失敗
Number size ()
ファイルサイズを取得します。

このインスタンスの示すファイル・パスのファイルの大きさを返却します。
返却値の単位は、バイトです。
このインスタンスの示すファイルパスが存在しない場合の動作は未定義です。
返却値
Number
Number ファイルサイズ(バイト数)
void toString ()
返却値
void
Boolean write (String strm)
テキストファイルの出力を行います。

このインスタンスの示すファイル・パスに対して引数に指定されたデータを書き出します。
データはテキストとして扱われます。
引数 strm には Unicode のデータを渡して下さい。
ファイルに対して出力する際には、自動的にサーバ文字エンコーディング設定の文字コードに変換されます。
パラメータ
strm : String
テキストデータ
返却値
Boolean
Boolean true : 成功 / false : 失敗