Class TypeEnumSet<E extends Enum<E> & TypeEnum>

java.lang.Object

net.okapia.osid.torrefacto.collect.TypeSet

net.okapia.osid.torrefacto.collect.TypeEnumSet<E>

Type Parameters:

E - the element type

All Implemented Interfaces:

Iterable<Type>, Types

public final class TypeEnumSet<E extends Enum<E> & TypeEnum>
extends TypeSet
implements Types

A TypeSet whose members are drawn from a Java enum. The enum constants implement TypeEnum, each supplying one org.osid.type.Type; the constructor loads every constant's type into the set. getEnum(Type) then maps a type back to the enum constant that carries it. This is the convenient way to expose a fixed, compile-time set of supported types and recover their enum form on lookup.

Constructor Summary

Constructors

Constructor	Description
TypeEnumSet(Class<E> enumClass)	Constructs a new TypeEnumSet.

Method Summary

Modifier and Type	Method	Description
E	getEnum(Type type)	Gets the enumerated value for a type.

Methods inherited from class TypeSet

add, clear, contains, iterator, remove, toArray, toCollection

Modifier and Type	Method	Description
void	add(Type type)	Tracks a supported type.
void	clear()	Removes all types.
boolean	contains(Type type)	Tests for the existience of a type.
Iterator<Type>	iterator()	Returns an iterator of Types.
void	remove(Type type)	Removes a type.
Type[]	toArray()	Gets an array of the types.
Collection<Type>	toCollection()	Gets an iterable collection of the types.

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Constructor Details

TypeEnumSet

public TypeEnumSet(Class<E> enumClass)

Constructs a new TypeEnumSet.

Parameters:

enumClass - the enum class whose constants supply the types

Throws:

NullArgumentException - enumClass is null

Method Details

getEnum

public E getEnum(Type type)

Gets the enumerated value for a type.

Parameters:

type - the type

Returns:

enumerated value

Throws:

NullArgumentException - type is null

UnsupportedException - type is not in enumeration