/*
* Created on Apr 14, 2007
*
* 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 @2007-2010 the original author or authors.
*/
package org.fest.swing.timing;
import static org.fest.util.Strings.concat;
import org.fest.assertions.BasicDescription;
import org.fest.assertions.Description;
/**
* Understands a condition to verify, usually used in the method <code>{@link Pause#pause(Condition)}</code>.
*
* @author Yvonne Wang
* @author Alex Ruiz
*/
public abstract class Condition {
protected static final String EMPTY_TEXT = "";
private final Description description;
/**
* Creates a new <code>{@link Condition}</code>.
* @param description describes this condition.
*/
public Condition(String description) {
this(new BasicDescription(description));
}
/**
* Creates a new </code>{@link Condition}</code>.
* @param description describes this condition.
*/
public Condition(Description description) {
this.description = description;
}
/**
* Checks if the condition has been satisfied.
* @return <code>true</code> if the condition has been satisfied, otherwise <code>false</code>.
*/
public abstract boolean test();
/**
* Returns the <code>String</code> representation of this condition, which is its description.
* @return the description of this condition.
*/
@Override public final String toString() {
String descriptionText = description != null ? description.value() : defaultDescription();
String addendum = descriptionAddendum();
return concat(descriptionText, addendum != null ? addendum : EMPTY_TEXT);
}
private String defaultDescription() {
return concat("condition of type [", getClass().getName(), "]");
}
/**
* Returns any text to be added to this condition's description. The default value is an empty <code>String</code>.
* @return by default, an empty <code>String</code>.
*/
protected String descriptionAddendum() {
return EMPTY_TEXT;
}
/**
* Notification that this condition has been evaluated. This method is invoked by
* <code>{@link Pause#pause(Condition)}</code> (and all overloaded methods) when this condition is evaluated (either
* it was satisfied or it timed-out.) This is a good place to do any necessary resource cleanup.
*/
protected void done() {}
}