de.lmu.ifi.dbs.elki.database.ids.generic

Class UnmodifiableDBIDs

java.lang.Object

de.lmu.ifi.dbs.elki.database.ids.generic.UnmodifiableDBIDs

All Implemented Interfaces:

DBIDs, StaticDBIDs

public class UnmodifiableDBIDs
extends Object
implements StaticDBIDs

Unmodifiable wrapper for DBIDs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	UnmodifiableDBIDs.UnmodifiableDBIDIter Make an existing DBIDMIter unmodifiable.

Field Summary

Fields

Modifier and Type	Field and Description
private DBIDs	inner The DBIDs we wrap.

Constructor Summary

Constructors

Constructor and Description
UnmodifiableDBIDs(DBIDs inner) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(DBIDRef o) Test whether an ID is contained.
boolean	isEmpty() Test for an empty DBID collection.
DBIDIter	iter() Get a DBID iterator (a more efficient API).
int	size() Retrieve the collection / data size.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

inner

private final DBIDs inner

The DBIDs we wrap.

Constructor Detail

UnmodifiableDBIDs

public UnmodifiableDBIDs(DBIDs inner)

Constructor.

Parameters:

inner - Inner DBID collection.

Method Detail

contains

public boolean contains(DBIDRef o)

Description copied from interface: DBIDs

Test whether an ID is contained.

Specified by:

contains in interface DBIDs

Parameters:

o - object to test

Returns:

true when contained

isEmpty

public boolean isEmpty()

Description copied from interface: DBIDs

Test for an empty DBID collection.

Specified by:

isEmpty in interface DBIDs

Returns:

true when empty.

iter

public DBIDIter iter()

Description copied from interface: DBIDs

Get a DBID iterator (a more efficient API). usage example:

 for(DBIDIter iter = ids.iter(); iter.valid(); iter.advance()) {
   DBID id = iter.getDBID();
 }
 
 

Specified by:

iter in interface DBIDs

Returns:

iterator

size

public int size()

Description copied from interface: DBIDs

Retrieve the collection / data size.

Specified by:

size in interface DBIDs

Returns:

collection size

toString

public String toString()

Overrides:

toString in class Object