Mercurial > hg > truffle

comparison truffle/com.oracle.truffle.api.interop/src/com/oracle/truffle/api/interop/Message.java @ 22106:3b2ae36a942f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Improving documentation of READ and WRITE Message
author Jaroslav Tulach <jaroslav.tulach@oracle.com>
date Tue, 25 Aug 2015 09:38:50 +0200
parents 9c8c0937da41
children f84a7663966d
comparison
equal deleted inserted replaced
22105:7ee578004be7 22106:3b2ae36a942f
32 * like {@link #IS_NULL} or factory methods in this class, but one can always define their own, 32 * like {@link #IS_NULL} or factory methods in this class, but one can always define their own,
33 * specialized messages. 33 * specialized messages.
34 */ 34 */
35 public abstract class Message { 35 public abstract class Message {
36 /** 36 /**
37 * Message to read a field. 37 * Message to read an object field. The
38 * {@link Factory#access(com.oracle.truffle.api.interop.Message) target} created for this
39 * message accepts single {@link ForeignAccess#getArguments(com.oracle.truffle.api.frame.Frame)
40 * argument} identifying a field to read - e.g. either {@link String} or an {@link Integer} - if
41 * access to an array at particular index is requested.
38 */ 42 */
39 public static final Message READ = Read.INSTANCE; 43 public static final Message READ = Read.INSTANCE;
40 44
41 /** 45 /**
42 * Converts {@link TruffleObject truffle value} to Java primitive type. Primitive types are 46 * Converts {@link TruffleObject truffle value} to Java primitive type. Primitive types are
44 * to {@link #IS_BOXED} message. 48 * to {@link #IS_BOXED} message.
45 */ 49 */
46 public static final Message UNBOX = Unbox.INSTANCE; 50 public static final Message UNBOX = Unbox.INSTANCE;
47 51
48 /** 52 /**
49 * Message to write a field. 53 * Message to write a field. The {@link Factory#access(com.oracle.truffle.api.interop.Message)
54 * target} created for this message accepts two
55 * {@link ForeignAccess#getArguments(com.oracle.truffle.api.frame.Frame) arguments}. The first
56 * one identifies a field to read - e.g. either {@link String} or an {@link Integer} - if access
57 * to an array at particular index is requested. The second one is the value to assign to such
58 * field.
50 */ 59 */
51 public static Message WRITE = Write.INSTANCE; 60 public static Message WRITE = Write.INSTANCE;
52 61
53 /** 62 /**
54 * Creates an execute message. All messages created by this method are 63 * Creates an execute message. All messages created by this method are