Polish microsphere-projects#161 : Update JavaDoc

Author: mercyblitz

microsphere-java-core/src/main/java/io/microsphere/collection/UnmodifiableDeque.java

@@ -0,0 +1,131 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.microsphere.collection;
+
+import java.io.Serializable;
+import java.util.Deque;
+import java.util.Iterator;
+
+import static io.microsphere.collection.CollectionUtils.unmodifiableIterator;
+
+
+/**
+ * An unmodifiable view of a {@link Deque} which wraps a given delegate and prevents any modifications to it.
+ * <p>
+ * All mutation operations like {@link #addFirst(Object)}, {@link #remove()}, or {@link #push(Object)} will throw an
+ * {@link UnsupportedOperationException}.
+ * </p>
+ *
+ * @param <E> the type of elements held in this deque
+ * @author <a href="mailto:mercyblitz@gmail.com">Mercy<a/>
+ * @since 1.0.0
+ */
+public class UnmodifiableDeque<E> extends UnmodifiableQueue<E> implements Deque<E>, Serializable {
+
+    private final Deque<E> delegate;
+
+    public UnmodifiableDeque(Deque<E> deque) {
+        super(deque);
+        this.delegate = deque;
+    }
+
+    @Override
+    public void addFirst(E e) {
+        throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public void addLast(E e) {
+        throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public boolean offerFirst(E e) {
+        throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public boolean offerLast(E e) {
+        throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public E removeFirst() {
+        throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public E removeLast() {
+        throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public E pollFirst() {
+        throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public E pollLast() {
+        throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public E getFirst() {
+        return delegate.getFirst();
+    }
+
+    @Override
+    public E getLast() {
+        return delegate.getLast();
+    }
+
+    @Override
+    public E peekFirst() {
+        return getFirst();
+    }
+
+    @Override
+    public E peekLast() {
+        return getLast();
+    }
+
+    @Override
+    public boolean removeFirstOccurrence(Object o) {
+        throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public boolean removeLastOccurrence(Object o) {
+        throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public void push(E e) {
+        throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public E pop() {
+        throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public Iterator<E> descendingIterator() {
+        return unmodifiableIterator(delegate.descendingIterator());
+    }
+}