opennlp.tools.util
Class NumberedSet

java.lang.Object
  opennlp.tools.util.NumberedSet

All Implemented Interfaces:

java.lang.Iterable, java.util.Collection, java.util.Set

Direct Known Subclasses:

CountedNumberedSet

public class NumberedSet
extends java.lang.Object
implements java.util.Set

Class which keeps a set of values and assigns each value a unique positive index. The index can be accessed using the #getIndex() method.

Author:

tsmorton

Constructor Summary

NumberedSet()

NumberedSet(int size)

Method Summary

boolean	add(java.lang.Object arg0)
boolean	addAll(java.util.Collection c)
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection c)
int	getIndex(java.lang.Object key) Returns the index for the specified key or -1 if specified value is not contain in this set.
boolean	isEmpty()
java.util.Iterator	iterator()
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection c)
boolean	retainAll(java.util.Collection c)
void	setIndex(java.lang.Object key, int index)
int	size()
java.lang.Object[]	toArray()
java.lang.Object[]	toArray(java.lang.Object[] arg0)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

equals, hashCode

Constructor Detail

NumberedSet

public NumberedSet()

NumberedSet

public NumberedSet(int size)

Method Detail

getIndex

public int getIndex(java.lang.Object key)

Returns the index for the specified key or -1 if specified value is not contain in this set.

Parameters:

key - The key to be checked.

Returns:

the index for the specified value or -1 if specified value is not contain in this set

setIndex

public void setIndex(java.lang.Object key,
                     int index)

size

public int size()

Specified by:

size in interface java.util.Collection

Specified by:

size in interface java.util.Set

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection

Specified by:

isEmpty in interface java.util.Set

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection

Specified by:

contains in interface java.util.Set

iterator

public java.util.Iterator iterator()

Specified by:

iterator in interface java.lang.Iterable

Specified by:

iterator in interface java.util.Collection

Specified by:

iterator in interface java.util.Set

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection

Specified by:

toArray in interface java.util.Set

toArray

public java.lang.Object[] toArray(java.lang.Object[] arg0)

Specified by:

toArray in interface java.util.Collection

Specified by:

toArray in interface java.util.Set

add

public boolean add(java.lang.Object arg0)

Specified by:

add in interface java.util.Collection

Specified by:

add in interface java.util.Set

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection

Specified by:

remove in interface java.util.Set

containsAll

public boolean containsAll(java.util.Collection c)

Specified by:

containsAll in interface java.util.Collection

Specified by:

containsAll in interface java.util.Set

addAll

public boolean addAll(java.util.Collection c)

Specified by:

addAll in interface java.util.Collection

Specified by:

addAll in interface java.util.Set

retainAll

public boolean retainAll(java.util.Collection c)

Specified by:

retainAll in interface java.util.Collection

Specified by:

retainAll in interface java.util.Set

removeAll

public boolean removeAll(java.util.Collection c)

Specified by:

removeAll in interface java.util.Collection

Specified by:

removeAll in interface java.util.Set

clear

public void clear()

Specified by:

clear in interface java.util.Collection

Specified by:

clear in interface java.util.Set