oracle.ide.util

Class AddinPolicyUtils

java.lang.Object

oracle.ide.util.AddinPolicyUtils

public class AddinPolicyUtils
extends java.lang.Object

A utility class containing addin policies we want to enforce. This class should not be used by extension developers outside Oracle. It is used to enforce performance policies that apply to functionality developed within Oracle.

Method Summary

Modifier and Type	Method and Description
static void	applicationExiting() This method only works in debug mode!
static void	checkCallStackForPolicyViolation(java.lang.String violationMethod, java.lang.String method) This method only works in debug mode! Check if we are called with a particular method on the stack.
static void	creatingAbstractButtonLeakPolicyCheck(javax.swing.AbstractButton abstractButton) This method only works in debug mode! Make certain we're avoiding a known memory leak cause.
static void	creatingImageIconPolicyCheck() This method only works in debug mode! Check if creating an ImageIcon is ok.
static void	creatingJMenuItemLeakPolicyCheck(javax.swing.JMenuItem menuItem, int commandID) This method only works in debug mode! Make certain we're avoiding a known memory leak cause.
static void	creatingLocalActionLeakPolicyCheck(javax.swing.Action action) This method only works in debug mode! Make certain we're avoiding a known memory leak cause.
static void	creatingThreadPolicyCheck() This method only works in debug mode! Check if creating a Thread is ok.
static void	ensureGarbageCollectable(java.lang.Object obj) This method only works in debug mode! Calls ensureGarbageCollectable(Object,int) with seconds set to 10.
static void	ensureGarbageCollectable(java.lang.Object obj, int seconds) This method only works in debug mode! Determines whether the given object is available for garbage collection within the given time bounds.
static void	initializingAddins(boolean initializing) This method only works in debug mode! Calls setWarnWhenCreatingImageIcons and setWarnWhenCreatingThreads and optionally checks that nobody is misusing them
static void	printWorkSpaceAccessDuringInitializationWarning() This method only works in debug mode! Print warning if Addin is accessing workspace during initialization.
static void	runRunnable(java.lang.Runnable runnable) This method only works in debug mode! A utility method to run code that is to be used only if the AddinPolicyUtils is in "effect"
static boolean	setWarnWhenCreatingImageIcons(boolean warn)
static boolean	setWarnWhenCreatingThreads(boolean warn)
static boolean	setWarnWhenLeakingJMenuItems(boolean warn)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

initializingAddins

public static void initializingAddins(boolean initializing)

This method only works in debug mode! Calls setWarnWhenCreatingImageIcons and setWarnWhenCreatingThreads and optionally checks that nobody is misusing them

Parameters:

initializing - If false, check for proper setting ot the flags

Throws:

java.lang.IllegalStateException - if the flags were mishandled

creatingImageIconPolicyCheck

public static void creatingImageIconPolicyCheck()

This method only works in debug mode! Check if creating an ImageIcon is ok.

creatingThreadPolicyCheck

public static void creatingThreadPolicyCheck()

This method only works in debug mode! Check if creating a Thread is ok.

creatingAbstractButtonLeakPolicyCheck

public static void creatingAbstractButtonLeakPolicyCheck(javax.swing.AbstractButton abstractButton)

This method only works in debug mode! Make certain we're avoiding a known memory leak cause. Debatably not a policy check.

creatingLocalActionLeakPolicyCheck

public static void creatingLocalActionLeakPolicyCheck(javax.swing.Action action)

This method only works in debug mode! Make certain we're avoiding a known memory leak cause. Debatably not a policy check.

creatingJMenuItemLeakPolicyCheck

public static void creatingJMenuItemLeakPolicyCheck(javax.swing.JMenuItem menuItem,
                                                    int commandID)

This method only works in debug mode! Make certain we're avoiding a known memory leak cause.

setWarnWhenCreatingThreads

public static boolean setWarnWhenCreatingThreads(boolean warn)

setWarnWhenCreatingImageIcons

public static boolean setWarnWhenCreatingImageIcons(boolean warn)

setWarnWhenLeakingJMenuItems

public static boolean setWarnWhenLeakingJMenuItems(boolean warn)

runRunnable

public static void runRunnable(java.lang.Runnable runnable)

This method only works in debug mode! A utility method to run code that is to be used only if the AddinPolicyUtils is in "effect"

Parameters:

runnable - The Runnable to run

applicationExiting

public static void applicationExiting()

This method only works in debug mode!

checkCallStackForPolicyViolation

public static void checkCallStackForPolicyViolation(java.lang.String violationMethod,
                                                    java.lang.String method)

This method only works in debug mode! Check if we are called with a particular method on the stack.

ensureGarbageCollectable

public static void ensureGarbageCollectable(java.lang.Object obj)

This method only works in debug mode! Calls ensureGarbageCollectable(Object,int) with seconds set to 10.

Parameters:

obj - Object to check

ensureGarbageCollectable

public static void ensureGarbageCollectable(java.lang.Object obj,
                                            int seconds)

This method only works in debug mode! Determines whether the given object is available for garbage collection within the given time bounds. This works by starting a thread that holds a weak reference to the object, and periodically checking if the reference is cleared (and calling System.gc(). If after seconds seconds the reference is still not cleared, an error message is printed to the console.

Parameters:

obj - The object to check

seconds - The number of seconds to wait around hoping for the object to be collected.

printWorkSpaceAccessDuringInitializationWarning

public static void printWorkSpaceAccessDuringInitializationWarning()

This method only works in debug mode! Print warning if Addin is accessing workspace during initialization.