com.fitbur.assertj.error.ErrorMessageFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of external-test Show documentation

There is a newer version: 1.0.0

/**
 * 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-2016 the original author or authors.
 */
package com.fitbur.assertj.error;

import com.fitbur.assertj.description.Description;
import com.fitbur.assertj.presentation.Representation;
import com.fitbur.assertj.presentation.StandardRepresentation;

/**
 * Factory of error messages.
 * 
 * @author Alex Ruiz
 */
public interface ErrorMessageFactory {

  /**
   * Creates a new error message as a result of a failed assertion.
   * @param d the description of the failed assertion.
   * @param p
   * @return the created error message.
   */
  String create(Description d, Representation p);

  /**
   * Creates a new error message as a result of a failed assertion with {@link StandardRepresentation}.
   * 
   * @param d the description of the failed assertion.
   * @return the created error message.
   */
  String create(Description d);

  /**
   * Creates a new error message as a result of a failed assertion without description.
   * 
   * @return the created error message.
   */
  String create();
}