JavaTM Platform
Standard Ed. 6

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()
          このファイルオブジェクトの Writer を取得します。
 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 がある場合は、その CharSequence。そうでない場合は null
例外:
IllegalStateException - このファイルオブジェクトが、書き込み可能かつ読み取り不可である場合
UnsupportedOperationException - この種類のファイルオブジェクトが文字アクセスをサポートしない場合
IOException - 入出力エラーが発生した場合

openWriter

Writer openWriter()
                  throws IOException
このファイルオブジェクトの Writer を取得します。

戻り値:
Writer
例外:
IllegalStateException - このファイルオブジェクトが、読み取り可能かつ書き込み不可である場合
UnsupportedOperationException - この種類のファイルオブジェクトが文字アクセスをサポートしない場合
IOException - 入出力エラーが発生した場合

getLastModified

long getLastModified()
このファイルオブジェクトが最後に変更された時刻を取得します。この時刻は、1970 年 1 月 1 日 0 時 0 分 0 秒 (グリニッジ標準時) からミリ秒単位で測定されます。

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

delete

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

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

JavaTM Platform
Standard Ed. 6

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2009 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。