summaryrefslogtreecommitdiff
path: root/src/de/lmu/ifi/dbs/elki/database/ids/DBIDs.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/de/lmu/ifi/dbs/elki/database/ids/DBIDs.java')
-rw-r--r--src/de/lmu/ifi/dbs/elki/database/ids/DBIDs.java30
1 files changed, 21 insertions, 9 deletions
diff --git a/src/de/lmu/ifi/dbs/elki/database/ids/DBIDs.java b/src/de/lmu/ifi/dbs/elki/database/ids/DBIDs.java
index ef83ba69..e9a3e0ab 100644
--- a/src/de/lmu/ifi/dbs/elki/database/ids/DBIDs.java
+++ b/src/de/lmu/ifi/dbs/elki/database/ids/DBIDs.java
@@ -32,18 +32,21 @@ import java.util.Iterator;
*
* @apiviz.landmark
* @apiviz.composedOf DBID
+ * @apiviz.has DBIDIter
*/
public interface DBIDs extends Iterable<DBID> {
/**
- * Retrieve Iterator access to the IDs.
+ * Get a DBID iterator (a more efficient API).
*
- * @return an iterator for the IDs
- */
- @Override
- public Iterator<DBID> iterator();
-
- /**
- * Get a DBIDIterator (a more efficient API).
+ * usage example:
+ *
+ * <pre>
+ * {@code
+ * for(DBIDIter iter = ids.iter(); iter.valid(); iter.advance()) {
+ * DBID id = iter.getDBID();
+ * }
+ * }
+ * </pre>
*
* @return iterator
*/
@@ -62,7 +65,7 @@ public interface DBIDs extends Iterable<DBID> {
* @param o object to test
* @return true when contained
*/
- public boolean contains(DBID o);
+ public boolean contains(DBIDRef o);
/**
* Test for an empty DBID collection.
@@ -70,4 +73,13 @@ public interface DBIDs extends Iterable<DBID> {
* @return true when empty.
*/
public boolean isEmpty();
+
+ /**
+ * Classic iterator.
+ *
+ * @deprecated Use {@link DBIDIter} API instead.
+ */
+ @Override
+ @Deprecated
+ public Iterator<DBID> iterator();
}