javax.tools
クラス SimpleJavaFileObject

java.lang.Object
  javax.tools.SimpleJavaFileObject

すべての実装されたインタフェース:

FileObject, JavaFileObject

public class SimpleJavaFileObject
extends Object
implements JavaFileObject

JavaFileObject に含まれる大部分のメソッドに対して、簡単な実装を提供します。このクラスは、サブクラス化し、JavaFileObject 実装の基礎として使用されるように設計されています。サブクラスは、JavaFileObject の一般規約に準拠しているかぎりは、このクラスのすべてのメソッドの実装および仕様をオーバーライドできます。

導入されたバージョン:

1.6

入れ子のクラスの概要

インタフェース javax.tools.JavaFileObject から継承された入れ子のクラス/インタフェース

JavaFileObject.Kind

フィールドの概要

protected JavaFileObject.Kind	kind このファイルオブジェクトの種類です。
protected URI	uri このファイルオブジェクトの URI です。

コンストラクタの概要

protected

SimpleJavaFileObject(URI uri, JavaFileObject.Kind kind) 指定された URI を使って、指定された種類の SimpleJavaFileObject を構築します。

メソッドの概要

boolean	delete() この実装は処理を行いません。
Modifier	getAccessLevel() この実装は、null を返します。
CharSequence	getCharContent(boolean ignoreEncodingErrors) この実装は、常に UnsupportedOperationException をスローします。
JavaFileObject.Kind	getKind() このファイルオブジェクトの種類を取得します。
long	getLastModified() この実装は、0L を返します。
String	getName() このファイルオブジェクトを示す、ユーザーが使いやすい名前を取得します。
NestingKind	getNestingKind() この実装は、null を返します。
boolean	isNameCompatible(String simpleName, JavaFileObject.Kind kind) この実装は、URI のパスと指定された単純名を比較します。
InputStream	openInputStream() この実装は、常に UnsupportedOperationException をスローします。
OutputStream	openOutputStream() この実装は、常に UnsupportedOperationException をスローします。
Reader	openReader(boolean ignoreEncodingErrors) getCharContent(boolean) の結果を Reader 内にラップします。
Writer	openWriter() openOutputStream の結果を Writer 内にラップします。
String	toString() オブジェクトの文字列表現を返します。
URI	toUri() このファイルオブジェクトを識別する URI を返します。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

フィールドの詳細

uri

protected final URI uri

このファイルオブジェクトの URI です。

kind

protected final JavaFileObject.Kind kind

このファイルオブジェクトの種類です。

コンストラクタの詳細

SimpleJavaFileObject

protected SimpleJavaFileObject(URI uri,
                               JavaFileObject.Kind kind)

指定された URI を使って、指定された種類の SimpleJavaFileObject を構築します。

パラメータ:

uri - このファイルオブジェクトの URI

kind - このファイルオブジェクトの種類

メソッドの詳細

toUri

public URI toUri()

インタフェース FileObject の記述:

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

定義:

インタフェース FileObject 内の toUri

戻り値:

URI

getName

public String getName()

インタフェース FileObject の記述:

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

定義:

インタフェース FileObject 内の getName

戻り値:

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

openInputStream

public InputStream openInputStream()
                            throws IOException

この実装は、常に UnsupportedOperationException をスローします。サブクラスは、FileObject の規約に準拠しているかぎりは、この動作を変更できます。

定義:

インタフェース FileObject 内の openInputStream

戻り値:

InputStream

例外:

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

openOutputStream

public OutputStream openOutputStream()
                              throws IOException

この実装は、常に UnsupportedOperationException をスローします。サブクラスは、FileObject の規約に準拠しているかぎりは、この動作を変更できます。

定義:

インタフェース FileObject 内の openOutputStream

戻り値:

OutputStream

例外:

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

openReader

public Reader openReader(boolean ignoreEncodingErrors)
                  throws IOException

