Package com.exedio.cope

Class Pattern

java.lang.Object

com.exedio.cope.Feature

com.exedio.cope.Pattern

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractListField, BlockField, ColorField, CompositeField, Dispatcher, DrivebyHashMigration, DynamicModel, EnumMapField, EnumSetField, FeatureField, Hash, HashConstraint, History, Importer, JavaView, MapField, MediaPath, MoneyField, MultiItemField, NestedHashMigration, PartOf, PasswordLimiter, PasswordRecovery, PriceField, RangeField, Schedule, Serializer, SetField, Singleton, TypeField, UniqueHashedMedia

public abstract class Pattern
extends Feature

A common super class for all patterns.

Patterns should be constructable in three different ways:

1) by an explicit external source

This is the most verbose kind of defining a pattern. First the source for the pattern is created, such as:

static final StringField source = new StringField(OPTIONAL)

Then the pattern ist created using the previously defined source:

static final Hash hash = new MD5Hash(source)

2) by an implicit external source

More concisely the pattern can be constructed by defining the source implicitely when the defining the pattern itself:

static final Hash hash = new MD5Hash(new StringField(OPTIONAL))

3) by an internal source

Finally, the construction of the source can be done the the pattern itself:

static final Hash hash = new MD5Hash(OPTIONAL)

Author:

Ralf Wiebicke

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Pattern()

Method Summary

Modifier and Type	Method	Description
protected void	addSource(Feature feature, String postfix)	Deprecated. Use addSourceFeature(Feature, String) instead and benefit from result.
protected void	addSource(Feature feature, String postfix, AnnotatedElement annotationSource)	Deprecated. Use addSourceFeature(Feature, String, AnnotatedElement) instead and benefit from result.
protected void	addSource(Feature feature, String postfix, AnnotatedElement annotationSource, Class<?> precedingLocalizationKeysClass)	Deprecated. Use addSourceFeature(Feature, String, AnnotatedElement, Class) instead and benefit from result.
protected void	addSource(Feature feature, String postfix, Field annotationSource)	Deprecated. For binary compatibility only, use addSourceFeature(Feature,String,AnnotatedElement) instead.
protected <F extends Feature> F	addSourceFeature(F feature, String postfix)
protected <F extends Feature> F	addSourceFeature(F feature, String postfix, AnnotatedElement annotationSource)
protected <F extends Feature> F	addSourceFeature(F feature, String postfix, AnnotatedElement annotationSource, Class<?> precedingLocalizationKeysClass)
protected Field	annotationField(String name)	Deprecated. Do not use this method anymore.
boolean	equals(Object other)	Forbid override by subclasses.
List<Type<?>>	getGeneratedTypes()	Deprecated. Use getSourceTypes() instead
List<? extends Feature>	getSourceFeatures()
Map<String,Feature>	getSourceFeaturesGather()
List<? extends Field<?>>	getSourceFields()	Deprecated. Use getSourceFeatures() instead
List<? extends Field<?>>	getSources()	Deprecated. Use getSourceFields() instead
List<Type<?>>	getSourceTypes()
Type<?>	getType()	Forbid override by subclasses.
int	hashCode()	Forbid override by subclasses.
protected void	initialize()	Deprecated. Override onMount() instead
protected <T extends Item> Type<T>	newSourceType(Class<T> javaClass, boolean isAbstract, Type<? super T> supertype, Features features, String postfix)
protected <T extends Item> Type<T>	newSourceType(Class<T> javaClass, boolean isAbstract, Type<? super T> supertype, LinkedHashMap<String,Feature> features, String postfix)	Deprecated.
protected <T extends Item> Type<T>	newSourceType(Class<T> javaClass, Features features)
protected <T extends Item> Type<T>	newSourceType(Class<T> javaClass, Features features, String postfix)
protected <T extends Item> Type<T>	newSourceType(Class<T> javaClass, LinkedHashMap<String,Feature> features)	Deprecated.
protected <T extends Item> Type<T>	newSourceType(Class<T> javaClass, LinkedHashMap<String,Feature> features, String postfix)	Deprecated.
protected <T extends Item> Type<T>	newType(Class<T> javaClass, LinkedHashMap<String,Feature> features)	Deprecated. Use newSourceType(Class,LinkedHashMap) instead
protected <T extends Item> Type<T>	newType(Class<T> javaClass, LinkedHashMap<String,Feature> features, String postfix)	Deprecated. Use newSourceType(Class,LinkedHashMap,String) instead
protected void	onMount()	Here you can do additional initialization not yet done in the constructor.
protected void	registerSource(Field<?> field, String postfix)	Deprecated. Use addSourceFeature(Feature,String) instead

Methods inherited from class com.exedio.cope.Feature

afterModelCreated, getAbstractType, getAnnotation, getID, getLocalizationKeys, getName, getPattern, isAnnotationPresent, isSourceAlready, mount, readResolve, requireMounted, toString, toString, writeReplace

Methods inherited from class java.lang.Object

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

Constructor Detail

Pattern

public Pattern()

Method Detail

addSourceFeature

