summaryrefslogtreecommitdiffstats
path: root/src/java/com/jogamp/common/util/Ringbuffer.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/java/com/jogamp/common/util/Ringbuffer.java')
-rw-r--r--src/java/com/jogamp/common/util/Ringbuffer.java58
1 files changed, 29 insertions, 29 deletions
diff --git a/src/java/com/jogamp/common/util/Ringbuffer.java b/src/java/com/jogamp/common/util/Ringbuffer.java
index e524768..7faf5dd 100644
--- a/src/java/com/jogamp/common/util/Ringbuffer.java
+++ b/src/java/com/jogamp/common/util/Ringbuffer.java
@@ -3,14 +3,14 @@
*
* Redistribution and use in source and binary forms, with or without modification, are
* permitted provided that the following conditions are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
- *
+ *
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
* of conditions and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
- *
+ *
* THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
@@ -20,7 +20,7 @@
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
+ *
* The views and conclusions contained in the software and documentation are those of the
* authors and should not be interpreted as representing official policies, either expressed
* or implied, of JogAmp Community.
@@ -29,7 +29,7 @@ package com.jogamp.common.util;
import java.io.PrintStream;
-/**
+/**
* Ring buffer interface, a.k.a circular buffer.
* <p>
* Caller can chose whether to block until get / put is able to proceed or not.
@@ -39,26 +39,26 @@ import java.io.PrintStream;
* or using a preset array for circular access of same objects.
* </p>
* <p>
- * Synchronization and hence thread safety details belong to the implementation.
+ * Synchronization and hence thread safety details belong to the implementation.
* </p>
*/
public interface Ringbuffer<T> {
-
- /** Returns a short string representation incl. size/capacity and internal r/w index (impl. dependent). */
+
+ /** Returns a short string representation incl. size/capacity and internal r/w index (impl. dependent). */
public String toString();
/** Debug functionality - Dumps the contents of the internal array. */
public void dump(PrintStream stream, String prefix);
- /**
+ /**
* Returns the internal array as-is, i.e. w/o a copy.
* <p>
* The layout and size of the internal array is implementation dependent.
- * </p>
+ * </p>
* <p>
* Users shall not modify or rely on the returned array.
- * </p>
- * @deprecated This method should not be required
+ * </p>
+ * @deprecated This method should not be required
*/
public T[] getInternalArray();
@@ -66,7 +66,7 @@ public interface Ringbuffer<T> {
public int capacity();
/**
- * Resets the read and write position according to an empty ring buffer
+ * Resets the read and write position according to an empty ring buffer
* and set all ring buffer slots to <code>null</code>.
* <p>
* {@link #isEmpty()} will return <code>true</code> after calling this method.
@@ -75,14 +75,14 @@ public interface Ringbuffer<T> {
public void clear();
/**
- * Resets the read and write position according to a full ring buffer
+ * Resets the read and write position according to a full ring buffer
* and fill all slots w/ elements of array <code>copyFrom</code>.
* <p>
- * Array's <code>copyFrom</code> elements will be copied into the internal array,
+ * Array's <code>copyFrom</code> elements will be copied into the internal array,
* hence it's length must be equal to {@link #capacity()}.
* </p>
* @param copyFrom Mandatory array w/ length {@link #capacity()} to be copied into the internal array.
- * @throws IllegalArgumentException if <code>copyFrom</code> is <code>null</code>.
+ * @throws IllegalArgumentException if <code>copyFrom</code> is <code>null</code>.
* @throws IllegalArgumentException if <code>copyFrom</code>'s length is different from {@link #capacity()}.
*/
public void resetFull(T[] copyFrom) throws IllegalArgumentException;
@@ -108,7 +108,7 @@ public interface Ringbuffer<T> {
* <p>
* Method is non blocking and returns immediately;.
* </p>
- * @return the oldest put element if available, otherwise null.
+ * @return the oldest put element if available, otherwise null.
*/
public T get();
@@ -121,24 +121,24 @@ public interface Ringbuffer<T> {
* <p>
* Methods blocks until an element becomes available via put.
* </p>
- * @return the oldest put element
- * @throws InterruptedException
+ * @return the oldest put element
+ * @throws InterruptedException
*/
public T getBlocking() throws InterruptedException;
- /**
+ /**
* Peeks the next element at the read position w/o modifying pointer, nor blocking.
* @return <code>null</code> if empty, otherwise the element which would be read next.
*/
public T peek();
- /**
+ /**
* Peeks the next element at the read position w/o modifying pointer, but w/ blocking.
* @return <code>null</code> if empty, otherwise the element which would be read next.
*/
public T peekBlocking() throws InterruptedException;
- /**
+ /**
* Enqueues the given element.
* <p>
* Returns true if successful, otherwise false in case buffer is full.
@@ -149,16 +149,16 @@ public interface Ringbuffer<T> {
*/
public boolean put(T e);
- /**
+ /**
* Enqueues the given element.
* <p>
* Method blocks until a free slot becomes available via get.
* </p>
- * @throws InterruptedException
+ * @throws InterruptedException
*/
public void putBlocking(T e) throws InterruptedException;
- /**
+ /**
* Enqueues the same element at it's write position, if not full.
* <p>
* Returns true if successful, otherwise false in case buffer is full.
@@ -167,7 +167,7 @@ public interface Ringbuffer<T> {
* If <code>blocking</code> is true, method blocks until a free slot becomes available via get.
* </p>
* @param blocking if true, wait until a free slot becomes available via get.
- * @throws InterruptedException
+ * @throws InterruptedException
*/
public boolean putSame(boolean blocking) throws InterruptedException;
@@ -183,13 +183,13 @@ public interface Ringbuffer<T> {
* Growing an empty ring buffer increases it's size about the amount, i.e. renders it not empty.
* The new elements are inserted at the read position, able to be read out via {@link #get()} etc.
* </p>
- *
+ *
* @param newElements array of new full elements the empty buffer shall grow about.
* @throws IllegalStateException if buffer is not empty
* @throws IllegalArgumentException if newElements is null
*/
public void growEmptyBuffer(T[] newElements) throws IllegalStateException, IllegalArgumentException;
-
+
/**
* Grows a full ring buffer, increasing it's capacity about the amount.
* <p>
@@ -197,7 +197,7 @@ public interface Ringbuffer<T> {
* New <code>null</code> elements are inserted at the write position, able to be written to via {@link #put(Object)} etc.
* </p>
* @param amount the amount of elements the buffer shall grow about
- *
+ *
* @throws IllegalStateException if buffer is not full
* @throws IllegalArgumentException if amount is < 0
*/