diff graal/com.oracle.truffle.api/src/com/oracle/truffle/api/frame/VirtualFrame.java @ 7530:5e3d1a68664e

applied mx eclipseformat to all Java files
author Doug Simon <doug.simon@oracle.com>
date Wed, 23 Jan 2013 16:34:57 +0100
parents a4b84ba6dc2e
children 960a15fea39a
line wrap: on
line diff
--- a/graal/com.oracle.truffle.api/src/com/oracle/truffle/api/frame/VirtualFrame.java	Wed Jan 23 16:34:38 2013 +0100
+++ b/graal/com.oracle.truffle.api/src/com/oracle/truffle/api/frame/VirtualFrame.java	Wed Jan 23 16:34:57 2013 +0100
@@ -25,35 +25,38 @@
 import com.oracle.truffle.api.*;
 
 /**
- * Represents a frame containing values of local variables of the guest language. Instances of this type must not be
- * stored in a field or cast to {@link java.lang.Object}. If this is necessary, the frame must be explicitly converted
- * into a materialized frame using the {@link VirtualFrame#materialize()} method. Whenever fast access to the local
- * variables of a frame is no longer necessary, a virtual frame should be converted into a packed frame using the
+ * Represents a frame containing values of local variables of the guest language. Instances of this
+ * type must not be stored in a field or cast to {@link java.lang.Object}. If this is necessary, the
+ * frame must be explicitly converted into a materialized frame using the
+ * {@link VirtualFrame#materialize()} method. Whenever fast access to the local variables of a frame
+ * is no longer necessary, a virtual frame should be converted into a packed frame using the
  * {@link VirtualFrame#pack()} method.
  */
 public interface VirtualFrame extends Frame {
 
     /**
-     * Converts this virtual frame into a packed frame that has no longer direct access to the local variables. This
-     * packing is an important hint to the Truffle optimizer and therefore passing around a {@link PackedFrame} should
-     * be preferred over passing around a {@link VirtualFrame} when the probability that an unpacking will occur is low.
-     *
+     * Converts this virtual frame into a packed frame that has no longer direct access to the local
+     * variables. This packing is an important hint to the Truffle optimizer and therefore passing
+     * around a {@link PackedFrame} should be preferred over passing around a {@link VirtualFrame}
+     * when the probability that an unpacking will occur is low.
+     * 
      * @return the packed frame
      */
     PackedFrame pack();
 
     /**
-     * Accesses the caller frame passed in via {@link CallTarget#call}. To get full access, it must be first unpacked
-     * using {@link PackedFrame#unpack()}.
-     *
+     * Accesses the caller frame passed in via {@link CallTarget#call}. To get full access, it must
+     * be first unpacked using {@link PackedFrame#unpack()}.
+     * 
      * @return the caller frame or null if this was a root method call
      */
     PackedFrame getCaller();
 
     /**
-     * Materializes this frame, which allows it to be stored in a field or cast to {@link java.lang.Object}. The frame
-     * however looses the ability to be packed or to access the caller frame.
-     *
+     * Materializes this frame, which allows it to be stored in a field or cast to
+     * {@link java.lang.Object}. The frame however looses the ability to be packed or to access the
+     * caller frame.
+     * 
      * @return the new materialized frame
      */
     MaterializedFrame materialize();