Mercurial > hg > truffle

comparison truffle/com.oracle.truffle.api.dsl/src/com/oracle/truffle/api/dsl/TypeCheck.java @ 21951:9c8c0937da41

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Moving all sources into truffle subdirectory
author Jaroslav Tulach <jaroslav.tulach@oracle.com>
date Wed, 17 Jun 2015 10:58:08 +0200
parents graal/com.oracle.truffle.api.dsl/src/com/oracle/truffle/api/dsl/TypeCheck.java@3ea386a1036f
children dc83cc1f94f2
comparison
equal deleted inserted replaced
21950:2a5011c7e641 21951:9c8c0937da41
1 /*
2 * Copyright (c) 2012, 2012, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25 package com.oracle.truffle.api.dsl;
26
27 import java.lang.annotation.*;
28
29 /**
30 * Overrides the standard way of checking for a certain type in a {@link TypeSystem}. This is useful
31 * for types where the guest language specific type check can be implemented more efficiently than a
32 * direct cast. The annotated method must be contained in a {@link TypeSystem} annotated class. Type
33 * checks must conform to the following signature: <code>public static boolean is{TypeName}(Object
34 * value)</code>. The checked type must be a type declared in the {@link TypeSystem}.
35 *
36 * <p>
37 * If no {@link TypeCheck} is declared then the type system implicitly uses a type check that can be
38 * declared as follows:
39 *
40 * <pre>
41 * {@literal @}TypeCheck(Type.class)
42 * public static boolean isType(Object value) {
43 * return value instanceof Type;
44 * }
45 * </pre>
46 *
47 * @see TypeCast
48 */
49 @Retention(RetentionPolicy.CLASS)
50 @Target({ElementType.METHOD})
51 public @interface TypeCheck {
52
53 Class<?> value();
54
55 }