Mercurial > hg > truffle
changeset 22106:3b2ae36a942f
Improving documentation of READ and WRITE Message
| author | Jaroslav Tulach <jaroslav.tulach@oracle.com> |
|---|---|
| date | Tue, 25 Aug 2015 09:38:50 +0200 |
| parents | 7ee578004be7 |
| children | 29126a670f9b 8b72dfac5cc7 |
| files | truffle/com.oracle.truffle.api.interop/src/com/oracle/truffle/api/interop/Message.java |
| diffstat | 1 files changed, 11 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/truffle/com.oracle.truffle.api.interop/src/com/oracle/truffle/api/interop/Message.java Mon Aug 24 09:07:43 2015 +0200 +++ b/truffle/com.oracle.truffle.api.interop/src/com/oracle/truffle/api/interop/Message.java Tue Aug 25 09:38:50 2015 +0200 @@ -34,7 +34,11 @@ */ public abstract class Message { /** - * Message to read a field. + * Message to read an object field. The + * {@link Factory#access(com.oracle.truffle.api.interop.Message) target} created for this + * message accepts single {@link ForeignAccess#getArguments(com.oracle.truffle.api.frame.Frame) + * argument} identifying a field to read - e.g. either {@link String} or an {@link Integer} - if + * access to an array at particular index is requested. */ public static final Message READ = Read.INSTANCE; @@ -46,7 +50,12 @@ public static final Message UNBOX = Unbox.INSTANCE; /** - * Message to write a field. + * Message to write a field. The {@link Factory#access(com.oracle.truffle.api.interop.Message) + * target} created for this message accepts two + * {@link ForeignAccess#getArguments(com.oracle.truffle.api.frame.Frame) arguments}. The first + * one identifies a field to read - e.g. either {@link String} or an {@link Integer} - if access + * to an array at particular index is requested. The second one is the value to assign to such + * field. */ public static Message WRITE = Write.INSTANCE;