gnu.trove.decorator
Class TCharSetDecorator

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractSet<java.lang.Character>
          gnu.trove.decorator.TCharSetDecorator

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Iterable<java.lang.Character>, java.util.Collection<java.lang.Character>, java.util.Set<java.lang.Character>

public class TCharSetDecorator
extends java.util.AbstractSet<java.lang.Character>
implements java.util.Set<java.lang.Character>, java.io.Externalizable

Wrapper class to make a TCharSet conform to the java.util.Set API. This class simply decorates an underlying TCharSet 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

See Also:

Serialized Form

Field Summary

protected TCharSet

_set the wrapped primitive set

Constructor Summary

TCharSetDecorator()
FOR EXTERNALIZATION ONLY!!

TCharSetDecorator(TCharSet set)
Creates a wrapper that decorates the specified primitive set.

Method Summary

boolean	add(java.lang.Character value) Inserts a value into the set.
void	clear() Empties the set.
boolean	contains(java.lang.Object o)
boolean	equals(java.lang.Object other) Compares this set with another set for equality of their stored entries.
TCharSet	getSet() Returns a reference to the set wrapped by this decorator.
boolean	isEmpty() Indicates whether set has any entries.
java.util.Iterator<java.lang.Character>	iterator() Creates an iterator over the values of the set.
void	readExternal(java.io.ObjectInput in)
boolean	remove(java.lang.Object value) Deletes a value from the set.
int	size() Returns the number of entries in the set.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.util.AbstractSet

hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

addAll, containsAll, hashCode, removeAll, retainAll, toArray, toArray

Field Detail

_set

protected TCharSet _set

the wrapped primitive set

Constructor Detail

TCharSetDecorator

public TCharSetDecorator()

FOR EXTERNALIZATION ONLY!!

TCharSetDecorator

public TCharSetDecorator(TCharSet set)

Creates a wrapper that decorates the specified primitive set.

Parameters:

set - the TCharSet to wrap.

Method Detail

getSet

public TCharSet getSet()

Returns a reference to the set wrapped by this decorator.

Returns:

the wrapped TCharSet instance.

add

public boolean add(java.lang.Character value)

Inserts a value into the set.

Specified by:

add in interface java.util.Collection<java.lang.Character>

Specified by:

add in interface java.util.Set<java.lang.Character>

Overrides:

add in class java.util.AbstractCollection<java.lang.Character>

Parameters:

value - true if the set was modified by the insertion

equals

public boolean equals(java.lang.Object other)

Compares this set with another set for equality of their stored entries.

Specified by:

equals in interface java.util.Collection<java.lang.Character>

Specified by:

equals in interface java.util.Set<java.lang.Character>

Overrides:

equals in class java.util.AbstractSet<java.lang.Character>

Parameters:

other - an Object value

Returns:

true if the sets are identical

clear

public void clear()

Empties the set.

Specified by:

clear in interface java.util.Collection<java.lang.Character>

Specified by:

clear in interface java.util.Set<java.lang.Character>

Overrides:

clear in class java.util.AbstractCollection<java.lang.Character>

remove

public boolean remove(java.lang.Object value)

Deletes a value from the set.

Specified by:

remove in interface java.util.Collection<java.lang.Character>

Specified by:

remove in interface java.util.Set<java.lang.Character>

Overrides:

remove in class java.util.AbstractCollection<java.lang.Character>

Parameters:

value - an Object value

Returns:

true if the set was modified

iterator

public java.util.Iterator<java.lang.Character> iterator()

Creates an iterator over the values of the set.

Specified by:

iterator in interface java.lang.Iterable<java.lang.Character>

Specified by:

iterator in interface java.util.Collection<java.lang.Character>

Specified by:

iterator in interface java.util.Set<java.lang.Character>

Specified by:

iterator in class java.util.AbstractCollection<java.lang.Character>

Returns:

an iterator with support for removals in the underlying set

size

public int size()

Returns the number of entries in the set.

Specified by:

size in interface java.util.Collection<java.lang.Character>

Specified by:

size in interface java.util.Set<java.lang.Character>

Specified by:

size in class java.util.AbstractCollection<java.lang.Character>

Returns:

the set's size.

isEmpty

public boolean isEmpty()

Indicates whether set has any entries.

Specified by:

isEmpty in interface java.util.Collection<java.lang.Character>

Specified by:

isEmpty in interface java.util.Set<java.lang.Character>

Overrides:

isEmpty in class java.util.AbstractCollection<java.lang.Character>

Returns:

true if the set is empty

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<java.lang.Character>

Specified by:

contains in interface java.util.Set<java.lang.Character>

Overrides:

contains in class java.util.AbstractCollection<java.lang.Character>

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException