モジュール java.compiler

パッケージ javax.tools

インタフェースFileObject

既知のすべてのサブインタフェース:

JavaFileObject

既知のすべての実装クラス:

ForwardingFileObject, ForwardingJavaFileObject, SimpleJavaFileObject

public interface FileObject

ツール用のファイルの抽象化です。 このコンテキストでは、ファイルという語で、通常ファイルとその他のデータ・ソースを抽象的に表します。 たとえば、ファイル・オブジェクトを使って、通常ファイル、メモリー・キャッシュ、またはデータベース内のデータを表すことができます。

このインタフェースに含まれるすべてのメソッドは、セキュリティ例外が発生した場合に、SecurityExceptionをスローする可能性があります。

明示的に許可されていない場合に引数としてnullが指定されると、このインタフェースに含まれるすべてのメソッドはNullPointerExceptionをスローする可能性があります。

導入されたバージョン:

1.6

メソッドのサマリー

修飾子と型	メソッド	説明
boolean	delete()	このファイル・オブジェクトを削除します。
CharSequence	getCharContent(boolean ignoreEncodingErrors)	このファイル・オブジェクトの文字コンテンツ(使用可能な場合)を返します。
long	getLastModified()	このファイル・オブジェクトが最後に変更された時間を返します。
String	getName()	このファイル・オブジェクトのわかりやすい名前を返します。
InputStream	openInputStream()	このファイル・オブジェクトのInputStreamを返します。
OutputStream	openOutputStream()	このファイル・オブジェクトのOutputStreamを返します。
Reader	openReader(boolean ignoreEncodingErrors)	このオブジェクトのリーダーを返します。
Writer	openWriter()	このファイル・オブジェクトのライターを返します。
URI	toUri()	このファイル・オブジェクトを識別するURIを返します。

メソッドの詳細

toUri

URI toUri()

このファイル・オブジェクトを識別するURIを返します。

戻り値:

URI

getName

String getName()

このファイル・オブジェクトのわかりやすい名前を返します。 返される正確な値は指定されていませんが、実装は、ユーザーが指定した名前を保持するようになっています。 たとえば、ユーザーが"BobsApp\Test.java"というファイル名をコマンドラインに書き込む場合、このメソッドは "BobsApp\Test.java"を返し、toUriメソッドは file:///C:/Documents%20and%20Settings/UncleBob/BobsApp/Test.javaを返すことがあります。

戻り値:

ユーザーが使いやすい名前

openInputStream

InputStream openInputStream() throws IOException

このファイル・オブジェクトのInputStreamを返します。

戻り値:

InputStream

例外:

IllegalStateException - このファイル・オブジェクトが、書込み可能かつ読取り不可である場合

UnsupportedOperationException - この種類のファイル・オブジェクトがバイト・アクセスをサポートしない場合

IOException - 入出力エラーが発生した場合

openOutputStream

OutputStream openOutputStream() throws IOException

このファイル・オブジェクトのOutputStreamを返します。

戻り値:

OutputStream

例外:

IllegalStateException - このファイル・オブジェクトが、読取り可能かつ書込み不可である場合

UnsupportedOperationException - この種類のファイル・オブジェクトがバイト・アクセスをサポートしない場合

IOException - 入出力エラーが発生した場合

openReader

Reader openReader(boolean ignoreEncodingErrors) throws IOException

このオブジェクトのリーダーを返します。 返されるリーダーは、復号化できないバイトをデフォルトの変換文字で置き換えます。 さらに、ignoreEncodingErrorsがtrueでなければ、診断情報を報告することもあります。

パラメータ:

ignoreEncodingErrors - trueの場合はエンコーディング・エラーを無視

戻り値:

Reader

例外:

IllegalStateException - このファイル・オブジェクトが、書込み可能かつ読取り不可である場合

UnsupportedOperationException - この種類のファイル・オブジェクトが文字アクセスをサポートしない場合

IOException - 入出力エラーが発生した場合

getCharContent

CharSequence getCharContent(boolean ignoreEncodingErrors) throws IOException

このファイル・オブジェクトの文字コンテンツ(使用可能な場合)を返します。 復号化できないバイトは、デフォルトの変換文字で置き換えられます。 さらに、ignoreEncodingErrorsがtrueでなければ、診断情報が報告されることもあります。

パラメータ:

ignoreEncodingErrors - trueの場合はエンコーディング・エラーを無視

戻り値:

使用可能な場合はCharSequence、そうではない場合はnull

例外:

IllegalStateException - このファイル・オブジェクトが、書込み可能かつ読取り不可である場合

UnsupportedOperationException - この種類のファイル・オブジェクトが文字アクセスをサポートしない場合

IOException - 入出力エラーが発生した場合

openWriter

Writer openWriter() throws IOException

このファイル・オブジェクトのライターを返します。

戻り値:

Writer

例外:

IllegalStateException - このファイル・オブジェクトが、読取り可能かつ書込み不可である場合

UnsupportedOperationException - この種類のファイル・オブジェクトが文字アクセスをサポートしない場合

IOException - 入出力エラーが発生した場合

getLastModified

long getLastModified()

このファイル・オブジェクトが最後に変更された時間を返します。 この時間は、元期(1970年1月1日0時0分0秒GMT)からミリ秒単位で測定されます。

戻り値:

このファイル・オブジェクトが最後に変更された時間。ファイル・オブジェクトが存在しない場合、入出力エラーが発生した場合、または操作がサポートされていない場合は0

delete

boolean delete()

このファイル・オブジェクトを削除します。 エラーの場合はfalseを返します。

戻り値:

このファイル・オブジェクトが正常に削除された場合にかぎりtrue。そうでない場合はfalse