net.joala.condition.timing.IgnorableStateQueryException Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2012 CoreMedia AG
 *
 * This file is part of Joala.
 *
 * Joala is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Joala is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Joala.  If not, see .
 */

package net.joala.condition.timing;

import com.google.common.base.Function;
import org.hamcrest.Description;
import org.hamcrest.SelfDescribing;
import org.hamcrest.StringDescription;

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

import static com.google.common.base.Preconditions.checkNotNull;
import static net.joala.matcher.DescriptionUtil.describeTo;

/**
 * 
 * Exception which evaluated functions might throw in order to signal that the current state query failed but should
 * be retried.
 * 
 * 
 * If the function implements {@link SelfDescribing} its description will be added to the failure message
 * or taken as failure message if no extra message is provided. Otherwise its {@link Object#toString()} method
 * will be called.
 * 
 *
 * @see Wait
 * @since 9/14/12
 */
public class IgnorableStateQueryException extends RuntimeException {
  private static final String CHECK_QUERY_FUNCTION_MUST_NOT_BE_NULL = "Query function must not be null";
  @Nonnull
  private final Function stateQuery;

  /**
   * 
   * Constructor with the query which raised the error.
   * 
   *
   * @param stateQuery query raising this exception
   */
  public IgnorableStateQueryException(@Nonnull final Function stateQuery) {
    super();
    checkNotNull(stateQuery, CHECK_QUERY_FUNCTION_MUST_NOT_BE_NULL);
    this.stateQuery = stateQuery;
  }

  /**
   * 
   * Constructor with query and cause.
   * 
   *
   * @param stateQuery query raising this exception
   * @param cause      exception which caused the failure on state query
   */
  public IgnorableStateQueryException(@Nonnull final Function stateQuery, final Throwable cause) {
    super(cause);
    checkNotNull(stateQuery, CHECK_QUERY_FUNCTION_MUST_NOT_BE_NULL);
    this.stateQuery = stateQuery;
  }

  /**
   * 
   * Constructor with query and message.
   * 
   *
   * @param stateQuery query raising this exception
   * @param message    message for this failure, will be enriched by the description of the stateQuery
   */
  public IgnorableStateQueryException(@Nonnull final Function stateQuery, final String message) {
    super(message);
    checkNotNull(stateQuery, CHECK_QUERY_FUNCTION_MUST_NOT_BE_NULL);
    this.stateQuery = stateQuery;
  }

  /**
   * 
   * Constructor with query, message and cause.
   * 
   *
   * @param stateQuery query raising this exception
   * @param message    message for this failure, will be enriched by the description of the stateQuery
   * @param cause      exception which caused the failure on state query
   */
  public IgnorableStateQueryException(@Nonnull final Function stateQuery, final String message, final Throwable cause) {
    super(message, cause);
    checkNotNull(stateQuery, CHECK_QUERY_FUNCTION_MUST_NOT_BE_NULL);
    this.stateQuery = stateQuery;
  }

  @Override
  public String getMessage() {
    return buildMessage(stateQuery, super.getMessage());
  }

  @Override
  public String getLocalizedMessage() {
    return buildMessage(stateQuery, super.getLocalizedMessage());
  }

  /**
   * 
   * Build a message combining the original message (if any) with a description of the stateQuery.
   * 
   *
   * @param function function which queried the state
   * @param message  message provided for exception; might be {@code null}
   * @return a complete message for the exception
   */
  private static String buildMessage(@Nonnull final Function function, @Nullable final String message) {
    final Description description = new StringDescription();
    if (message == null) {
      description.appendText("Failure: ");
    } else {
      description.appendText(message);
      description.appendText(" - ");
    }
    describeTo(description, function);
    return description.toString();
  }

}