org.marketcetera.util.test.CollectionAssert Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of util-test Show documentation
The newest version!
package org.marketcetera.util.test;

import java.util.Arrays;
import org.apache.commons.collections.Bag;
import org.apache.commons.collections.bag.HashBag;

import static org.junit.Assert.*;

/**
 * Assertions for collections.
 * 
 * @author [email protected]
 * @since 0.5.0
 * @version $Id$
 */

/* $License$ */

public final class CollectionAssert
{

    // CLASS METHODS.

    /**
     * Asserts that the two given arrays are permutations of each
     * other. This assertion holds if both arrays are null, or if they
     * have one or more (but an equal number of) null elements. If the
     * assertion does not hold, the {@link AssertionError} thrown
     * starts with the given message, which may be null if no such
     * custom message prefix is desired.
     *
     * @param  a T value
     * @param message The identifying message.
     * @param expected The expected array.
     * @param actual The actual array.
     */

    public static  void assertArrayPermutation
        (String message,
         T[] expected,
         T[] actual)
    {
        if ((expected==null) && (actual==null)) {
            return;
        }
        String content=null;
        if (expected==null) {
            content="expected array is null but actual is not"; //$NON-NLS-1$
        } else if (actual==null) {
            content="actual array is null but expected is not"; //$NON-NLS-1$
        } else if (expected.getClass()!=actual.getClass()) {
            content="expected array class is "+ //$NON-NLS-1$
                expected.getClass().getName()+
                " but actual array class is "+ //$NON-NLS-1$
                actual.getClass().getName();
        } else {
            Bag expectedBag=new HashBag(Arrays.asList(expected));
            Bag actualBag=new HashBag(Arrays.asList(actual));
            for (Object e:expectedBag) {
                if (!actualBag.remove(e,1)) {
                    content="actual is missing '"+ //$NON-NLS-1$
                        e+"'"; //$NON-NLS-1$
                    break;
                }
            }
            if (content==null) {
                if (actualBag.size()==0) {
                    return;
                }
                content=
                    "actual contains extra elements such as "+ //$NON-NLS-1$
                    actualBag.iterator().next();
            }
        }
        if (message!=null) {
            content=message+" "+content; //$NON-NLS-1$
        }
        fail(content);
    }

    /**
     * Asserts that the two given arrays are permutations of each
     * other. This assertion holds if both arrays are null, or if they
     * have one or more (but an equal number of) null elements.
     *
     * @param  a T value
     * @param expected The expected array.
     * @param actual The actual array.
     */

    public static  void assertArrayPermutation
        (T[] expected,
         T[] actual)
    {
        assertArrayPermutation(null,expected,actual);
    }


    // CONSTRUCTOR.

    /**
     * Constructor. It is private so that no instances can be created.
     */

    private CollectionAssert() {}
}