org.assertj.swing.edt.FailOnThreadViolationRepaintManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of assertj-swing Show documentation
Fluent interface for functional GUI testing
There is a newer version: 3.17.1
/**
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 *
 * Copyright 2012-2015 the original author or authors.
 */
package org.assertj.swing.edt;

import static org.fest.reflect.core.Reflection.method;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.swing.JComponent;
import javax.swing.RepaintManager;
import javax.swing.SwingUtilities;

import org.assertj.swing.exception.EdtViolationException;

/**
 * 
 * Fails a test when a Event Dispatch Thread rule violation is detected. See How to Use Threads for more information.
 * 
 *
 * @author Alex Ruiz
 */
public class FailOnThreadViolationRepaintManager extends CheckThreadViolationRepaintManager {
  /** the {@link RepaintManager} that was installed before {@link #install()} has been called. */
  private static RepaintManager previousRepaintManager;

  /**
   * 
   * Creates a new {@link FailOnThreadViolationRepaintManager} and sets it as the current repaint manager.
   * 
   *
   * 
   * On Sun JVMs, this method will install the new repaint manager the first time only. Once installed, subsequent calls
   * to this method will not install new repaint managers. This optimization may not work on non-Sun JVMs, since we use
   * reflection to check if a {@code CheckThreadViolationRepaintManager} is already installed.
   * 
   *
   * @return the created (and installed) repaint manager.
   * @see #uninstall()
   * @see RepaintManager#setCurrentManager(RepaintManager)
   */
  public static @Nonnull FailOnThreadViolationRepaintManager install() {
    Object m = currentRepaintManager();
    if (m instanceof FailOnThreadViolationRepaintManager) {
      return (FailOnThreadViolationRepaintManager) m;
    }
    return installNew();
  }

  /**
   * 
   * Tries to restore the repaint manager before installing the {@link FailOnThreadViolationRepaintManager} via
   * {@link #install()}.
   * 
   * 
   * @return the restored (and installed) repaint manager.
   * @see #install()
   * @see RepaintManager#setCurrentManager(RepaintManager)
   */
  public static @Nonnull
  RepaintManager uninstall() {
    RepaintManager restored = previousRepaintManager;
    setCurrentManager(restored);
    previousRepaintManager = null;
    return restored;
  }

  private static @Nullable
  RepaintManager currentRepaintManager() {
    try {
      Object repaintManager = method("appContextGet").withReturnType(Object.class).withParameterTypes(Object.class)
                                                     .in(SwingUtilities.class).invoke(RepaintManager.class);
      if (repaintManager instanceof RepaintManager) {
        return (RepaintManager) repaintManager;
      }
    } catch (RuntimeException e) {
      return null;
    }
    return null;
  }

  private static @Nonnull FailOnThreadViolationRepaintManager installNew() {
    FailOnThreadViolationRepaintManager m = new FailOnThreadViolationRepaintManager();
    previousRepaintManager = currentRepaintManager();
    setCurrentManager(m);
    return m;
  }

  public FailOnThreadViolationRepaintManager() {
  }

  public FailOnThreadViolationRepaintManager(boolean completeCheck) {
    super(completeCheck);
  }

  /**
   * Throws a {@link EdtViolationException} when a EDT access violation is found.
   *
   * @param c the component involved in the EDT violation.
   * @param stackTraceElements stack trace elements to be set to the thrown exception.
   * @throws EdtViolationException when a EDT access violation is found.
   */
  @Override
  void violationFound(@Nonnull JComponent c, @Nonnull StackTraceElement[] stackTraceElements) {
    EdtViolationException e = new EdtViolationException("EDT violation detected");
    e.setStackTrace(stackTraceElements);
    throw e;
  }
}