001    /*
002     * Created on Oct 17, 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.core;
016    
017    
018    /**
019     * Assertion methods applicable to <code>{@link Number}</code>s.
020     * @param <T> the type of the "actual" value.
021     *
022     * @author Alex Ruiz
023     * @author Nicolas François
024     */
025    public interface NumberAssert<T extends Number> {
026    
027      /**
028       * Verifies that the actual value is equal to zero.
029       * @return this assertion object.
030       * @throws AssertionError if the actual value is {@code null}.
031       * @throws AssertionError if the actual value is not equal to zero.
032       */
033      NumberAssert<T> isZero();
034    
035      /**
036       * Verifies that the actual value is not equal to zero.
037       * @return this assertion object.
038       * @throws AssertionError if the actual value is {@code null}.
039       * @throws AssertionError if the actual value is equal to zero.
040       */
041      NumberAssert<T> isNotZero();
042    
043      /**
044       * Verifies that the actual value is positive.
045       * @return this assertion object.
046       * @throws AssertionError if the actual value is {@code null}.
047       * @throws AssertionError if the actual value is not positive.
048       */
049      NumberAssert<T> isPositive();
050      
051      /**
052       * Verifies that the actual value is negative.
053       * @return this assertion object.
054       * @throws AssertionError if the actual value is {@code null}.
055       * @throws AssertionError if the actual value is not negative.
056       */
057      NumberAssert<T> isNegative();  
058    
059      /**
060       * Verifies that the actual value is non negative (positive or equal zero).
061       * @return {@code this} assertion object.
062       * @throws AssertionError if the actual value is {@code null}.
063       * @throws AssertionError if the actual value is not non negative.
064       */
065      NumberAssert<T> isNotNegative();
066      
067      /**
068       * Verifies that the actual value is non positive (negative or equal zero).
069       * @return {@code this} assertion object.
070       * @throws AssertionError if the actual value is {@code null}.
071       * @throws AssertionError if the actual value is not non positive.
072       */
073      NumberAssert<T> isNotPositive();
074      
075    }