com.codelanx.commons.util

Class EnumBitSet<E extends Enum>

java.lang.Object

com.codelanx.commons.util.EnumBitSet<E>

Type Parameters:

E - The type of the enum this EnumBitSet applies to

public class EnumBitSet<E extends Enum>
extends Object

A small set comprised of enum elements, up to 64 constants. In context of this documentation, "constant" refers to any enum constant used in this set

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

Constructor Summary

Constructors

Constructor and Description
EnumBitSet() Constructs an empty EnumBitSet
EnumBitSet(int level) Constructs a new EnumBitSet with the passed constant level

Method Summary

Modifier and Type	Method and Description
void	add(E t) Adds a constant to this set.
void	clear() Clears the current set of all constants
long	getLevel() Returns the underlying level representing this set, for use in storage
boolean	has(E t) Returns true if this set contains the constant
void	remove(E t) Removes a constant from this set.
Set<E>	toSet(Class<E> clazz) Converts this EnumBitSet into a EnumSet containing all the elements that this set "has".

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumBitSet

public EnumBitSet()

Constructs an empty EnumBitSet

Since:

0.1.0

EnumBitSet

public EnumBitSet(int level)

Constructs a new EnumBitSet with the passed constant level

Parameters:

level - The previous internal level used for this set

Since:

0.1.0

Method Detail

has

public boolean has(E t)

Returns true if this set contains the constant

Parameters:

t - The constant to check for

Returns:

true if this set contains the constant

Since:

0.1.0

add

public void add(E t)

Adds a constant to this set. Does nothing if this set already contains the constant

Parameters:

t - The constant to add

Since:

0.1.0

remove

public void remove(E t)

Removes a constant from this set. Does nothing if this set does not contain the constant

Parameters:

t - The constant to remove

Since:

0.1.0

clear

public void clear()

Clears the current set of all constants

Since:

0.1.0

getLevel

public long getLevel()

Returns the underlying level representing this set, for use in storage

Returns:

The underlying level that represents this set

Since:

0.1.0

toSet

public Set<E> toSet(Class<E> clazz)

Converts this EnumBitSet into a EnumSet containing all the elements that this set "has".

Parameters:

clazz - The class of the enum used in this set

Returns:

An EnumSet of the constants

Since:

0.1.0