1 /* 2 * Copyright (C) 2007 The Guava Authors 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package com.google.common.collect; 18 19 import java.util.ArrayDeque; 20 import java.util.Collection; 21 import java.util.Iterator; 22 import java.util.Queue; 23 import junit.framework.TestCase; 24 25 /** 26 * Tests for {@link Synchronized#queue} and {@link Queues#synchronizedQueue}. 27 * 28 * @author Kurt Alfred Kluever 29 */ 30 public class SynchronizedQueueTest extends TestCase { 31 create()32 protected Queue<String> create() { 33 TestQueue<String> inner = new TestQueue<>(); 34 Queue<String> outer = Synchronized.queue(inner, inner.mutex); 35 outer.add("foo"); // necessary because we try to remove elements later on 36 return outer; 37 } 38 39 private static final class TestQueue<E> implements Queue<E> { 40 private final Queue<E> delegate = Lists.newLinkedList(); 41 public final Object mutex = new Integer(1); // something Serializable 42 43 @Override offer(E o)44 public boolean offer(E o) { 45 assertTrue(Thread.holdsLock(mutex)); 46 return delegate.offer(o); 47 } 48 49 @Override poll()50 public E poll() { 51 assertTrue(Thread.holdsLock(mutex)); 52 return delegate.poll(); 53 } 54 55 @Override remove()56 public E remove() { 57 assertTrue(Thread.holdsLock(mutex)); 58 return delegate.remove(); 59 } 60 61 @Override remove(Object object)62 public boolean remove(Object object) { 63 assertTrue(Thread.holdsLock(mutex)); 64 return delegate.remove(object); 65 } 66 67 @Override peek()68 public E peek() { 69 assertTrue(Thread.holdsLock(mutex)); 70 return delegate.peek(); 71 } 72 73 @Override element()74 public E element() { 75 assertTrue(Thread.holdsLock(mutex)); 76 return delegate.element(); 77 } 78 79 @Override iterator()80 public Iterator<E> iterator() { 81 // We explicitly don't lock for iterator() 82 assertFalse(Thread.holdsLock(mutex)); 83 return delegate.iterator(); 84 } 85 86 @Override size()87 public int size() { 88 assertTrue(Thread.holdsLock(mutex)); 89 return delegate.size(); 90 } 91 92 @Override removeAll(Collection<?> collection)93 public boolean removeAll(Collection<?> collection) { 94 assertTrue(Thread.holdsLock(mutex)); 95 return delegate.removeAll(collection); 96 } 97 98 @Override isEmpty()99 public boolean isEmpty() { 100 assertTrue(Thread.holdsLock(mutex)); 101 return delegate.isEmpty(); 102 } 103 104 @Override contains(Object object)105 public boolean contains(Object object) { 106 assertTrue(Thread.holdsLock(mutex)); 107 return delegate.contains(object); 108 } 109 110 @Override add(E element)111 public boolean add(E element) { 112 assertTrue(Thread.holdsLock(mutex)); 113 return delegate.add(element); 114 } 115 116 @Override containsAll(Collection<?> collection)117 public boolean containsAll(Collection<?> collection) { 118 assertTrue(Thread.holdsLock(mutex)); 119 return delegate.containsAll(collection); 120 } 121 122 @Override addAll(Collection<? extends E> collection)123 public boolean addAll(Collection<? extends E> collection) { 124 assertTrue(Thread.holdsLock(mutex)); 125 return delegate.addAll(collection); 126 } 127 128 @Override retainAll(Collection<?> collection)129 public boolean retainAll(Collection<?> collection) { 130 assertTrue(Thread.holdsLock(mutex)); 131 return delegate.retainAll(collection); 132 } 133 134 @Override clear()135 public void clear() { 136 assertTrue(Thread.holdsLock(mutex)); 137 delegate.clear(); 138 } 139 140 @Override toArray()141 public Object[] toArray() { 142 assertTrue(Thread.holdsLock(mutex)); 143 return delegate.toArray(); 144 } 145 146 @Override toArray(T[] array)147 public <T> T[] toArray(T[] array) { 148 assertTrue(Thread.holdsLock(mutex)); 149 return delegate.toArray(array); 150 } 151 152 private static final long serialVersionUID = 0; 153 } 154 155 @SuppressWarnings("CheckReturnValue") testHoldsLockOnAllOperations()156 public void testHoldsLockOnAllOperations() { 157 create().element(); 158 create().offer("foo"); 159 create().peek(); 160 create().poll(); 161 create().remove(); 162 create().add("foo"); 163 create().addAll(ImmutableList.of("foo")); 164 create().clear(); 165 create().contains("foo"); 166 create().containsAll(ImmutableList.of("foo")); 167 create().equals(new ArrayDeque<>(ImmutableList.of("foo"))); 168 create().hashCode(); 169 create().isEmpty(); 170 create().iterator(); 171 create().remove("foo"); 172 create().removeAll(ImmutableList.of("foo")); 173 create().retainAll(ImmutableList.of("foo")); 174 create().size(); 175 create().toArray(); 176 create().toArray(new String[] {"foo"}); 177 } 178 } 179