getCharContent(boolean) の結果を Reader 内にラップします。サブクラスは、FileObject の規約に準拠しているかぎりは、この動作を変更できます。

定義:

インタフェース FileObject 内の openReader

パラメータ:

ignoreEncodingErrors - true の場合は符号化エラーを無視

戻り値:

getCharContent の結果をラップする Reader

例外:

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

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

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

getCharContent

public CharSequence getCharContent(boolean ignoreEncodingErrors)
                            throws IOException

この実装は、常に UnsupportedOperationException をスローします。サブクラスは、FileObject の規約に準拠しているかぎりは、この動作を変更できます。

定義:

インタフェース FileObject 内の getCharContent

パラメータ:

ignoreEncodingErrors - true の場合は符号化エラーを無視

戻り値:

利用可能な CharSequence がある場合は、その CharSequence。そうでない場合は null

例外:

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

openWriter

public Writer openWriter()
                  throws IOException

openOutputStream の結果を Writer 内にラップします。サブクラスは、FileObject の規約に準拠しているかぎりは、この動作を変更できます。

定義:

インタフェース FileObject 内の openWriter

戻り値:

openOutputStream の結果をラップする Writer

例外:

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

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

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

getLastModified

public long getLastModified()

この実装は、0L を返します。サブクラスは、FileObject の規約に準拠しているかぎりは、この動作を変更できます。

定義:

インタフェース FileObject 内の getLastModified

戻り値:

0L

delete

public boolean delete()

この実装は処理を行いません。サブクラスは、FileObject の規約に準拠しているかぎりは、この動作を変更できます。

定義:

インタフェース FileObject 内の delete

戻り値:

false

getKind

public JavaFileObject.Kind getKind()

インタフェース JavaFileObject の記述:

このファイルオブジェクトの種類を取得します。

定義:

インタフェース JavaFileObject 内の getKind

戻り値:

this.kind

isNameCompatible

public boolean isNameCompatible(String simpleName,
                                JavaFileObject.Kind kind)

この実装は、URI のパスと指定された単純名を比較します。このメソッドは、指定された種類とこのオブジェクトの種類が等しい場合、パスが simpleName + kind.extension である場合、またはパスが "/" + simpleName + kind.extension で終わる場合に true を返します。

このメソッドは、uri フィールドと kind フィールドに直接アクセスする代わりに、getKind() と toUri() を呼び出します。

サブクラスは、JavaFileObject の規約に準拠しているかぎりは、この動作を変更できます。

定義:

インタフェース JavaFileObject 内の isNameCompatible

パラメータ:

simpleName - クラスの単純名

kind - 種類

戻り値:

ファイルオブジェクトに互換性がある場合は true、そうでない場合は false

getNestingKind

public NestingKind getNestingKind()

この実装は、null を返します。サブクラスは、JavaFileObject の規約に準拠しているかぎりは、この動作を変更できます。

定義:

インタフェース JavaFileObject 内の getNestingKind

戻り値:

入れ子の種類。入れ子の種類が未知である場合は null

getAccessLevel

public Modifier getAccessLevel()

この実装は、null を返します。サブクラスは、JavaFileObject の規約に準拠しているかぎりは、この動作を変更できます。

定義:

インタフェース JavaFileObject 内の getAccessLevel

戻り値:

アクセスレベル

toString

public String toString()

クラス Object の記述:

オブジェクトの文字列表現を返します。通常、toString メソッドはこのオブジェクトを「テキストで表現する」文字列を返します。この結果は、人間が読める簡潔で有益な情報であるべきです。すべてのサブクラスで、このメソッドをオーバーライドすることをお勧めします。

Object クラスの toString メソッドは、オブジェクトの派生元のクラス名、アットマーク (@)、およびオブジェクトのハッシュコードの符号なし 16 進表現から構成される文字列を返します。つまり、このメソッドは次の値と等しい文字列を返します。

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

オーバーライド:

クラス Object 内の toString

戻り値:

このオブジェクトの文字列表現