JsDoc Toolkit テンプレート開発者向けAPIリファレンス

名前空間IO

ファイルの読み書きを実行するメソッドのコレクションです。

A collection of functions that deal with reading a writing to disk.

定義	run.js

プライベートメンバを隠す

概要	名前空間 \| クラス \| 定数 \| プロパティ \| メソッド \| イベント \| 詳細トップ \| ページトップ

プロパティ ↑
<private><static> unknown	IO.encoding ( "utf-8" )

メソッド ↑
<static> void	IO.copyFile(inFile , outDir [, fileName]) ファイルをコピーします。
<static> Boolean	IO.exists(path) 指定されたパスが存在するか判定します。
<static> void	IO.include(relativePath) SYS.pwd からの相対パスで指定されたファイルをロードします。
<static> void	IO.includeDir(relativePath) SYS.pwd からの相対パスで指定されたディレクトリに含まれるスクリプトファイル（拡張子が.jsのファイル）を全てロードします。
<static> String[]	IO.ls(dir [, recurse] [, _allFiles] [, _path]) 指定されたディレクトリの配下を再帰的に検索し、全てのファイルパスの配列を返します。
<static> void	IO.makeDir(path) ディレクトリを作成します。
<static> void	IO.mkPath(path) ディレクトリ階層を作成します。
<static> Packages.java.io.PrintWriter	IO.open(path [, append]) 指定されたファイルパスへの出力ストリームライターを作成して返します。
<static> String	IO.readFile(path) ファイルを読み込み、その内容を文字列として返します。
<static> void	IO.saveFile(outDir , fileName , content) 文字列をファイルに保存します。
<static> void	IO.setEncoding(encoding) この名前空間のメソッドによるファイル入出力処理で使用される文字エンコーディングを設定します。

詳細	定数 \| プロパティ \| メソッド \| イベント \| 概要トップ \| ページトップ

プロパティ ↑

<private><static> unknown IO.encoding

↑

初期値

"utf-8"

メソッド ↑

<static> void IO.copyFile(inFile , outDir [, fileName])

↑

ファイルをコピーします。

引数

String	inFile	入力ファイルのパス
String	outDir	出力ファイルのディレクトリパス
String	[fileName]	出力ファイル名。省略した場合は入力ファイル名がそのまま使用されます。

<static> Boolean IO.exists(path)

↑

指定されたパスが存在するか判定します。

引数

String path ファイルパス

戻り値

Boolean

ファイルパスが存在すればtrue、なければfalse

<static> void IO.include(relativePath)

↑

SYS.pwd からの相対パスで指定されたファイルをロードします。

Load the given script.

引数

String relativePath SYS.pwdからの相対パスで指定されたファイルパス

<static> void IO.includeDir(relativePath)

↑

SYS.pwd からの相対パスで指定されたディレクトリに含まれるスクリプトファイル（拡張子が.jsのファイル）を全てロードします。

Loads all scripts from the given directory path.

引数

String relativePath SYS.pwdからの相対パスで指定されたディレクトリパス

<static> String[] IO.ls(dir [, recurse] [, _allFiles] [, _path])

↑

指定されたディレクトリの配下を再帰的に検索し、全てのファイルパスの配列を返します。

引数

String	dir	検索を開始するディレクトリ。 The starting directory to look in.
Number	[recurse=1]	検索する階層数 How many levels deep to scan.
String[]	[_allFiles]	再帰呼び出し中に使用されるパラメータ
String	[_path]	再帰呼び出し中に使用されるパラメータ

戻り値

String[]

検索されたディレクトリに存在する全てのファイルパス。

An array of all the paths to files in the given dir.

<static> void IO.makeDir(path)

↑

ディレクトリを作成します。

Creates a directory at the given path.

引数

String path ディレクトリパス

<static> void IO.mkPath(path)

↑

ディレクトリ階層を作成します。

Creates a series of nested directories.

引数

String | String[] path ディレクトリパスを表す文字列、もしくは各階層のディレクトリ名を要素に持つ配列

<static> Packages.java.io.PrintWriter IO.open(path [, append])

↑

指定されたファイルパスへの出力ストリームライターを作成して返します。

引数

String	path	ファイルパス
Boolean	[append]	（このパラメータは使用されていません。）

戻り値

Packages.java.io.PrintWriter

指定されたファイルパスへの出力ストリームライター

<static> String IO.readFile(path)

↑

ファイルを読み込み、その内容を文字列として返します。

引数

String path ファイルパス

戻り値

String

ファイルの内容

例外

Exception

指定されたファイルパスが存在しない場合に発生します。

<static> void IO.saveFile(outDir , fileName , content)

↑

文字列をファイルに保存します。

Create a new file in the given directory, with the given name and contents.

引数

String	outDir	出力ディレクトリ
String	fileName	出力ファイル名
String	content	ファイルに保存する内容

<static> void IO.setEncoding(encoding)

↑

この名前空間のメソッドによるファイル入出力処理で使用される文字エンコーディングを設定します。

Sets IO.encoding. Encoding is used when reading and writing text to files, and in the meta tags of HTML output.

引数

String encoding 文字エンコーディング名

Documentation generated by JsDoc Toolkit 2.3.2 (template:aias-frame 1.6.1) on Mon Apr 05 2010 22:07:30 GMT+0900 (JST)