Merge "Replace project-specific checkstyle by odlparent's"
[openflowplugin.git] / openflowplugin-api / src / main / java / org / opendaylight / openflowplugin / api / openflow / md / util / PollableQueuesPriorityZipper.java
index f28876eded2a053ea11a99492b54051ab59f1ba3..55ca10a5700592f6206ef4f82b91edbc68c3f410 100644 (file)
@@ -1,6 +1,6 @@
-/**
+/*
  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
- * 
+ *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
@@ -13,37 +13,31 @@ import java.util.Queue;
  * Zipper groups together a list of queues and exposes one poll method. Polling
  * iterates through all groups and returns first not-null result of poll method
  * on each queue. If after polling each grouped queue for one time there is
- * still null result, poll will return null. <br/>
+ * still null result, poll will return null. <br>
  * Iterating keeps last position so this polling is supposed to be fairly
  * distributed.
- * 
- * @param <T>
- *            common item type of zipped queues
+ *
+ * @param <T> common item type of zipped queues
  */
 public class PollableQueuesPriorityZipper<T> {
 
     private Queue<T> prioritizedSource;
     private PollableQueuesZipper<T> zipper;
 
-    /**
-     * default ctor
-     */
     public PollableQueuesPriorityZipper() {
         zipper = new PollableQueuesZipper<>();
     }
 
     /**
-     * Add all member queues before first invocation of
-     * {@link PollableQueuesPriorityZipper#poll()}
-     * 
-     * @param queue
-     *            to be added to group
+     * Add all member queues before first invocation of {@link PollableQueuesPriorityZipper#poll()}.
+     * @param queue to be added to group
      */
     public void addSource(Queue<T> queue) {
         zipper.addSource(queue);
     }
 
     /**
+     * Next common product.
      * @return next common product of polling member groups
      */
     public T poll() {