KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > junitx > framework > ListAssert


1 /*
2  * The JUnit-addons Software License, Version 1.0
3  * (based on the Apache Software License, Version 1.1)
4  *
5  * Copyright (c) 2003 Vladimir R. Bossicard. All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  *
19  * 3. The end-user documentation included with the redistribution, if
20  * any, must include the following acknowlegement:
21  * "This product includes software developed by Vladimir R.
22  * Bossicard as well as other contributors
23  * (http://junit-addons.sourceforge.net/)."
24  * Alternately, this acknowlegement may appear in the software itself,
25  * if and wherever such third-party acknowlegements normally appear.
26  *
27  * 4. The name "JUnit-addons" must not be used to endorse or promote
28  * products derived from this software without prior written
29  * permission. For written permission, please contact
30  * vbossica@users.sourceforge.net.
31  *
32  * 5. Products derived from this software may not be called "JUnit-addons"
33  * nor may "JUnit-addons" appear in their names without prior written
34  * permission of the project managers.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ======================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals. For more information on the JUnit-addons Project, please
52  * see <http://junit-addons.sourceforge.net/>.
53  */

54
55 package junitx.framework;
56
57 import java.util.List JavaDoc;
58
59 /**
60  * A set of assert methods specially targetted to asserting Lists.
61  *
62  * @version $Revision: 1.1 $ $Date: 2003/04/28 03:08:17 $
63  * @author <a HREF="mailto:vbossica@users.sourceforge.net">Vladimir R. Bossicard</a>
64  */

65 public class ListAssert {
66
67     /**
68      * Don't let anyone have access to this constructor.
69      */

70     private ListAssert() {
71     }
72
73     /**
74      * Asserts that two lists are equal (the order is not relevant). Throws an
75      * <tt>AssertionFailedError</tt> if not.
76      */

77     public static void assertEquals(List JavaDoc expected, List JavaDoc actual) {
78         assertEquals(null, expected, actual);
79     }
80
81     /**
82      * Asserts that two lists are equal (the order is not relevant). Throws an
83      * <tt>AssertionFailedError</tt> if not.
84      */

85     public static void assertEquals(String JavaDoc message, List JavaDoc expected, List JavaDoc actual) {
86         if ((expected == null && actual == null) || (expected != null && expected.equals(actual))) {
87             return;
88         }
89
90         for (int ii = 0; ii < expected.size(); ii++) {
91             assertContains(message, actual, expected.get(ii));
92         }
93         String JavaDoc formatted = "[length]";
94         if (message != null) {
95             formatted = message + " " + formatted;
96         }
97
98         Assert.assertEquals(formatted, expected.size(), actual.size());
99     }
100
101     /**
102      * Asserts that a list contains a given object. Throws an
103      * <tt>AssertionFailedError</tt> if it doesn't contain the object.
104      */

105     public static void assertContains(List JavaDoc actual, Object JavaDoc value) {
106         assertContains(null, actual, value);
107     }
108
109     /**
110      * Asserts that a list contains a given object. Throws an
111      * <tt>AssertionFailedError</tt> if it doesn't contain the object.
112      */

113     public static void assertContains(String JavaDoc message, List JavaDoc actual, Object JavaDoc value) {
114         Assert.assertNotNull(message, actual);
115         if (actual.contains(value)) {
116             return;
117         }
118         failNotContains(message, actual, value);
119     }
120
121     private static void failNotContains(String JavaDoc message, List JavaDoc actual, Object JavaDoc value) {
122         String JavaDoc formatted = "";
123         if (message != null) {
124             formatted = message + " ";
125         }
126
127         StringBuffer JavaDoc listcontent = new StringBuffer JavaDoc();
128         for (int ii = 0; ii < actual.size() - 1; ii++) {
129             listcontent.append(actual.get(ii)).append(", ");
130         }
131         listcontent.append(actual.get(actual.size() - 1));
132
133         throw new junit.framework.AssertionFailedError(formatted + "expecting <" + value + "> in <" + listcontent.toString() + ">");
134     }
135
136 }
137
Popular Tags