/**
 * 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.core;

import static org.assertj.core.util.Preconditions.checkNotNull;
import static org.assertj.swing.edt.GuiActionRunner.execute;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import org.assertj.core.description.Description;
import org.assertj.swing.annotation.RunsInEDT;
import org.assertj.swing.timing.Condition;

/**
 * {@link Condition} that is evaluated in the event dispatch thread (EDT).
 * 
 * @author Alex Ruiz
 */
public abstract class EdtSafeCondition extends Condition {
  /**
   * Creates a new {@link EdtSafeCondition}.
   * 
   * @param description describes this condition.
   */
  public EdtSafeCondition(@Nonnull String description) {
    super(description);
  }

  /**
   * Creates a new {@link EdtSafeCondition}.
   * 
   * @param description describes this condition.
   */
  public EdtSafeCondition(@Nullable Description description) {
    super(description);
  }

  /**
   * Checks if the condition has been satisfied.
   * 
   * @return {@code true} if the condition has been satisfied, otherwise {@code false}.
   */
  @Override
  public final boolean test() {
    Boolean result = execute(() -> testInEDT());
    return checkNotNull(result);
  }

  /**
   * Checks if the condition has been satisfied. This method is guaranteed to be executed in the event dispatch thread
   * (EDT).
   * 
   * @return {@code true} if the condition has been satisfied, otherwise {@code false}.
   */
  @RunsInEDT
  protected abstract boolean testInEDT();
}