001 /*
002 * Created on Nov 20, 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.assertions.data.Index;
018 import org.fest.util.ComparisonStrategy;
019 import org.fest.util.StandardComparisonStrategy;
020
021 /**
022 * Creates an error message indicating that an assertion that verifies a group of elements contains a value at a given
023 * index failed. A group of elements can be a collection, an array or a {@code String}.<br>
024 * It also mention the {@link ComparisonStrategy} if the default one is not used.
025 *
026 * @author Alex Ruiz
027 * @author Joel Costigliola
028 */
029 public class ShouldContainAtIndex extends BasicErrorMessageFactory {
030
031 /**
032 * Creates a new </code>{@link ShouldContainAtIndex}</code>.
033 * @param actual the actual value in the failed assertion.
034 * @param expected value expected to be in {@code actual}.
035 * @param index the index of the expected value.
036 * @param found the value in {@code actual} stored under {@code index}.
037 * @param comparisonStrategy the {@link ComparisonStrategy} used to evaluate assertion.
038 * @return the created {@code ErrorMessageFactory}.
039 */
040 public static ErrorMessageFactory shouldContainAtIndex(Object actual, Object expected, Index index, Object found,
041 ComparisonStrategy comparisonStrategy) {
042 return new ShouldContainAtIndex(actual, expected, index, found, comparisonStrategy);
043 }
044
045 /**
046 * Creates a new </code>{@link ShouldContainAtIndex}</code>.
047 * @param actual the actual value in the failed assertion.
048 * @param expected value expected to be in {@code actual}.
049 * @param index the index of the expected value.
050 * @param found the value in {@code actual} stored under {@code index}.
051 * @return the created {@code ErrorMessageFactory}.
052 */
053 public static ErrorMessageFactory shouldContainAtIndex(Object actual, Object expected, Index index, Object found) {
054 return new ShouldContainAtIndex(actual, expected, index, found, StandardComparisonStrategy.instance());
055 }
056
057 private ShouldContainAtIndex(Object actual, Object expected, Index index, Object found,
058 ComparisonStrategy comparisonStrategy) {
059 super("expecting:<%s> at index <%s> but found <%s> in:\n <%s>\n%s", expected, index.value, found, actual, comparisonStrategy);
060 }
061 }