Mercurial > hg > graal-compiler
diff graal/com.oracle.truffle.api.codegen/src/com/oracle/truffle/api/codegen/TypeCheck.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 | 2232848be438 |
children |
line wrap: on
line diff
--- a/graal/com.oracle.truffle.api.codegen/src/com/oracle/truffle/api/codegen/TypeCheck.java Wed Jan 23 16:34:38 2013 +0100 +++ b/graal/com.oracle.truffle.api.codegen/src/com/oracle/truffle/api/codegen/TypeCheck.java Wed Jan 23 16:34:57 2013 +0100 @@ -26,51 +26,52 @@ /** * <p> - * Provides a way to define a custom type check for a defined type. The name of the annotated method must fit to the - * pattern is${typeName} (eg. isInteger), where ${typeName} must be a valid type defined in the parent - * {@link TypeSystem}. The annotated method must have exactly one argument where the type of the argument is the generic - * type {@link Object} or a more specific one from the {@link TypeSystem}. You can define multiple overloaded - * {@link TypeCheck} methods for the same type. This can be used to reduce the boxing overhead in type conversions. + * Provides a way to define a custom type check for a defined type. The name of the annotated method + * must fit to the pattern is${typeName} (eg. isInteger), where ${typeName} must be a valid type + * defined in the parent {@link TypeSystem}. The annotated method must have exactly one argument + * where the type of the argument is the generic type {@link Object} or a more specific one from the + * {@link TypeSystem}. You can define multiple overloaded {@link TypeCheck} methods for the same + * type. This can be used to reduce the boxing overhead in type conversions. * </p> - * + * * <p> - * By default the system generates type checks for all types in the parent {@link TypeSystem} which look like the - * follows: - * + * By default the system generates type checks for all types in the parent {@link TypeSystem} which + * look like the follows: + * * <pre> * {@literal @}TypeCheck * boolean is${typeName}(Object value) { * return value instanceof ${typeName}; * } * </pre> - * + * * </p> - * + * * <b>Example:</b> * <p> * A type check for BigInteger with one overloaded optimized variant to reduce boxing. * </p> - * + * * <pre> - * - * + * + * * {@literal @}TypeSystem(types = {int.class, BigInteger.class, String.class}, nodeBaseClass = TypedNode.class) * public abstract class Types { - * + * * {@literal @}TypeCheck * public boolean isBigInteger(Object value) { * return value instanceof Integer || value instanceof BigInteger; * } - * + * * {@literal @}TypeCheck * public boolean isBigInteger(int value) { * return true; * } - * + * * } * </pre> - * - * + * + * */ @Retention(RetentionPolicy.CLASS) @Target({ElementType.METHOD})