Fileオブジェクト
コンポーネント情報 | |
---|---|
version | 8.0.20 |
since | 2.0 |
ファイル操作オブジェクト。
Application Runtime 環境のファイルを操作するAPIを持つオブジェクトです。
このAPIは、Application Runtime の動作しているマシンを対象としてファイル操作を行いますので、Application Runtime を分散構築にて複数のコンピュータで運用しているしている場合には、ファイルを共有する事ができません。
各リクエスト、また各クライアント、また各プログラム間で、ファイルおよびディレクトリ名が重複しないように工夫する必要があります。
Application Runtime 環境のファイルを操作するAPIを持つオブジェクトです。
このAPIは、Application Runtime の動作しているマシンを対象としてファイル操作を行いますので、Application Runtime を分散構築にて複数のコンピュータで運用しているしている場合には、ファイルを共有する事ができません。
各リクエスト、また各クライアント、また各プログラム間で、ファイルおよびディレクトリ名が重複しないように工夫する必要があります。
メソッドの概要
返却値の型 | メソッド名 |
---|---|
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/ ディレクトリを親として絶対パスを解決します。
パラメータ
|
File (String parent , String child )
コンストラクタ。
指定のパスに対するファイル(ディレクトリ)操作を行うためのインスタンスを生成します。 実際にアクセスするファイルは、parent + child が表すファイルまたはディレクトリになります。 このコンストラクタで生成されたインスタンスが、実際に操作する対象は、Application Runtime が動作している環境のファイルになります。
パラメータ
|
メソッドの詳細
ByteWriter appendAsBinary (Function [callback] )
ファイルを ByteWriter で開いて返します。
パラメータ
返却値
|
TextWriter appendAsText (Function [callback] , String [charsetName] )
ファイルを TextWriter で開いて返します。
パラメータ
返却値
|
Boolean append (String strm )
テキストのファイルへ追記を行います。
ファイルに対して指定のテキストデータを追記します。 引数 strm へは Unicode 体系のテキストデータを渡して下さい。 ファイルへの出力時に、Application Runtime の サーバ文字エンコーディング設定で解決される文字コードへ変換をしてファイルに出力します。 ファイルが存在しない場合には、新規にファイルを作成してデータ出力を行います。
パラメータ
返却値
|
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 ()
ファイルの最終更新日付を取得します。
コンストラクタで指定されたパスの最終更新時刻を返却します。 返却値は、1970/01/01からのミリ秒で返す。
返却値
|
String load ()
ファイルの内容を取得します。
コンストラクタで指定されたファイル内のデータをストリームとして返します。 ファイルの内容はバイナリとして扱われます。
返却値
|
Boolean makeDirectories ()
ディレクトリを作成します。
コンストラクタで指定されたパスをディレクトリとして新規作成します。 存在していないが必要な親ディレクトリも一緒に作成されます。 このオペレーションが失敗した場合でも、いくつかの必要な親ディレクトリの作成には成功した場合があります。
返却値
|
Boolean move (File newFile )
ファイル名を変更します。
コンストラクタで指定されたパスを引数 newPath に変更します。 引数 newFile には、File APIのインスタンスを渡して下さい。
パラメータ
返却値
|
ByteReader openAsBinary (Function [callback] )
ファイルを ByteReader で開いて返します。
パラメータ
返却値
|
TextReader openAsText (Function [callback] , String [charsetName] )
ファイルを TextReader で開いて返します。
パラメータ
返却値
|
String path ()
パス名を取得します。
このインスタンスの示すパス名を返却します。
返却値
|
String read ()
テキストファイル内容を取得します。
このインスタンスの示すファイルの内容を返却します。 ファイルデータはテキストとして扱われます。 ファイルデータは、読込後、自動的に Unicode に変換されます。 ファイルデータは、ApplicationRuntime の conf/server-context-config.xml の「server-charset」で指定されている 文字エンコーディングで作成されている必要があります。(これに反する場合、文字化けが発生します)
返却値
|
Boolean remove ()
ファイルまたはディレクトリを削除します。
このインスタンスの示すパスを削除します。
返却値
|
Boolean save (String strm )
ファイルへのデータ出力を行います。
このインスタンスの示すファイル・パスに対して引数に指定されたデータを書き出します。 データはバイナリとして扱われます。
パラメータ
返却値
|
Number size ()
ファイルサイズを取得します。
このインスタンスの示すファイル・パスのファイルの大きさを返却します。 返却値の単位は、バイトです。 このインスタンスの示すファイルパスが存在しない場合の動作は未定義です。
返却値
|
void toString ()
返却値
|
Boolean write (String strm )
テキストファイルの出力を行います。
このインスタンスの示すファイル・パスに対して引数に指定されたデータを書き出します。 データはテキストとして扱われます。 引数 strm には Unicode のデータを渡して下さい。 ファイルに対して出力する際には、自動的にサーバ文字エンコーディング設定の文字コードに変換されます。
パラメータ
返却値
|