changeset 22686:2408f05d0ae7

Update javadoc for methodDataProfileDataSize
author Tom Rodriguez <tom.rodriguez@oracle.com>
date Thu, 15 Oct 2015 11:50:37 -0700
parents 3039e5bb94cb
children d43f6d932ad5
files jvmci/jdk.vm.ci.hotspot/src/jdk/vm/ci/hotspot/CompilerToVM.java
diffstat 1 files changed, 7 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/jvmci/jdk.vm.ci.hotspot/src/jdk/vm/ci/hotspot/CompilerToVM.java	Thu Oct 15 17:32:19 2015 +0200
+++ b/jvmci/jdk.vm.ci.hotspot/src/jdk/vm/ci/hotspot/CompilerToVM.java	Thu Oct 15 11:50:37 2015 -0700
@@ -589,10 +589,15 @@
     native HotSpotResolvedObjectTypeImpl getResolvedJavaType(Object base, long displacement, boolean compressed);
 
     /**
+     * Return the size of the HotSpot ProfileData* pointed at by {@code position}. If
+     * {@code position} is outside the space of the MethodData then an
+     * {@link IllegalArgumentException} is thrown. A {@code position} inside the MethodData but that
+     * isn't pointing at a valid ProfileData will crash the VM.
+     *
      * @param metaspaceMethodData
      * @param position
-     * @return Return the size of the ProfileData item pointed at by {@code current}. Throws
-     *         {@link IllegalArgumentException} if an invalid position is given.
+     * @return the size of the ProfileData item pointed at by {@code position}
+     * @throws IllegalArgumentException if an out of range position is given
      */
     native int methodDataProfileDataSize(long metaspaceMethodData, int position);
 }