You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by el...@apache.org on 2016/12/03 18:01:04 UTC
[1/3] mina git commit: Added mising javadoc
Repository: mina
Updated Branches:
refs/heads/2.0 894c28cfc -> 756ea4270
Added mising javadoc
Project: http://git-wip-us.apache.org/repos/asf/mina/repo
Commit: http://git-wip-us.apache.org/repos/asf/mina/commit/3a389cbf
Tree: http://git-wip-us.apache.org/repos/asf/mina/tree/3a389cbf
Diff: http://git-wip-us.apache.org/repos/asf/mina/diff/3a389cbf
Branch: refs/heads/2.0
Commit: 3a389cbf6d02f4971d7667e4f00726e464b82911
Parents: 894c28c
Author: Emmanuel L�charny <el...@symas.com>
Authored: Sat Dec 3 15:50:09 2016 +0100
Committer: Emmanuel L�charny <el...@symas.com>
Committed: Sat Dec 3 15:50:09 2016 +0100
----------------------------------------------------------------------
.../org/apache/mina/util/SynchronizedQueue.java | 136 +++++++++++++++----
1 file changed, 112 insertions(+), 24 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mina/blob/3a389cbf/mina-core/src/main/java/org/apache/mina/util/SynchronizedQueue.java
----------------------------------------------------------------------
diff --git a/mina-core/src/main/java/org/apache/mina/util/SynchronizedQueue.java b/mina-core/src/main/java/org/apache/mina/util/SynchronizedQueue.java
index 738dea4..deda3bb 100644
--- a/mina-core/src/main/java/org/apache/mina/util/SynchronizedQueue.java
+++ b/mina-core/src/main/java/org/apache/mina/util/SynchronizedQueue.java
@@ -28,102 +28,190 @@ import java.util.Queue;
* A decorator that makes the specified {@link Queue} thread-safe.
* Like any other synchronizing wrappers, iteration is not thread-safe.
*
+ * @param <E> The type of elements stored in the queue
+ *
* @author <a href="http://mina.apache.org">Apache MINA Project</a>
*/
public class SynchronizedQueue<E> implements Queue<E>, Serializable {
private static final long serialVersionUID = -1439242290701194806L;
- private final Queue<E> q;
+ private final Queue<E> queue;
- public SynchronizedQueue(Queue<E> q) {
- this.q = q;
+ /**
+ * Create a new SynchronizedQueue instance
+ *
+ * @param queue The queue
+ */
+ public SynchronizedQueue(Queue<E> queue) {
+ this.queue = queue;
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public synchronized boolean add(E e) {
- return q.add(e);
+ return queue.add(e);
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public synchronized E element() {
- return q.element();
+ return queue.element();
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public synchronized boolean offer(E e) {
- return q.offer(e);
+ return queue.offer(e);
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public synchronized E peek() {
- return q.peek();
+ return queue.peek();
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public synchronized E poll() {
- return q.poll();
+ return queue.poll();
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public synchronized E remove() {
- return q.remove();
+ return queue.remove();
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public synchronized boolean addAll(Collection<? extends E> c) {
- return q.addAll(c);
+ return queue.addAll(c);
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public synchronized void clear() {
- q.clear();
+ queue.clear();
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public synchronized boolean contains(Object o) {
- return q.contains(o);
+ return queue.contains(o);
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public synchronized boolean containsAll(Collection<?> c) {
- return q.containsAll(c);
+ return queue.containsAll(c);
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public synchronized boolean isEmpty() {
- return q.isEmpty();
+ return queue.isEmpty();
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public synchronized Iterator<E> iterator() {
- return q.iterator();
+ return queue.iterator();
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public synchronized boolean remove(Object o) {
- return q.remove(o);
+ return queue.remove(o);
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public synchronized boolean removeAll(Collection<?> c) {
- return q.removeAll(c);
+ return queue.removeAll(c);
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public synchronized boolean retainAll(Collection<?> c) {
- return q.retainAll(c);
+ return queue.retainAll(c);
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public synchronized int size() {
- return q.size();
+ return queue.size();
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public synchronized Object[] toArray() {
- return q.toArray();
+ return queue.toArray();
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public synchronized <T> T[] toArray(T[] a) {
- return q.toArray(a);
+ return queue.toArray(a);
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public synchronized boolean equals(Object obj) {
- return q.equals(obj);
+ return queue.equals(obj);
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public synchronized int hashCode() {
- return q.hashCode();
+ return queue.hashCode();
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public synchronized String toString() {
- return q.toString();
+ return queue.toString();
}
}
\ No newline at end of file
[3/3] mina git commit: Added some missing Javadoc
Posted by el...@apache.org.
Added some missing Javadoc
Project: http://git-wip-us.apache.org/repos/asf/mina/repo
Commit: http://git-wip-us.apache.org/repos/asf/mina/commit/756ea427
Tree: http://git-wip-us.apache.org/repos/asf/mina/tree/756ea427
Diff: http://git-wip-us.apache.org/repos/asf/mina/diff/756ea427
Branch: refs/heads/2.0
Commit: 756ea42708d915726ca8e1d75b11204bac578a27
Parents: c7209e0
Author: Emmanuel L�charny <el...@symas.com>
Authored: Sat Dec 3 18:53:04 2016 +0100
Committer: Emmanuel L�charny <el...@symas.com>
Committed: Sat Dec 3 18:53:04 2016 +0100
----------------------------------------------------------------------
.../org/apache/mina/util/ConcurrentHashSet.java | 23 ++++++++++++++++----
1 file changed, 19 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mina/blob/756ea427/mina-core/src/main/java/org/apache/mina/util/ConcurrentHashSet.java
----------------------------------------------------------------------
diff --git a/mina-core/src/main/java/org/apache/mina/util/ConcurrentHashSet.java b/mina-core/src/main/java/org/apache/mina/util/ConcurrentHashSet.java
index a27e014..6fca915 100644
--- a/mina-core/src/main/java/org/apache/mina/util/ConcurrentHashSet.java
+++ b/mina-core/src/main/java/org/apache/mina/util/ConcurrentHashSet.java
@@ -26,6 +26,8 @@ import java.util.concurrent.ConcurrentMap;
/**
* A {@link ConcurrentHashMap}-backed {@link Set}.
+ *
+ * @param <E> The type of the element stored in the set
*
* @author <a href="http://mina.apache.org">Apache MINA Project</a>
*/
@@ -33,17 +35,30 @@ public class ConcurrentHashSet<E> extends MapBackedSet<E> {
private static final long serialVersionUID = 8518578988740277828L;
+ /**
+ * Creates a new instance of ConcurrentHashSet
+ */
public ConcurrentHashSet() {
super(new ConcurrentHashMap<E, Boolean>());
}
- public ConcurrentHashSet(Collection<E> c) {
- super(new ConcurrentHashMap<E, Boolean>(), c);
+ /**
+ * Creates a new instance of ConcurrentHashSet, initialized with
+ * the content of another collection
+ *
+ * @param collection The collection to inject in this set
+ */
+ public ConcurrentHashSet(Collection<E> collection) {
+ super(new ConcurrentHashMap<E, Boolean>(), collection);
}
+ /**
+ * {@inheritDoc}
+ */
@Override
- public boolean add(E o) {
- Boolean answer = ((ConcurrentMap<E, Boolean>) map).putIfAbsent(o, Boolean.TRUE);
+ public boolean add(E element) {
+ Boolean answer = ((ConcurrentMap<E, Boolean>) map).putIfAbsent(element, Boolean.TRUE);
+
return answer == null;
}
}
[2/3] mina git commit: Added some missing Javadoc
Posted by el...@apache.org.
Added some missing Javadoc
Project: http://git-wip-us.apache.org/repos/asf/mina/repo
Commit: http://git-wip-us.apache.org/repos/asf/mina/commit/c7209e09
Tree: http://git-wip-us.apache.org/repos/asf/mina/tree/c7209e09
Diff: http://git-wip-us.apache.org/repos/asf/mina/diff/c7209e09
Branch: refs/heads/2.0
Commit: c7209e0995ac146a339e6bd1b4b8c79f2b1a72ff
Parents: 3a389cb
Author: Emmanuel L�charny <el...@symas.com>
Authored: Sat Dec 3 18:50:38 2016 +0100
Committer: Emmanuel L�charny <el...@symas.com>
Committed: Sat Dec 3 18:50:38 2016 +0100
----------------------------------------------------------------------
.../org/apache/mina/util/CircularQueue.java | 61 +++++++++++++++++++-
1 file changed, 59 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mina/blob/c7209e09/mina-core/src/main/java/org/apache/mina/util/CircularQueue.java
----------------------------------------------------------------------
diff --git a/mina-core/src/main/java/org/apache/mina/util/CircularQueue.java b/mina-core/src/main/java/org/apache/mina/util/CircularQueue.java
index db95929..fa701d1 100644
--- a/mina-core/src/main/java/org/apache/mina/util/CircularQueue.java
+++ b/mina-core/src/main/java/org/apache/mina/util/CircularQueue.java
@@ -28,6 +28,8 @@ import java.util.Queue;
/**
* A unbounded circular queue based on array.
*
+ * @param <E> The type of elements stored inthe queue
+ *
* @author <a href="http://mina.apache.org">Apache MINA Project</a>
*/
public class CircularQueue<E> extends AbstractList<E> implements Queue<E>, Serializable {
@@ -56,12 +58,17 @@ public class CircularQueue<E> extends AbstractList<E> implements Queue<E>, Seria
private int shrinkThreshold;
/**
- * Construct a new, empty queue.
+ * Construct a new, empty, circular queue.
*/
public CircularQueue() {
this(DEFAULT_CAPACITY);
}
+ /**
+ * Construct a new circular queue with an initial capacity.
+ *
+ * @param initialCapacity The initial capacity of this circular queue
+ */
public CircularQueue(int initialCapacity) {
int actualCapacity = normalizeCapacity(initialCapacity);
items = new Object[actualCapacity];
@@ -93,6 +100,9 @@ public class CircularQueue<E> extends AbstractList<E> implements Queue<E>, Seria
return items.length;
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public void clear() {
if (!isEmpty()) {
@@ -104,6 +114,10 @@ public class CircularQueue<E> extends AbstractList<E> implements Queue<E>, Seria
}
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
@SuppressWarnings("unchecked")
public E poll() {
if (isEmpty()) {
@@ -122,6 +136,10 @@ public class CircularQueue<E> extends AbstractList<E> implements Queue<E>, Seria
return (E) ret;
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public boolean offer(E item) {
if (item == null) {
throw new IllegalArgumentException("item");
@@ -133,6 +151,10 @@ public class CircularQueue<E> extends AbstractList<E> implements Queue<E>, Seria
return true;
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
@SuppressWarnings("unchecked")
public E peek() {
if (isEmpty()) {
@@ -142,6 +164,9 @@ public class CircularQueue<E> extends AbstractList<E> implements Queue<E>, Seria
return (E) items[first];
}
+ /**
+ * {@inheritDoc}
+ */
@SuppressWarnings("unchecked")
@Override
public E get(int idx) {
@@ -149,11 +174,17 @@ public class CircularQueue<E> extends AbstractList<E> implements Queue<E>, Seria
return (E) items[getRealIndex(idx)];
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public boolean isEmpty() {
return (first == last) && !full;
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public int size() {
if (full) {
@@ -167,6 +198,9 @@ public class CircularQueue<E> extends AbstractList<E> implements Queue<E>, Seria
return last - first + capacity();
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public String toString() {
return "first=" + first + ", last=" + last + ", size=" + size() + ", mask = " + mask;
@@ -210,6 +244,7 @@ public class CircularQueue<E> extends AbstractList<E> implements Queue<E>, Seria
last = oldLen;
items = tmp;
mask = tmp.length - 1;
+
if (newLen >>> 3 > initialCapacity) {
shrinkThreshold = newLen >>> 3;
}
@@ -218,10 +253,12 @@ public class CircularQueue<E> extends AbstractList<E> implements Queue<E>, Seria
private void shrinkIfNeeded() {
int size = size();
+
if (size <= shrinkThreshold) {
// shrink queue
final int oldLen = items.length;
int newLen = normalizeCapacity(size);
+
if (size == newLen) {
newLen <<= 1;
}
@@ -258,11 +295,17 @@ public class CircularQueue<E> extends AbstractList<E> implements Queue<E>, Seria
}
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public boolean add(E o) {
return offer(o);
}
+ /**
+ * {@inheritDoc}
+ */
@SuppressWarnings("unchecked")
@Override
public E set(int idx, E o) {
@@ -274,6 +317,9 @@ public class CircularQueue<E> extends AbstractList<E> implements Queue<E>, Seria
return (E) old;
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public void add(int idx, E o) {
if (idx == size()) {
@@ -303,8 +349,11 @@ public class CircularQueue<E> extends AbstractList<E> implements Queue<E>, Seria
increaseSize();
}
- @SuppressWarnings("unchecked")
+ /**
+ * {@inheritDoc}
+ */
@Override
+ @SuppressWarnings("unchecked")
public E remove(int idx) {
if (idx == 0) {
return poll();
@@ -335,6 +384,10 @@ public class CircularQueue<E> extends AbstractList<E> implements Queue<E>, Seria
return (E) removed;
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public E remove() {
if (isEmpty()) {
throw new NoSuchElementException();
@@ -342,6 +395,10 @@ public class CircularQueue<E> extends AbstractList<E> implements Queue<E>, Seria
return poll();
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public E element() {
if (isEmpty()) {
throw new NoSuchElementException();