Mercurial > hg > graal-compiler
view graal/com.oracle.truffle.api/src/com/oracle/truffle/api/utilities/ValueProfile.java @ 19703:27fe86a6fb49
Truffle/Instrumentation: Javadoc
author | Michael Van De Vanter <michael.van.de.vanter@oracle.com> |
---|---|
date | Wed, 04 Mar 2015 16:28:05 -0800 |
parents | 1cde96b96673 |
children | f7b3b0c5c3e5 |
line wrap: on
line source
/* * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package com.oracle.truffle.api.utilities; /** * Utility class to speculate on certain properties of values. * * Example usage: * * <pre> * private final ValueProfile classProfile = ValueProfile.createClassProfile(); * * return classProfile.profile(value); * </pre> * * All instances of {@code ValueProfile} (and subclasses) must be held in {@code final} fields for * compiler optimizations to take effect. * * @see #createPrimitiveProfile() * @see #createIdentityProfile() * @see #createClassProfile() */ public abstract class ValueProfile { public abstract <T> T profile(T value); /** * Returns a {@link PrimitiveValueProfile} that speculates on the primitive equality or object * identity of a value. */ public static PrimitiveValueProfile createPrimitiveProfile() { return new PrimitiveValueProfile(); } /** * Returns a {@link ValueProfile} that speculates on the exact class of a value. */ public static ValueProfile createClassProfile() { return new ExactClassValueProfile(); } /** * Returns a {@link ValueProfile} that speculates on the object identity of a value. */ public static ValueProfile createIdentityProfile() { return new IdentityValueProfile(); } }