001    /*
002     * Created on Jan 24, 2011
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 @2011 the original author or authors.
014     */
015    package org.fest.assertions.error;
016    
017    import org.fest.assertions.data.Offset;
018    
019    /**
020     * Creates an error message that indicates an assertion that verifies that two images are equal failed.
021     *
022     * @author Yvonne Wang
023     */
024    public class ShouldBeEqualImages extends BasicErrorMessageFactory {
025    
026      /**
027       * Creates a new <code>{@link ShouldBeEqualImages}</code>.
028       * @param offset helps decide if the color of two pixels are similar: two pixels that are identical to the human eye
029       * may still have slightly different color values. For example, by using an offset of 1 we can indicate that a blue
030       * value of 60 is similar to a blue value of 61.
031       * @return the created {@code ErrorMessageFactory}.
032       */
033      public static ErrorMessageFactory shouldBeEqualImages(Offset<Integer> offset) {
034        return new ShouldBeEqualImages(offset);
035      }
036    
037      private ShouldBeEqualImages(Offset<Integer> offset) {
038        super("expecting images to be equal within offset:<%s>", offset.value);
039      }
040    }