java.util.Tripwire Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dragome-js-jre Show documentation

Dragome SDK module: js-jre

There is a newer version: 0.96-beta4

/*
 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
 * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */
package java.util;


/**
 * Utility class for detecting inadvertent uses of boxing in
 * {@code java.util} classes.  The detection is turned on or off based on
 * whether the system property {@code org.openjdk.java.util.stream.tripwire} is
 * considered {@code true} according to {@link Boolean#getBoolean(String)}.
 * This should normally be turned off for production use.
 *
 * @apiNote
 * Typical usage would be for boxing code to do:
 * {@code
 *     if (Tripwire.ENABLED)
 *         Tripwire.trip(getClass(), "{0} calling PrimitiveIterator.OfInt.nextInt()");
 * }
 *
 * @since 1.8
 */
final public class Tripwire
{
	private static final String TRIPWIRE_PROPERTY= "org.openjdk.java.util.stream.tripwire";

	/** Should debugging checks be enabled? */
	static public final boolean ENABLED= false;

	private Tripwire()
	{
	}

	/**
	 * Produces a log warning, using {@code PlatformLogger.getLogger(className)},
	 * using the supplied message.  The class name of {@code trippingClass} will
	 * be used as the first parameter to the message.
	 *
	 * @param trippingClass Name of the class generating the message
	 * @param msg A message format string of the type expected by
	 * {@link PlatformLogger}
	 */
	public static void trip(Class trippingClass, String msg)
	{
	}
}