1 /* 2 * Copyright (c) 2013, 2023, 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 package test.java.util.Collections; 31 32 import java.lang.reflect.Method; 33 import java.util.ArrayList; 34 import java.util.Collection; 35 import java.util.Collections; 36 import java.util.LinkedList; 37 import java.util.List; 38 import java.util.TreeMap; 39 import java.util.TreeSet; 40 41 import org.testng.annotations.Test; 42 import org.testng.annotations.DataProvider; 43 44 import static org.testng.Assert.assertTrue; 45 46 @Test(groups = "unit") 47 public class Wrappers { 48 static Object[][] collections; 49 50 @DataProvider(name="collections") collectionCases()51 public static Object[][] collectionCases() { 52 if (collections != null) { 53 return collections; 54 } 55 56 List<Object[]> cases = new ArrayList<>(); 57 LinkedList<Integer> seedList = new LinkedList<>(); 58 ArrayList<Integer> seedRandomAccess = new ArrayList<>(); 59 TreeSet<Integer> seedSet = new TreeSet<>(); 60 TreeMap<Integer, Integer> seedMap = new TreeMap<>(); 61 62 for (int i = 1; i <= 10; i++) { 63 seedList.add(i); 64 seedRandomAccess.add(i); 65 seedSet.add(i); 66 seedMap.put(i, i); 67 } 68 69 cases.add(new Object[] { Collections.unmodifiableCollection(seedList) }); 70 cases.add(new Object[] { Collections.unmodifiableSequencedCollection(seedList) }); 71 cases.add(new Object[] { Collections.unmodifiableList(seedList) }); 72 cases.add(new Object[] { Collections.unmodifiableList(seedRandomAccess) }); 73 cases.add(new Object[] { Collections.unmodifiableSet(seedSet) }); 74 cases.add(new Object[] { Collections.unmodifiableSequencedSet(seedSet) }); 75 cases.add(new Object[] { Collections.unmodifiableSortedSet(seedSet) }); 76 cases.add(new Object[] { Collections.unmodifiableNavigableSet(seedSet) }); 77 78 // As sets from map also need to be unmodifiable, thus a wrapping 79 // layer exist and should not have default methods 80 cases.add(new Object[] { Collections.unmodifiableMap(seedMap).entrySet() }); 81 cases.add(new Object[] { Collections.unmodifiableMap(seedMap).keySet() }); 82 cases.add(new Object[] { Collections.unmodifiableMap(seedMap).values() }); 83 cases.add(new Object[] { Collections.unmodifiableSequencedMap(seedMap).entrySet() }); 84 cases.add(new Object[] { Collections.unmodifiableSequencedMap(seedMap).keySet() }); 85 cases.add(new Object[] { Collections.unmodifiableSequencedMap(seedMap).values() }); 86 cases.add(new Object[] { Collections.unmodifiableSequencedMap(seedMap).reversed().entrySet() }); 87 cases.add(new Object[] { Collections.unmodifiableSequencedMap(seedMap).reversed().keySet() }); 88 cases.add(new Object[] { Collections.unmodifiableSequencedMap(seedMap).reversed().values() }); 89 cases.add(new Object[] { Collections.unmodifiableSequencedMap(seedMap).sequencedEntrySet() }); 90 cases.add(new Object[] { Collections.unmodifiableSequencedMap(seedMap).sequencedKeySet() }); 91 cases.add(new Object[] { Collections.unmodifiableSequencedMap(seedMap).sequencedValues() }); 92 cases.add(new Object[] { Collections.unmodifiableSequencedMap(seedMap).sequencedEntrySet().reversed() }); 93 cases.add(new Object[] { Collections.unmodifiableSequencedMap(seedMap).sequencedKeySet().reversed() }); 94 cases.add(new Object[] { Collections.unmodifiableSequencedMap(seedMap).sequencedValues().reversed() }); 95 cases.add(new Object[] { Collections.unmodifiableSequencedMap(seedMap).reversed().sequencedEntrySet() }); 96 cases.add(new Object[] { Collections.unmodifiableSequencedMap(seedMap).reversed().sequencedKeySet() }); 97 cases.add(new Object[] { Collections.unmodifiableSequencedMap(seedMap).reversed().sequencedValues() }); 98 cases.add(new Object[] { Collections.unmodifiableSequencedMap(seedMap).reversed().sequencedEntrySet().reversed() }); 99 cases.add(new Object[] { Collections.unmodifiableSequencedMap(seedMap).reversed().sequencedKeySet().reversed() }); 100 cases.add(new Object[] { Collections.unmodifiableSequencedMap(seedMap).reversed().sequencedValues().reversed() }); 101 cases.add(new Object[] { Collections.unmodifiableSortedMap(seedMap).entrySet() }); 102 cases.add(new Object[] { Collections.unmodifiableSortedMap(seedMap).keySet() }); 103 cases.add(new Object[] { Collections.unmodifiableSortedMap(seedMap).values() }); 104 cases.add(new Object[] { Collections.unmodifiableNavigableMap(seedMap).entrySet() }); 105 cases.add(new Object[] { Collections.unmodifiableNavigableMap(seedMap).keySet() }); 106 cases.add(new Object[] { Collections.unmodifiableNavigableMap(seedMap).values() }); 107 108 // Synchronized 109 cases.add(new Object[] { Collections.synchronizedCollection(seedList) }); 110 cases.add(new Object[] { Collections.synchronizedList(seedList) }); 111 cases.add(new Object[] { Collections.synchronizedList(seedRandomAccess) }); 112 cases.add(new Object[] { Collections.synchronizedSet(seedSet) }); 113 cases.add(new Object[] { Collections.synchronizedSortedSet(seedSet) }); 114 cases.add(new Object[] { Collections.synchronizedNavigableSet(seedSet) }); 115 116 // As sets from map also need to be synchronized on the map, thus a 117 // wrapping layer exist and should not have default methods 118 cases.add(new Object[] { Collections.synchronizedMap(seedMap).entrySet() }); 119 cases.add(new Object[] { Collections.synchronizedMap(seedMap).keySet() }); 120 cases.add(new Object[] { Collections.synchronizedMap(seedMap).values() }); 121 cases.add(new Object[] { Collections.synchronizedSortedMap(seedMap).entrySet() }); 122 cases.add(new Object[] { Collections.synchronizedSortedMap(seedMap).keySet() }); 123 cases.add(new Object[] { Collections.synchronizedSortedMap(seedMap).values() }); 124 cases.add(new Object[] { Collections.synchronizedNavigableMap(seedMap).entrySet() }); 125 cases.add(new Object[] { Collections.synchronizedNavigableMap(seedMap).keySet() }); 126 cases.add(new Object[] { Collections.synchronizedNavigableMap(seedMap).values() }); 127 128 // Checked 129 cases.add(new Object[] { Collections.checkedCollection(seedList, Integer.class) }); 130 cases.add(new Object[] { Collections.checkedList(seedList, Integer.class) }); 131 cases.add(new Object[] { Collections.checkedList(seedRandomAccess, Integer.class) }); 132 cases.add(new Object[] { Collections.checkedSet(seedSet, Integer.class) }); 133 cases.add(new Object[] { Collections.checkedSortedSet(seedSet, Integer.class) }); 134 cases.add(new Object[] { Collections.checkedNavigableSet(seedSet, Integer.class) }); 135 cases.add(new Object[] { Collections.checkedQueue(seedList, Integer.class) }); 136 137 // asLifoQueue is another wrapper 138 cases.add(new Object[] { Collections.asLifoQueue(seedList) }); 139 140 collections = cases.toArray(new Object[0][]); 141 return collections; 142 } 143 144 static Method[] defaultMethods; 145 146 static { 147 List<Method> list = new ArrayList<>(); 148 Method[] methods = Collection.class.getMethods(); 149 for (Method m: methods) { 150 if (m.isDefault()) { 151 list.add(m); 152 } 153 } 154 defaultMethods = list.toArray(new Method[0]); 155 } 156 157 @Test(dataProvider = "collections") testAllDefaultMethodsOverridden(Collection c)158 public static void testAllDefaultMethodsOverridden(Collection c) throws NoSuchMethodException { 159 Class cls = c.getClass(); 160 var notOverridden = new ArrayList<Method>(); 161 for (Method m: defaultMethods) { 162 Method m2 = cls.getMethod(m.getName(), m.getParameterTypes()); 163 if (m2.isDefault()) { 164 notOverridden.add(m); 165 } 166 } 167 assertTrue(notOverridden.isEmpty(), cls.getName() + " does not override " + notOverridden); 168 } 169 } 170 171