Package cdc.enums

Interface DynamicEnumSupport<V>

Type Parameters:

V - The enum value type.

All Superinterfaces:

DagType<V>, EnumType<V>, ListType<V>

All Known Subinterfaces:

AbstractForestDynamicEnum.Support<V>, AbstractListDynamicEnum.Support<V>

All Known Implementing Classes:

AbstractDynamicEnumSupport

public interface DynamicEnumSupport<V>
extends EnumType<V>

Base interface of services offered by dynamic enumerations.

This adds modification (creation removal, ...) methods to EnumType.

Author:

Damien Carbonne

Method Summary

Modifier and Type	Method	Description
V	findOrCreate(String qname)	Returns the value corresponding to a name.
void	lock()	Definitely locks modifications.
void	remove(V value)	Removes a value.
void	setName(V value, String name)	Changes a value name.

Methods inherited from interface cdc.enums.DagType

getChildren, getParents, getRoots, isOverOrEqual, isRoot, isStrictlyOver, isStrictlyUnder, isUnderOrEqual

Methods inherited from interface cdc.enums.EnumType

getChildNamed, getName, getQName, hasChildNamed, hasSiblingNamed, hasValue, valueOf, valueOf

Methods inherited from interface cdc.enums.ListType

addEventHandler, areEqual, getValueClass, getValues, isLocked, isSupported, isUsable, isValid, removeEventHandler, size

Method Details

lock

void lock()

Definitely locks modifications.

findOrCreate

V findOrCreate(String qname)

Returns the value corresponding to a name.

If none exists, creates a new value and returns it.

Parameters:

qname - The qualified name.

Returns:

The value corresponding to qname, possibly creating it.

Throws:

IllegalStateException - When locked and value corresponding to qname does not exist.

IllegalArgumentException - When locked and value corresponding to qname does not exist and qname is invalid.

remove

void remove(V value)

Removes a value.

Parameters:

value - The value to remove.

Throws:

IllegalStateException - When locked.

UnsupportedOperationException - When removal is not supported.

IllegalArgumentException - When value is invalid.

setName

void setName(V value,
 String name)

Changes a value name.

Parameters:

value - The value.

name - The new local name.

Throws:

IllegalStateException - When locked.

UnsupportedOperationException - When renaming is not supported.

IllegalArgumentException - When value or name is invalid.