- 既知のすべてのサブインタフェース:
JavaFileObject
- 既知のすべての実装クラス:
ForwardingFileObject
,ForwardingJavaFileObject
,SimpleJavaFileObject
public interface FileObject
ツール用のファイルの抽象化です。 このコンテキストでは、ファイルという語で、通常ファイルとその他のデータ・ソースを抽象的に表します。 たとえば、ファイル・オブジェクトを使って、通常ファイル、メモリー・キャッシュ、またはデータベース内のデータを表すことができます。
このインタフェースに含まれるすべてのメソッドは、セキュリティ例外が発生した場合に、SecurityExceptionをスローする可能性があります。
明示的に許可されていない場合に引数としてnull
が指定されると、このインタフェースに含まれるすべてのメソッドはNullPointerExceptionをスローする可能性があります。
- 導入されたバージョン:
- 1.6
-
メソッドのサマリー
修飾子と型メソッド説明boolean
delete()
このファイル・オブジェクトを削除します。getCharContent
(boolean ignoreEncodingErrors) 使用可能な場合は、このファイル・オブジェクトの文字コンテンツを返します。long
このファイル・オブジェクトが最後に変更された時間を返します。getName()
このファイル・オブジェクトのわかりやすい名前を返します。このファイル・オブジェクトのInputStreamを返します。このファイル・オブジェクトのOutputStreamを返します。openReader
(boolean ignoreEncodingErrors) このオブジェクトのリーダーを返します。このファイル・オブジェクトのWriterを返します。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
このオブジェクトのリーダーを返します。 返されるリーダーは、復号化できないバイトをデフォルトの変換文字で置き換えます。 さらに、ignoreEncodingErrors
がtrueでなければ、診断情報を報告することもあります。- パラメータ:
ignoreEncodingErrors
- trueの場合はエンコーディング・エラーを無視- 戻り値:
- Reader
- 例外:
IllegalStateException
- このファイル・オブジェクトが、書込み可能かつ読取り不可である場合UnsupportedOperationException
- この種類のファイル・オブジェクトが文字アクセスをサポートしない場合IOException
- 入出力エラーが発生した場合
-
getCharContent
使用可能な場合は、このファイル・オブジェクトの文字コンテンツを返します。 復号化できないバイトは、デフォルトの変換文字で置き換えられます。 さらに、ignoreEncodingErrors
がtrueでなければ、診断情報が報告されることもあります。- パラメータ:
ignoreEncodingErrors
- trueの場合はエンコーディング・エラーを無視- 戻り値:
- 使用可能な場合はCharSequence、そうではない場合は
null
- 例外:
IllegalStateException
- このファイル・オブジェクトが、書込み可能かつ読取り不可である場合UnsupportedOperationException
- この種類のファイル・オブジェクトが文字アクセスをサポートしない場合IOException
- 入出力エラーが発生した場合
-
openWriter
Writer openWriter() throws IOExceptionこのファイル・オブジェクトのWriterを返します。- 戻り値:
- Writer
- 例外:
IllegalStateException
- このファイル・オブジェクトが、読取り可能かつ書込み不可である場合UnsupportedOperationException
- この種類のファイル・オブジェクトが文字アクセスをサポートしない場合IOException
- 入出力エラーが発生した場合
-
getLastModified
long getLastModified()このファイル・オブジェクトが最後に変更された時間を返します。 この時間は、元期(1970年1月1日0時0分0秒GMT)からミリ秒単位で測定されます。- 戻り値:
- このファイル・オブジェクトが最後に変更された時間。ファイル・オブジェクトが存在しない場合、入出力エラーが発生した場合、または操作がサポートされていない場合は0
-
delete
boolean delete()このファイル・オブジェクトを削除します。 エラーの場合はfalseを返します。- 戻り値:
- このファイル・オブジェクトが正常に削除された場合にかぎりtrue。そうでない場合はfalse
-