1 /*
2  * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.
8  *
9  * This code is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12  * version 2 for more details (a copy is included in the LICENSE file that
13  * accompanied this code).
14  *
15  * You should have received a copy of the GNU General Public License version
16  * 2 along with this work; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18  *
19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20  * or visit www.oracle.com if you need additional information or have any
21  * questions.
22  */
23 
24 /**
25  * @test
26  * @run testng Wrappers
27  * @summary Ensure Collections wrapping classes provide non-default implementations
28  */
29 
30 import java.lang.reflect.Method;
31 import java.util.ArrayList;
32 import java.util.Collection;
33 import java.util.Collections;
34 import java.util.LinkedList;
35 import java.util.List;
36 import java.util.Objects;
37 import java.util.TreeMap;
38 import java.util.TreeSet;
39 
40 import org.testng.annotations.Test;
41 import org.testng.annotations.DataProvider;
42 
main(String[] args)43 import static org.testng.Assert.assertFalse;
44 
45 @Test(groups = "unit")
46 public class Wrappers {
47     static Object[][] collections;
48 
49     @DataProvider(name="collections")
50     public static Object[][] collectionCases() {
51         if (collections != null) {
52             return collections;
53         }
54 
55         List<Object[]> cases = new ArrayList<>();
56         LinkedList<Integer> seedList = new LinkedList<>();
57         ArrayList<Integer> seedRandomAccess = new ArrayList<>();
58         TreeSet<Integer> seedSet = new TreeSet<>();
59         TreeMap<Integer, Integer> seedMap = new TreeMap<>();
60 
61         for (int i = 1; i <= 10; i++) {
62             seedList.add(i);
63             seedRandomAccess.add(i);
64             seedSet.add(i);
65             seedMap.put(i, i);
66         }
67 
68         cases.add(new Object[] { Collections.unmodifiableCollection(seedList) });
69         cases.add(new Object[] { Collections.unmodifiableList(seedList) });
70         cases.add(new Object[] { Collections.unmodifiableList(seedRandomAccess) });
71         cases.add(new Object[] { Collections.unmodifiableSet(seedSet) });
72         cases.add(new Object[] { Collections.unmodifiableSortedSet(seedSet) });
73         cases.add(new Object[] { Collections.unmodifiableNavigableSet(seedSet) });
74 
75         // As sets from map also need to be unmodifiable, thus a wrapping
76         // layer exist and should not have default methods
77         cases.add(new Object[] { Collections.unmodifiableMap(seedMap).entrySet() });
78         cases.add(new Object[] { Collections.unmodifiableMap(seedMap).keySet() });
79         cases.add(new Object[] { Collections.unmodifiableMap(seedMap).values() });
80         cases.add(new Object[] { Collections.unmodifiableSortedMap(seedMap).entrySet() });
81         cases.add(new Object[] { Collections.unmodifiableSortedMap(seedMap).keySet() });
82         cases.add(new Object[] { Collections.unmodifiableSortedMap(seedMap).values() });
83         cases.add(new Object[] { Collections.unmodifiableNavigableMap(seedMap).entrySet() });
84         cases.add(new Object[] { Collections.unmodifiableNavigableMap(seedMap).keySet() });
85         cases.add(new Object[] { Collections.unmodifiableNavigableMap(seedMap).values() });
86 
87         // Synchronized
88         cases.add(new Object[] { Collections.synchronizedCollection(seedList) });
89         cases.add(new Object[] { Collections.synchronizedList(seedList) });
90         cases.add(new Object[] { Collections.synchronizedList(seedRandomAccess) });
91         cases.add(new Object[] { Collections.synchronizedSet(seedSet) });
92         cases.add(new Object[] { Collections.synchronizedSortedSet(seedSet) });
93         cases.add(new Object[] { Collections.synchronizedNavigableSet(seedSet) });
94 
95         // As sets from map also need to be synchronized on the map, thus a
96         // wrapping layer exist and should not have default methods
97         cases.add(new Object[] { Collections.synchronizedMap(seedMap).entrySet() });
98         cases.add(new Object[] { Collections.synchronizedMap(seedMap).keySet() });
99         cases.add(new Object[] { Collections.synchronizedMap(seedMap).values() });
100         cases.add(new Object[] { Collections.synchronizedSortedMap(seedMap).entrySet() });
101         cases.add(new Object[] { Collections.synchronizedSortedMap(seedMap).keySet() });
102         cases.add(new Object[] { Collections.synchronizedSortedMap(seedMap).values() });
103         cases.add(new Object[] { Collections.synchronizedNavigableMap(seedMap).entrySet() });
104         cases.add(new Object[] { Collections.synchronizedNavigableMap(seedMap).keySet() });
105         cases.add(new Object[] { Collections.synchronizedNavigableMap(seedMap).values() });
106 
107         // Checked
108         cases.add(new Object[] { Collections.checkedCollection(seedList, Integer.class) });
109         cases.add(new Object[] { Collections.checkedList(seedList, Integer.class) });
110         cases.add(new Object[] { Collections.checkedList(seedRandomAccess, Integer.class) });
111         cases.add(new Object[] { Collections.checkedSet(seedSet, Integer.class) });
112         cases.add(new Object[] { Collections.checkedSortedSet(seedSet, Integer.class) });
113         cases.add(new Object[] { Collections.checkedNavigableSet(seedSet, Integer.class) });
114         cases.add(new Object[] { Collections.checkedQueue(seedList, Integer.class) });
115 
116         // asLifoQueue is another wrapper
117         cases.add(new Object[] { Collections.asLifoQueue(seedList) });
118 
119         collections = cases.toArray(new Object[0][]);
120         return collections;
121     }
122 
123     static Method[] defaultMethods;
124 
125     static {
126         List<Method> list = new ArrayList<>();
127         Method[] methods = Collection.class.getMethods();
128         for (Method m: methods) {
129             if (m.isDefault()) {
130                 list.add(m);
131             }
132         }
133         defaultMethods = list.toArray(new Method[0]);
134     }
135 
136     @Test(dataProvider = "collections")
137     public static void testAllDefaultMethodsOverridden(Collection c) throws NoSuchMethodException {
138         Class cls = c.getClass();
139         for (Method m: defaultMethods) {
140             Method m2 = cls.getMethod(m.getName(), m.getParameterTypes());
141             // default had been override
142             assertFalse(m2.isDefault(), cls.getCanonicalName());
143         }
144     }
145 }
146 
147