Java Debug Interface

com.sun.jdi
インタフェース LocalVariable

すべてのスーパーインタフェース:
Comparable<LocalVariable>, Mirror

public interface LocalVariable
extends Mirror, Comparable<LocalVariable>

ターゲット VM 内のローカル変数です。Method 内で宣言された各変数は、独自の LocalVariable オブジェクトを保持します。異なるスコープで宣言された同名の変数は、異なる LocalVariable オブジェクトを保持します。LocalVariable は、その宣言に関する静的な情報を取得するために単独で使うこともできますし、値を設定および取得するために StackFrame と組み合わせて使うこともできます。

導入されたバージョン:
1.3
関連項目:
StackFrame, Method

メソッドの概要
 boolean equals(Object obj)
          指定されたオブジェクトがこの LocalVariable と等しいかどうか比較します。
 String genericSignature()
          存在する場合はこの変数の総称シグニチャーを取得します。
 int hashCode()
          この LocalVariable 用のハッシュコード値を返します。
 boolean isArgument()
          この変数がそのメソッドへの引数かどうかを判定します。
 boolean isVisible(StackFrame frame)
          この変数が、指定された StackFrame からアクセス可能かどうかを判定します。
 String name()
          ローカル変数の名前を取得します。
 String signature()
          ローカル変数の JNI シグニチャーを取得します。
 Type type()
          このローカル変数の宣言時に指定された型を返します。
 String typeName()
          このローカル変数の宣言時に指定された型のテキスト表現を返します。
 
インタフェース com.sun.jdi.Mirror から継承されたメソッド
toString, virtualMachine
 
インタフェース java.lang.Comparable から継承されたメソッド
compareTo
 

メソッドの詳細

name

String name()
ローカル変数の名前を取得します。

戻り値:
名前を含む文字列。

typeName

String typeName()
このローカル変数の宣言時に指定された型のテキスト表現を返します。このローカル変数の宣言時に指定された型を返します。

この型名は、型がまだ作成またはロードされていない場合でも利用可能です。

戻り値:
このローカル変数の型を表す String。

type

Type type()
          throws ClassNotLoadedException
このローカル変数の宣言時に指定された型を返します。このローカル変数の宣言時に指定された型を返します。

注:この変数の型が参照型 (クラス、インタフェース、または配列) であり、囲むクラスのクラスローダーによって作成またはロードされていない場合、ClassNotLoadedException がスローされます。 また、参照型の場合、ロードされていても準備が整っていない場合があります。また、参照型の場合、ロードされていても準備が整っていない場合があります。この場合、型は返されますが、ロードされた型に対して fields() などの操作を実行しようとすると、ClassNotPreparedException がスローされます。参照型の準備ができているかどうかを確認するには、ReferenceType.isPrepared() を使用します。

戻り値:
このローカル変数の Type
例外:
ClassNotLoadedException - 適切なクラスローダーによる型のロードがまだ行われていない場合。
関連項目:
Type, Field.type() - for usage examples

signature

String signature()
ローカル変数の JNI シグニチャーを取得します。

戻り値:
シグニチャーを含む文字列。
関連項目:
型のシグニチャー

genericSignature

String genericSignature()
存在する場合はこの変数の総称シグニチャーを取得します。総称シグニチャーについては、 「JavaTM 仮想マシン仕様、第 3 版」を参照してください。

戻り値:
総称シグニチャーを含む文字列、総称シグニチャーが存在しない場合は null
導入されたバージョン:
1.5

isVisible

boolean isVisible(StackFrame frame)
この変数が、指定された StackFrame からアクセス可能かどうかを判定します。 このインタフェース内の変数の可視性の詳細は、StackFrame.visibleVariables() を参照してください。

パラメータ:
frame - 可視性を問い合わせる StackFrame
戻り値:
この変数が可視の場合は true、それ以外の場合は false
例外:
IllegalArgumentException - スタックフレームのメソッドがこの変数のメソッドと一致しない場合。

isArgument

boolean isArgument()
この変数がそのメソッドへの引数かどうかを判定します。

戻り値:
この変数が引数の場合は true、それ以外の場合は false

equals

boolean equals(Object obj)
指定されたオブジェクトがこの LocalVariable と等しいかどうか比較します。

オーバーライド:
クラス Object 内の equals
パラメータ:
obj - the reference object with which to compare.
戻り値:
Object が LocalVariable である場合、両方の LocalVariable が同じメソッドに含まれる場合 (Method.equals(java.lang.Object) によって判定される)、および両方の LocalVariable がそのメソッド内の同じ宣言をミラー化する場合は true
関連項目:
Object.hashCode(), Hashtable

hashCode

int hashCode()
この LocalVariable 用のハッシュコード値を返します。

オーバーライド:
クラス Object 内の hashCode
戻り値:
整数のハッシュコード
関連項目:
Object.equals(java.lang.Object), Hashtable

Java Debug Interface