001 /*
002 * Created on Oct 18, 2010
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
005 * the License. You may obtain a copy of the License at
006 *
007 * http://www.apache.org/licenses/LICENSE-2.0
008 *
009 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
010 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
011 * specific language governing permissions and limitations under the License.
012 *
013 * Copyright @2010-2011 the original author or authors.
014 */
015 package org.fest.assertions.error;
016
017 import org.fest.util.ComparisonStrategy;
018 import org.fest.util.StandardComparisonStrategy;
019
020 /**
021 * Creates an error message indicating that an assertion that verifies a group of elements contains a given set of
022 * values failed. A group of elements can be a collection, an array or a {@code String}.<br>
023 * It also mention the {@link ComparisonStrategy} used.
024 *
025 * @author Alex Ruiz
026 * @author Joel Costigliola
027 */
028 public class ShouldContain extends BasicErrorMessageFactory {
029
030 /**
031 * Creates a new </code>{@link ShouldContain}</code>.
032 * @param actual the actual value in the failed assertion.
033 * @param expected values expected to be in {@code actual}.
034 * @param notFound the values in {@code expected} not found in {@code actual}.
035 * @param comparisonStrategy the {@link ComparisonStrategy} used to evaluate assertion.
036 * @return the created {@code ErrorMessageFactory}.
037 */
038 public static ErrorMessageFactory shouldContain(Object actual, Object expected, Object notFound,
039 ComparisonStrategy comparisonStrategy) {
040 return new ShouldContain(actual, expected, notFound, comparisonStrategy);
041 }
042
043 /**
044 * Creates a new </code>{@link ShouldContain}</code>.
045 * @param actual the actual value in the failed assertion.
046 * @param expected values expected to be in {@code actual}.
047 * @param notFound the values in {@code expected} not found in {@code actual}.
048 * @return the created {@code ErrorMessageFactory}.
049 */
050 public static ErrorMessageFactory shouldContain(Object actual, Object expected, Object notFound) {
051 return new ShouldContain(actual, expected, notFound, StandardComparisonStrategy.instance());
052 }
053
054 private ShouldContain(Object actual, Object expected, Object notFound, ComparisonStrategy comparisonStrategy) {
055 super("expecting:\n<%s>\n to contain:\n<%s>\n but could not find:\n<%s>\n%s", actual, expected, notFound, comparisonStrategy);
056 }
057
058 }