Package cdc.enums

Class AbstractListDynamicEnum<V extends AbstractListDynamicEnum<V>>

java.lang.Object

cdc.enums.AbstractListDynamicEnum<V>

Type Parameters:

V - The dynamic enum concrete type.

All Implemented Interfaces:

DynamicEnum, ListDynamicEnum<V>, Comparable<V>

public abstract class AbstractListDynamicEnum<V extends AbstractListDynamicEnum<V>>
extends Object
implements ListDynamicEnum<V>, Comparable<V>

Dynamic enumeration of independent values.

Each value has a unique name.
This implementation supports these features:

• DagFeature.LOCKING
• DagFeature.CREATION till locked.
• DagFeature.REMOVAL if allowed at creation time and till locked.
• DagFeature.CONTENT_CHANGE if allowed at creation time and till locked.

A typical implementation should look like this:

 public final class Foo extends AbstractListDynamicEnum<Foo> {
     public static final Support<Foo> SUPPORT = support(Foo.class, Foo::new, Feature.RENAMING, ...);

     protected Foo(String value) {
         super(value);
     }
 }
 

Author:

Damien Carbonne

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AbstractListDynamicEnum.Creator<V extends ListDynamicEnum<V>>	Interface used to create new instances of a dynamic enum.
static interface	AbstractListDynamicEnum.Modifier<V extends ListDynamicEnum<V>>
static interface	AbstractListDynamicEnum.Support<V extends ListDynamicEnum<V>>	Support interface describing standard methods expected for a dynamic enum.

Field Summary

Fields inherited from interface cdc.enums.DynamicEnum

NAME_COMPARATOR, QNAME_COMPARATOR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractListDynamicEnum(String name)

Method Summary

Modifier and Type	Method	Description
int	compareTo(V o)
boolean	equals(Object obj)
final String	getName()
String	getQName()
int	hashCode()
protected final void	setName(String name)
protected static <E extends AbstractListDynamicEnum<E>> AbstractListDynamicEnum.Support<E>	support(Class<E> cls, AbstractListDynamicEnum.Creator<E> creator, DagFeature... features)
static <E extends ListDynamicEnum<E>> AbstractListDynamicEnum.Support<E>	support(Class<E> cls, Predicate<String> nameValidator, AbstractListDynamicEnum.Creator<E> creator, AbstractListDynamicEnum.Modifier<E> modifier, DagFeature... features)
protected static <E extends AbstractListDynamicEnum<E>> AbstractListDynamicEnum.Support<E>	support(Class<E> cls, Predicate<String> nameValidator, AbstractListDynamicEnum.Creator<E> creator, DagFeature... features)	Creates a support instance.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractListDynamicEnum

protected AbstractListDynamicEnum(String name)

Method Details

setName

protected final void setName(String name)

getName

public final String getName()

Specified by:

getName in interface DynamicEnum

Returns:

The enumeration name.

getQName

public String getQName()

Specified by:

getQName in interface DynamicEnum

Returns:

The enumeration qualified name.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(V o)

Specified by:

compareTo in interface Comparable<V extends AbstractListDynamicEnum<V>>

support

public static <E extends ListDynamicEnum<E>>
AbstractListDynamicEnum.Support<E> support(Class<E> cls,
 Predicate<String> nameValidator,
 AbstractListDynamicEnum.Creator<E> creator,
 AbstractListDynamicEnum.Modifier<E> modifier,
 DagFeature... features)

support

protected static <E extends AbstractListDynamicEnum<E>>
AbstractListDynamicEnum.Support<E> support(Class<E> cls,
 Predicate<String> nameValidator,
 AbstractListDynamicEnum.Creator<E> creator,
 DagFeature... features)

Creates a support instance.

Type Parameters:

E - The dynamic enum type.

Parameters:

cls - The dynamic enum class.

nameValidator - The predicate to check names validity.

creator - The dynamic enum factory

features - The features to enable.

Returns:

A new instance of Support for <E>

support

protected static <E extends AbstractListDynamicEnum<E>>
AbstractListDynamicEnum.Support<E> support(Class<E> cls,
 AbstractListDynamicEnum.Creator<E> creator,
 DagFeature... features)