001    /*
002     * Created on Oct 24, 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.Offset;
018    import org.fest.util.*;
019    
020    /**
021     * Creates an error message indicating that an assertion that verifies that two numbers are equal within a positive
022     * offset failed.
023     *
024     * @author Alex Ruiz
025     */
026    public class ShouldBeEqualWithinOffset extends BasicErrorMessageFactory {
027    
028      /**
029       * Creates a new <code>{@link ShouldBeEqualWithinOffset}</code>.
030       * @param <T> guarantees that the values used in this factory have the same type.
031       * @param actual the actual value in the failed assertion.
032       * @param expected the expected value in the failed assertion.
033       * @param offset the given positive offset.
034       * @return the created {@code ErrorMessageFactory}.
035       */
036      public static <T extends Number> ErrorMessageFactory shouldBeEqual(T actual, T expected, Offset<T> offset) {
037        return new ShouldBeEqualWithinOffset(actual, expected, offset, StandardComparisonStrategy.instance());
038      }
039    
040      /**
041       * Creates a new <code>{@link ShouldBeEqualWithinOffset}</code>.
042       * @param <T> guarantees that the values used in this factory have the same type.
043       * @param actual the actual value in the failed assertion.
044       * @param expected the expected value in the failed assertion.
045       * @param offset the given positive offset.
046       * @param comparisonStrategy the {@link ComparisonStrategy} used to evaluate assertion.
047       * @return the created {@code ErrorMessageFactory}.
048       */
049      public static <T extends Number> ErrorMessageFactory shouldBeEqual(T actual, T expected, Offset<T> offset, ComparisonStrategy comparisonStrategy) {
050        return new ShouldBeEqualWithinOffset(actual, expected, offset, comparisonStrategy);
051      }
052      
053      private ShouldBeEqualWithinOffset(Number actual, Number expected, Offset<?> offset, ComparisonStrategy comparisonStrategy) {
054        super("expected:<%s> but was:<%s> within offset:<%s>%s", expected, actual, offset.value, comparisonStrategy);
055      }
056    }