gnu.trove.decorator

Class TShortHashSetDecorator

Implemented Interfaces:
Set

public class TShortHashSetDecorator
extends AbstractSet
implements Set

Wrapper class to make a TShortHashSet conform to the java.util.Set API. This class simply decorates an underlying TShortHashSet and translates the Object-based APIs into their Trove primitive analogs.

Note that wrapping and unwrapping primitive values is extremely inefficient. If possible, users of this class should override the appropriate methods in this class and use a table of canonical values.

Created: Tue Sep 24 22:08:17 PDT 2002

Author:
Eric D. Friedman

Field Summary

protected TShortHashSet
_set
the wrapped primitive set

Constructor Summary

TShortHashSetDecorator(TShortHashSet set)
Creates a wrapper that decorates the specified primitive set.

Method Summary

boolean
add(Short value)
Inserts a value into the set.
void
clear()
Empties the set.
TShortHashSetDecorator
clone()
Clones the underlying trove collection and returns the clone wrapped in a new decorator instance.
boolean
equals(Object other)
Compares this set with another set for equality of their stored entries.
TShortHashSet
getSet()
Returns a reference to the set wrapped by this decorator.
boolean
isEmpty()
Indicates whether set has any entries.
Iterator
iterator()
Creates an iterator over the values of the set.
boolean
remove(Object value)
Deletes a value from the set.
int
size()
Returns the number of entries in the set.
protected short
unwrap(Object value)
Unwraps a value
protected Short
wrap(short k)
Wraps a value

Field Details

_set

protected TShortHashSet _set
the wrapped primitive set

Constructor Details

TShortHashSetDecorator

public TShortHashSetDecorator(TShortHashSet set)
Creates a wrapper that decorates the specified primitive set.

Method Details

add

public boolean add(Short value)
Inserts a value into the set.
Parameters:
value - true if the set was modified by the insertion

clear

public void clear()
Empties the set.

clone

public TShortHashSetDecorator clone()
Clones the underlying trove collection and returns the clone wrapped in a new decorator instance. This is a shallow clone except where primitives are concerned.
Returns:
a copy of the receiver

equals

public boolean equals(Object other)
Compares this set with another set for equality of their stored entries.
Parameters:
other - an Object value
Returns:
true if the sets are identical

getSet

public TShortHashSet getSet()
Returns a reference to the set wrapped by this decorator.

isEmpty

public boolean isEmpty()
Indicates whether set has any entries.
Returns:
true if the set is empty

iterator

public Iterator iterator()
Creates an iterator over the values of the set.
Returns:
an iterator with support for removals in the underlying set

remove

public boolean remove(Object value)
Deletes a value from the set.
Parameters:
value - an Object value
Returns:
true if the set was modified

size

public int size()
Returns the number of entries in the set.
Returns:
the set's size.

unwrap

protected short unwrap(Object value)
Unwraps a value
Parameters:
value - wrapped value
Returns:
an unwrapped representation of the value

wrap

protected Short wrap(short k)
Wraps a value
Parameters:
k - value in the underlying set
Returns:
an Object representation of the value

GNU Trove is copyright B) 2001-2008 Eric D. Friedman. All Rights Reserved.