comparison truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/TruffleLanguage.java @ 22384:2acc64b45848

Documentation for additional arguments
author Jaroslav Tulach <jaroslav.tulach@oracle.com>
date Thu, 19 Nov 2015 08:53:40 +0100
parents 37fabf84537a
children 086776aa7548
comparison
equal deleted inserted replaced
22383:37fabf84537a 22384:2acc64b45848
196 * preferred. Implicitly exported object of some name should only be used when there is no 196 * preferred. Implicitly exported object of some name should only be used when there is no
197 * explicit export under such <code>globalName</code>. To ensure so the infrastructure first 197 * explicit export under such <code>globalName</code>. To ensure so the infrastructure first
198 * asks all known languages for <code>onlyExplicit</code> symbols and only when none is found, 198 * asks all known languages for <code>onlyExplicit</code> symbols and only when none is found,
199 * it does one more round with <code>onlyExplicit</code> set to <code>false</code>. 199 * it does one more round with <code>onlyExplicit</code> set to <code>false</code>.
200 * 200 *
201 * @param context context to locate the global symbol in
201 * @param globalName the name of the global symbol to find 202 * @param globalName the name of the global symbol to find
202 * @param onlyExplicit should the language seek for implicitly exported object or only consider 203 * @param onlyExplicit should the language seek for implicitly exported object or only consider
203 * the explicitly exported ones? 204 * the explicitly exported ones?
204 * @return an exported object or <code>null</code>, if the symbol does not represent anything 205 * @return an exported object or <code>null</code>, if the symbol does not represent anything
205 * meaningful in this language 206 * meaningful in this language
211 * <p> 212 * <p>
212 * The object is expected to be <code>TruffleObject</code> (e.g. a native object from the other 213 * The object is expected to be <code>TruffleObject</code> (e.g. a native object from the other
213 * language) but technically it can be one of Java primitive wrappers ({@link Integer}, 214 * language) but technically it can be one of Java primitive wrappers ({@link Integer},
214 * {@link Double}, {@link Short}, etc.). 215 * {@link Double}, {@link Short}, etc.).
215 * 216 *
217 * @param context context to find the language global in
216 * @return the global object or <code>null</code> if the language does not support such concept 218 * @return the global object or <code>null</code> if the language does not support such concept
217 */ 219 */
218 protected abstract Object getLanguageGlobal(C context); 220 protected abstract Object getLanguageGlobal(C context);
219 221
220 /** 222 /**