summaryrefslogtreecommitdiff
path: root/sources/utils/VSPriorityQueue.java
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2008-05-29 20:30:46 +0000
committerPaul Buetow <paul@buetow.org>2008-05-29 20:30:46 +0000
commitdf1dbe48b99a5c86345a58d6da5727cb39547727 (patch)
tree6f3a83225f47592e94b1a1ba9953707f348ad21f /sources/utils/VSPriorityQueue.java
parenta4d12944746dcb4f9d1140dfd52c7d58b930c17d (diff)
new package documented.
Diffstat (limited to 'sources/utils/VSPriorityQueue.java')
-rw-r--r--sources/utils/VSPriorityQueue.java11
1 files changed, 8 insertions, 3 deletions
diff --git a/sources/utils/VSPriorityQueue.java b/sources/utils/VSPriorityQueue.java
index 5b6b765..b320c1d 100644
--- a/sources/utils/VSPriorityQueue.java
+++ b/sources/utils/VSPriorityQueue.java
@@ -7,17 +7,22 @@ package utils;
import java.util.PriorityQueue;
/**
- * The Class VSPriorityQueue.
+ * The Class VSPriorityQueue. This class is the same like the standard
+ * VSPriorityQueue of the Java API. It only overrides the get(int) method.
+ *
+ * @author Paul C. Buetow
*/
public final class VSPriorityQueue<T> extends PriorityQueue<T> {
+ /** The serial version uid */
private static final long serialVersionUID = 1L;
/**
- * Gets the element.
+ * Gets the specific element. If the index is out of bounds, it will return
+ * null.
*
* @param index the index
*
- * @return the element.
+ * @return the element, or null, if out of bounds
*/
public T get(int index) {
int i = 0;