| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>JavaClass (Diagnostic Tool Framework for Java&trade;)</title> |
| <meta name="keywords" content="com.ibm.dtfj.java.JavaClass interface"> |
| <meta name="keywords" content="MODIFIERS_UNAVAILABLE"> |
| <meta name="keywords" content="getObject()"> |
| <meta name="keywords" content="getClassLoader()"> |
| <meta name="keywords" content="getName()"> |
| <meta name="keywords" content="getSuperclass()"> |
| <meta name="keywords" content="getInterfaces()"> |
| <meta name="keywords" content="getModifiers()"> |
| <meta name="keywords" content="isArray()"> |
| <meta name="keywords" content="getComponentType()"> |
| <meta name="keywords" content="getDeclaredFields()"> |
| <meta name="keywords" content="getDeclaredMethods()"> |
| <meta name="keywords" content="getConstantPoolReferences()"> |
| <meta name="keywords" content="getID()"> |
| <meta name="keywords" content="getReferences()"> |
| <meta name="keywords" content="equals()"> |
| <meta name="keywords" content="getInstanceSize()"> |
| <meta name="keywords" content="hashCode()"> |
| <meta name="keywords" content="getProtectionDomain()"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="JavaClass (Diagnostic Tool Framework for Java™)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/JavaClass.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><strong>Diagnostic Tool Framework for Java™</strong></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../com/ibm/dtfj/java/JavaClassLoader.html" title="interface in com.ibm.dtfj.java"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?com/ibm/dtfj/java/JavaClass.html" target="_top">Frames</a></li> |
| <li><a href="JavaClass.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">com.ibm.dtfj.java</div> |
| <h2 title="Interface JavaClass" class="title">Interface JavaClass</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">JavaClass</span></pre> |
| <div class="block">Represents a Java class.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/java/JavaClass.html#MODIFIERS_UNAVAILABLE">MODIFIERS_UNAVAILABLE</a></span></code> |
| <div class="block">MODIFIERS_UNAVAILABLE is returned by getModifiers() when the modifiers are unavailable.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/java/JavaClass.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" target="_blank" title="class or interface in java.lang">Object</a> obj)</code> |
| <div class="block">Compares the argument to the receiver, and answers true |
| if they represent the <em>same</em> object using a class |
| specific comparison.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../com/ibm/dtfj/java/JavaClassLoader.html" title="interface in com.ibm.dtfj.java">JavaClassLoader</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/java/JavaClass.html#getClassLoader--">getClassLoader</a></span>()</code> |
| <div class="block">Fetch the class loader associated with this class.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../com/ibm/dtfj/java/JavaClass.html" title="interface in com.ibm.dtfj.java">JavaClass</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/java/JavaClass.html#getComponentType--">getComponentType</a></span>()</code> |
| <div class="block">For array classes, returns a JavaClass representing the component type of this array class.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" target="_blank" title="class or interface in java.util">Iterator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/java/JavaClass.html#getConstantPoolReferences--">getConstantPoolReferences</a></span>()</code> |
| <div class="block">Java classes may refer to other classes and to String objects via |
| the class's constant pool.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" target="_blank" title="class or interface in java.util">Iterator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/java/JavaClass.html#getDeclaredFields--">getDeclaredFields</a></span>()</code> |
| <div class="block">Get the set of fields declared in this class.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" target="_blank" title="class or interface in java.util">Iterator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/java/JavaClass.html#getDeclaredMethods--">getDeclaredMethods</a></span>()</code> |
| <div class="block">Get the set of methods declared in this class.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../com/ibm/dtfj/image/ImagePointer.html" title="interface in com.ibm.dtfj.image">ImagePointer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/java/JavaClass.html#getID--">getID</a></span>()</code> |
| <div class="block">The ID of a class is a pointer to a section of memory which identifies |
| the class.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/java/JavaClass.html#getInstanceSize--">getInstanceSize</a></span>()</code> |
| <div class="block">Returns the size in bytes of an instance of this class on the heap.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" target="_blank" title="class or interface in java.util">Iterator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/java/JavaClass.html#getInterfaces--">getInterfaces</a></span>()</code> |
| <div class="block">Get the set of names of interfaces directly implemented by this class.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/java/JavaClass.html#getModifiers--">getModifiers</a></span>()</code> |
| <div class="block">Return the Java language modifiers for this class.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/java/JavaClass.html#getName--">getName</a></span>()</code> |
| <div class="block">Get the name of the class.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../com/ibm/dtfj/java/JavaObject.html" title="interface in com.ibm.dtfj.java">JavaObject</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/java/JavaClass.html#getObject--">getObject</a></span>()</code> |
| <div class="block">Fetch the java.lang.Class object associated with this class.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../com/ibm/dtfj/java/JavaObject.html" title="interface in com.ibm.dtfj.java">JavaObject</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/java/JavaClass.html#getProtectionDomain--">getProtectionDomain</a></span>()</code> |
| <div class="block">Returns the protection domain for this class.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" target="_blank" title="class or interface in java.util">Iterator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/java/JavaClass.html#getReferences--">getReferences</a></span>()</code> |
| <div class="block">Get the set of references from this class.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../com/ibm/dtfj/java/JavaClass.html" title="interface in com.ibm.dtfj.java">JavaClass</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/java/JavaClass.html#getSuperclass--">getSuperclass</a></span>()</code> |
| <div class="block">Get the immediate superclass of this class.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/java/JavaClass.html#hashCode--">hashCode</a></span>()</code> |
| <div class="block">Answers an integer hash code for the receiver.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/dtfj/java/JavaClass.html#isArray--">isArray</a></span>()</code> |
| <div class="block">Is this an array class ?</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="MODIFIERS_UNAVAILABLE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>MODIFIERS_UNAVAILABLE</h4> |
| <pre>static final int MODIFIERS_UNAVAILABLE</pre> |
| <div class="block">MODIFIERS_UNAVAILABLE is returned by getModifiers() when the modifiers are unavailable. |
| The value 0xff000000 is chosen as it is a value that can never return true to any of the java.reflect.Modifier methods |
| that test the modifier: isNative(), isPublic(), etc. while at the same time not being 0 which is a possible value |
| when no modifier at all is present i.e. "default". |
| |
| All other values for the modifier returned are defined in java.lang.reflect.Modifiers</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Modifier.html?is-external=true" target="_blank" title="class or interface in java.lang.reflect"><code>Modifier</code></a>, |
| <a href="../../../../constant-values.html#com.ibm.dtfj.java.JavaClass.MODIFIERS_UNAVAILABLE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getObject--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObject</h4> |
| <pre><a href="../../../../com/ibm/dtfj/java/JavaObject.html" title="interface in com.ibm.dtfj.java">JavaObject</a> getObject() |
| throws <a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre> |
| <div class="block">Fetch the java.lang.Class object associated with this class. |
| <p> |
| In some implementations this may be null if no object has been |
| created to represent this class, or if the class is synthetic.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the java.lang.Class object associated with this class</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../com/ibm/dtfj/java/JavaClass.html#getID--"><code>getID()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClassLoader--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClassLoader</h4> |
| <pre><a href="../../../../com/ibm/dtfj/java/JavaClassLoader.html" title="interface in com.ibm.dtfj.java">JavaClassLoader</a> getClassLoader() |
| throws <a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre> |
| <div class="block">Fetch the class loader associated with this class. Classes defined in |
| the bootstrap class loader (including classes representing primitive |
| types or void) will always return a JavaClassLoader representing the |
| bootstrap class loader. This asymmetry with |
| java.lang.Class#getClassLoader() is intentional.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the JavaClassLoader in which this class was defined</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code> - if the class loader for this class cannot |
| be found (a class cannot exist without a loader so this implies corruption)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a> getName() |
| throws <a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre> |
| <div class="block">Get the name of the class.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name of the class in the form: "full/package/class$innerclass"</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSuperclass--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSuperclass</h4> |
| <pre><a href="../../../../com/ibm/dtfj/java/JavaClass.html" title="interface in com.ibm.dtfj.java">JavaClass</a> getSuperclass() |
| throws <a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre> |
| <div class="block">Get the immediate superclass of this class.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the immediate superclass of this class, or null if this |
| class has no superclass. For interfaces, Object, primitive types |
| and void null is always returned.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInterfaces--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInterfaces</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" target="_blank" title="class or interface in java.util">Iterator</a> getInterfaces()</pre> |
| <div class="block">Get the set of names of interfaces directly implemented by this class.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an iterator over the collection of the names of interfaces |
| directly implemented by this class. Some JVM implementations may |
| choose to load interfaces lazily, so only the names are returned. |
| The JavaClass objects may be found through the defining class loader.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang"><code>String</code></a>, |
| <a href="../../../../com/ibm/dtfj/java/JavaClassLoader.html#findClass-java.lang.String-"><code>JavaClassLoader.findClass(String)</code></a>, |
| <a href="../../../../com/ibm/dtfj/image/CorruptData.html" title="interface in com.ibm.dtfj.image"><code>CorruptData</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getModifiers--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getModifiers</h4> |
| <pre>int getModifiers() |
| throws <a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre> |
| <div class="block">Return the Java language modifiers for this class. |
| <p> |
| The modifiers are defined by the JVM Specification. |
| <p> |
| Return MODIFIERS_UNAVAILABLE if the modifiers are unavailable. |
| This might be the case if DTFJ is operating against an artefact such as a portable heap dump that does not contain |
| information about a class's modifiers. |
| <p> |
| Note that, for inner classes, the actual modifiers are returned, not |
| the synthetic modifiers. For instance, a class will never have its |
| 'protected' modifier set, even if the inner class was a protected |
| member, since 'protected' is not a legal modifier for a class file.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the modifiers for this class</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isArray--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isArray</h4> |
| <pre>boolean isArray() |
| throws <a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre> |
| <div class="block">Is this an array class ?</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if this class is an array class</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getComponentType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComponentType</h4> |
| <pre><a href="../../../../com/ibm/dtfj/java/JavaClass.html" title="interface in com.ibm.dtfj.java">JavaClass</a> getComponentType() |
| throws <a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre> |
| <div class="block">For array classes, returns a JavaClass representing the component type of this array class.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a JavaClass representing the component type of this array class</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" target="_blank" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this JavaClass does not represent an array class</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDeclaredFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredFields</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" target="_blank" title="class or interface in java.util">Iterator</a> getDeclaredFields()</pre> |
| <div class="block">Get the set of fields declared in this class.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an iterator over the collection of fields declared |
| in this class.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../com/ibm/dtfj/java/JavaField.html" title="interface in com.ibm.dtfj.java"><code>JavaField</code></a>, |
| <a href="../../../../com/ibm/dtfj/image/CorruptData.html" title="interface in com.ibm.dtfj.image"><code>CorruptData</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDeclaredMethods--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredMethods</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" target="_blank" title="class or interface in java.util">Iterator</a> getDeclaredMethods()</pre> |
| <div class="block">Get the set of methods declared in this class.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an iterator over the collection of methods declared |
| in this class.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../com/ibm/dtfj/java/JavaMethod.html" title="interface in com.ibm.dtfj.java"><code>JavaMethod</code></a>, |
| <a href="../../../../com/ibm/dtfj/image/CorruptData.html" title="interface in com.ibm.dtfj.image"><code>CorruptData</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConstantPoolReferences--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConstantPoolReferences</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" target="_blank" title="class or interface in java.util">Iterator</a> getConstantPoolReferences()</pre> |
| <div class="block">Java classes may refer to other classes and to String objects via |
| the class's constant pool. These references are followed by the |
| garbage collector, forming edges on the graph of reachable objects. |
| This getConstantPoolReferences() may be used to determine which |
| objects are referred to by the receiver's constant pool. |
| <p> |
| Although Java VMs typically permit only Class and String |
| objects in the constant pool, some esoteric or future virtual |
| machines may permit other types of objects to occur in the constant |
| pool. This API imposes no restrictions on the types of JavaObjects |
| which might be included in the Iterator. |
| <p> |
| No assumption should be made about the order in which constant |
| pool references are returned. |
| <p> |
| Classes may also refer to objects through static variables. |
| These may be found with the getDeclaredFields() API. Objects |
| referenced by static variables are not returned by |
| getConstantPoolReferences() unless the object is also referenced |
| by the constant pool.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an iterator over the collection of JavaObjects which |
| are referred to by the constant pool of this class</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../com/ibm/dtfj/java/JavaObject.html" title="interface in com.ibm.dtfj.java"><code>JavaObject</code></a>, |
| <a href="../../../../com/ibm/dtfj/image/CorruptData.html" title="interface in com.ibm.dtfj.image"><code>CorruptData</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getID--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getID</h4> |
| <pre><a href="../../../../com/ibm/dtfj/image/ImagePointer.html" title="interface in com.ibm.dtfj.image">ImagePointer</a> getID()</pre> |
| <div class="block">The ID of a class is a pointer to a section of memory which identifies |
| the class. The contents of this memory are implementation defined. |
| <p> |
| In some implementations getID() and getObject().getID() may return the |
| same value. This implies that the class object is also the primary |
| internal representation of the class. DTFJ users should not rely on this |
| behaviour. |
| <p> |
| In some implementations, getID() may return null for some classes. |
| This indicates that the class is a synthetic class which has been |
| constructed for DTFJ purposes only. The class has no physical |
| representation in the VM.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a pointer to the class</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReferences--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReferences</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" target="_blank" title="class or interface in java.util">Iterator</a> getReferences()</pre> |
| <div class="block">Get the set of references from this class.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an iterator of JavaReferences</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../com/ibm/dtfj/java/JavaReference.html" title="interface in com.ibm.dtfj.java"><code>JavaReference</code></a>, |
| <a href="../../../../com/ibm/dtfj/image/CorruptData.html" title="interface in com.ibm.dtfj.image"><code>CorruptData</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="equals-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>boolean equals(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" target="_blank" title="class or interface in java.lang">Object</a> obj)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">java.lang.Object</a></code></span></div> |
| <div class="block">Compares the argument to the receiver, and answers true |
| if they represent the <em>same</em> object using a class |
| specific comparison. The implementation in Object answers |
| true only if the argument is the exact same object as the |
| receiver (==).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" target="_blank" title="class or interface in java.lang">Object</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>obj</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if the given object refers to the same Java Class in the image</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang"><code>Object.hashCode()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInstanceSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInstanceSize</h4> |
| <pre>long getInstanceSize() |
| throws <a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>, |
| <a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre> |
| <div class="block">Returns the size in bytes of an instance of this class on the heap. |
| <p> |
| The call is only meaningful for a non-array JavaClass, where all instances of the |
| class are of the same size. If this method is called on a JavaArrayClass, where instances |
| can be of different sizes, an UnsupportedOperationException will be thrown. |
| DataUnavailable can be thrown if no value is available: for example when |
| DTFJ is examining a javacore, where the instance size for a class is not recorded.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>size in bytes of an instance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></dd> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" target="_blank" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the JavaClass is an instance of JavaArrayClass</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hashCode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>int hashCode()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">java.lang.Object</a></code></span></div> |
| <div class="block">Answers an integer hash code for the receiver. Any two |
| objects which answer <code>true</code> when passed to |
| <code>.equals</code> must answer the same value for this |
| method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" target="_blank" title="class or interface in java.lang">Object</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the receiver's hash.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang"><code>Object.equals(java.lang.Object)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProtectionDomain--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getProtectionDomain</h4> |
| <pre><a href="../../../../com/ibm/dtfj/java/JavaObject.html" title="interface in com.ibm.dtfj.java">JavaObject</a> getProtectionDomain() |
| throws <a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a>, |
| <a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></pre> |
| <div class="block">Returns the protection domain for this class.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the protection domain or null for the default protection domain</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/DataUnavailable.html" title="class in com.ibm.dtfj.image">DataUnavailable</a></code></dd> |
| <dd><code><a href="../../../../com/ibm/dtfj/image/CorruptDataException.html" title="class in com.ibm.dtfj.image">CorruptDataException</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.9</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/JavaClass.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><strong>Diagnostic Tool Framework for Java™</strong></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../com/ibm/dtfj/java/JavaClassLoader.html" title="interface in com.ibm.dtfj.java"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?com/ibm/dtfj/java/JavaClass.html" target="_top">Frames</a></li> |
| <li><a href="JavaClass.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse OpenJ9 issue.</a><br> Copyright © 2004, 2021, IBM Corp. and others.</small></p> |
| </body> |
| </html> |