protected final <F extends Feature> F addSourceFeature(F feature,
                                                       String postfix)

Returns:

parameter feature

See Also:

getSourceFeatures()

addSourceFeature

protected final <F extends Feature> F addSourceFeature(F feature,
                                                       String postfix,
                                                       AnnotatedElement annotationSource)

Returns:

parameter feature

See Also:

getSourceFeatures()

addSourceFeature

protected final <F extends Feature> F addSourceFeature(F feature,
                                                       String postfix,
                                                       AnnotatedElement annotationSource,
                                                       Class<?> precedingLocalizationKeysClass)

Returns:

parameter feature

See Also:

getSourceFeatures()

onMount

protected void onMount()

Here you can do additional initialization not yet done in the constructor. In this method you can call methods getType() and Feature.getName() for the first time.

newSourceType

protected final <T extends Item> Type<T> newSourceType(Class<T> javaClass,
                                                       Features features)

See Also:

getSourceTypes()

newSourceType

protected final <T extends Item> Type<T> newSourceType(Class<T> javaClass,
                                                       Features features,
                                                       String postfix)

See Also:

getSourceTypes()

newSourceType

protected final <T extends Item> Type<T> newSourceType(Class<T> javaClass,
                                                       boolean isAbstract,
                                                       Type<? super T> supertype,
                                                       Features features,
                                                       String postfix)

See Also:

getSourceTypes()

getSourceFeaturesGather

public final Map<String,Feature> getSourceFeaturesGather()

getSourceFeatures

public final List<? extends Feature> getSourceFeatures()

See Also:

addSourceFeature(Feature, String), Feature.getPattern()

getSourceTypes

public final List<Type<?>> getSourceTypes()

See Also:

newSourceType(Class, Features), Type.getPattern()

getType

public final Type<?> getType()

Forbid override by subclasses.

Overrides:

getType in class Feature

See Also:

Feature.getAbstractType()

equals

public final boolean equals(Object other)

Forbid override by subclasses.

Overrides:

equals in class Object

hashCode

public final int hashCode()

Forbid override by subclasses.

Overrides:

hashCode in class Object

addSource

@Deprecated
protected final void addSource(Feature feature,
                               String postfix)

Deprecated.

Use addSourceFeature(Feature, String) instead and benefit from result.

See Also:

getSourceFeatures()

addSource

@Deprecated
protected final void addSource(Feature feature,
                               String postfix,
                               AnnotatedElement annotationSource)

Deprecated.

Use addSourceFeature(Feature, String, AnnotatedElement) instead and benefit from result.

See Also:

getSourceFeatures()

addSource

@Deprecated
protected final void addSource(Feature feature,
                               String postfix,
                               AnnotatedElement annotationSource,
                               Class<?> precedingLocalizationKeysClass)

Deprecated.

Use addSourceFeature(Feature, String, AnnotatedElement, Class) instead and benefit from result.

See Also:

getSourceFeatures()

getSourceFields

@Deprecated
public List<? extends Field<?>> getSourceFields()

Deprecated.

Use getSourceFeatures() instead

getSources

@Deprecated
public final List<? extends Field<?>> getSources()

Deprecated.

Use getSourceFields() instead

getGeneratedTypes

@Deprecated
public final List<Type<?>> getGeneratedTypes()

Deprecated.

Use getSourceTypes() instead

registerSource

@Deprecated
protected final void registerSource(Field<?> field,
                                    String postfix)

Deprecated.

Use addSourceFeature(Feature,String) instead

newType

@Deprecated
protected final <T extends Item> Type<T> newType(Class<T> javaClass,
                                                 LinkedHashMap<String,Feature> features)

Deprecated.

Use newSourceType(Class,LinkedHashMap) instead

newType

@Deprecated
protected final <T extends Item> Type<T> newType(Class<T> javaClass,
                                                 LinkedHashMap<String,Feature> features,
                                                 String postfix)

Deprecated.

Use newSourceType(Class,LinkedHashMap,String) instead

newSourceType

@Deprecated
protected final <T extends Item> Type<T> newSourceType(Class<T> javaClass,
                                                       LinkedHashMap<String,Feature> features)

Deprecated.

newSourceType

@Deprecated
protected final <T extends Item> Type<T> newSourceType(Class<T> javaClass,
                                                       LinkedHashMap<String,Feature> features,
                                                       String postfix)

Deprecated.

newSourceType

@Deprecated
protected final <T extends Item> Type<T> newSourceType(Class<T> javaClass,
                                                       boolean isAbstract,
                                                       Type<? super T> supertype,
                                                       LinkedHashMap<String,Feature> features,
                                                       String postfix)

Deprecated.

initialize

@Deprecated
protected void initialize()

Deprecated.

Override onMount() instead

annotationField

@Deprecated
protected final Field annotationField(String name)

Deprecated.

Do not use this method anymore.

addSource

@Deprecated
protected final void addSource(Feature feature,
                               String postfix,
                               Field annotationSource)

Deprecated.

For binary compatibility only, use addSourceFeature(Feature,String,AnnotatedElement) instead.