001    /*
002     * Created on Dec 26, 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 {@code String} contains another
022     * {@code String} failed.
023     * 
024     * @author Alex Ruiz
025     * @author Joel Costigliola
026     */
027    public class ShouldContainString extends BasicErrorMessageFactory {
028    
029      /**
030       * Creates a new <code>{@link ShouldContainString}</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       * @return the created {@code ErrorMessageFactory}.
034       */
035      public static ErrorMessageFactory shouldContain(String actual, String sequence) {
036        return new ShouldContainString("expecting:<%s> to contain:<%s>%s", actual, sequence,
037            StandardComparisonStrategy.instance());
038      }
039    
040      /**
041       * Creates a new <code>{@link ShouldContainString}</code>.
042       * @param actual the actual value in the failed assertion.
043       * @param sequence the sequence of values expected to be in {@code actual}.
044       * @param comparisonStrategy the {@link ComparisonStrategy} used to evaluate assertion.
045       * @return the created {@code ErrorMessageFactory}.
046       */
047      public static ErrorMessageFactory shouldContain(String actual, String sequence, ComparisonStrategy comparisonStrategy) {
048        return new ShouldContainString("expecting:<%s> to contain:<%s>%s", actual, sequence, comparisonStrategy);
049      }
050    
051      /**
052       * Creates a new <code>{@link ShouldContainString}</code>.
053       * @param actual the actual value in the failed assertion.
054       * @param sequence the sequence of values expected to be in {@code actual}.
055       * @return the created {@code ErrorMessageFactory}.
056       */
057      public static ErrorMessageFactory shouldContainIgnoringCase(String actual, String sequence) {
058        return new ShouldContainString("expecting:<%s> to contain:<%s> (ignoring case)", actual, sequence,
059            StandardComparisonStrategy.instance());
060      }
061    
062      private ShouldContainString(String format, String actual, String sequence, ComparisonStrategy comparisonStrategy) {
063        super(format, actual, sequence, comparisonStrategy);
064      }
065    }