001    /*
002     * Created on Nov 22, 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 that a group of elements contains a sequence of
022     * values failed. A group of elements can be a collection, an array or a {@code String}.
023     * 
024     * @author Alex Ruiz
025     * @author Joel Costigliola
026     */
027    public class ShouldContainSequence extends BasicErrorMessageFactory {
028    
029      /**
030       * Creates a new <code>{@link ShouldContainSequence}</code>.
031       * @param actual the actual value in the failed assertion.
032       * @param sequence the sequence of values expected to be in {@code actual}.
033       * @param comparisonStrategy the {@link ComparisonStrategy} used to evaluate assertion.
034       * @return the created {@code ErrorMessageFactory}.
035       */
036      public static ErrorMessageFactory shouldContainSequence(Object actual, Object sequence,
037          ComparisonStrategy comparisonStrategy) {
038        return new ShouldContainSequence(actual, sequence, comparisonStrategy);
039      }
040    
041      /**
042       * Creates a new <code>{@link ShouldContainSequence}</code>.
043       * @param actual the actual value in the failed assertion.
044       * @param sequence the sequence of values expected to be in {@code actual}.
045       * @return the created {@code ErrorMessageFactory}.
046       */
047      public static ErrorMessageFactory shouldContainSequence(Object actual, Object sequence) {
048        return new ShouldContainSequence(actual, sequence, StandardComparisonStrategy.instance());
049      }
050    
051      private ShouldContainSequence(Object actual, Object sequence, ComparisonStrategy comparisonStrategy) {
052        super("expecting:\n<%s>\n to contain sequence:\n<%s>\n%s", actual, sequence, comparisonStrategy);
053      }
054    
055    }