org.ow2.util.scan.api.configurator.metadata
Class ClassMetadataConfigurator<C extends IClassMetadata<C,M,F>,M extends IMethodMetadata<C,M,F>,F extends IFieldMetadata<C,M,F>>

java.lang.Object
  org.ow2.util.scan.api.configurator.BasicConfigurator
      org.ow2.util.scan.api.configurator.metadata.ClassMetadataConfigurator<C,M,F>

Type Parameters:

C - class of ClassMetadata

M - class of MethodMetadata

F - class of FieldMetadata

All Implemented Interfaces:

IClassConfigurator, ICommonConfigurator

public abstract class ClassMetadataConfigurator<C extends IClassMetadata<C,M,F>,M extends IMethodMetadata<C,M,F>,F extends IFieldMetadata<C,M,F>>
extends BasicConfigurator
implements IClassConfigurator

ClassMetadataConfigurator is a configurator of class specific to ClassMetata.

Author:

Gael Lalire

Constructor Summary

ClassMetadataConfigurator(C classMetadata)
Constructor.

ClassMetadataConfigurator(C classMetadata, java.util.List<? extends ISpecificArchiveConfigurator<C,M,F>> specificArchiveConfiguratorList)
Constructor.

Method Summary

void	configurationComplete(java.util.Set<java.lang.String> referencedClasses) call specific configuration complete.
IFieldConfigurator	createFieldConfigurator(JField jField) Provide a method used by ClassConfigurator.
protected abstract IFieldConfigurator	createFieldMetadataConfigurator(JField jField) You have to override this method.
IMethodConfigurator	createMethodConfigurator(JMethod jMethod) Provide a method used by ClassConfigurator.
protected abstract IMethodConfigurator	createMethodMetadataConfigurator(JMethod jMethod) You have to override this method.
IAnnotationVisitor	getAnnotationVisitor(JAnnotation annotation) a method invoked when an annotation is found.
protected C	getClassMetadata()
protected java.util.List<ISpecificClassConfigurator<C,M,F>>	getSpecificClassConfiguratorList()

Methods inherited from class org.ow2.util.scan.api.configurator.BasicConfigurator

getAnnotationVisitors

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassMetadataConfigurator

public ClassMetadataConfigurator(C classMetadata)

Constructor.

Parameters:

classMetadata - a class metadata

ClassMetadataConfigurator

public ClassMetadataConfigurator(C classMetadata,
                                 java.util.List<? extends ISpecificArchiveConfigurator<C,M,F>> specificArchiveConfiguratorList)

Constructor.

Parameters:

classMetadata - a class metadata

specificArchiveConfiguratorList - a list of specific archive configurator

Method Detail

getClassMetadata

protected C getClassMetadata()

Returns:

the class metadata.

createMethodConfigurator

public final IMethodConfigurator createMethodConfigurator(JMethod jMethod)

Provide a method used by ClassConfigurator.

Specified by:

createMethodConfigurator in interface IClassConfigurator

Parameters:

jMethod - signature of method

Returns:

the configurator

createMethodMetadataConfigurator

protected abstract IMethodConfigurator createMethodMetadataConfigurator(JMethod jMethod)

You have to override this method.

Parameters:

jMethod - signature of method

Returns:

the configurator

createFieldConfigurator

public final IFieldConfigurator createFieldConfigurator(JField jField)

Provide a method used by ClassConfigurator.

Specified by:

createFieldConfigurator in interface IClassConfigurator

Parameters:

jField - field signature

Returns:

the configurator

createFieldMetadataConfigurator

protected abstract IFieldConfigurator createFieldMetadataConfigurator(JField jField)

You have to override this method.

Parameters:

jField - signature of field

Returns:

the configurator

getAnnotationVisitor

public IAnnotationVisitor getAnnotationVisitor(JAnnotation annotation)

Description copied from interface: ICommonConfigurator

a method invoked when an annotation is found.

Specified by:

getAnnotationVisitor in interface ICommonConfigurator

Overrides:

getAnnotationVisitor in class BasicConfigurator

Parameters:

annotation - an annotation

Returns:

a visitor for this annotation

configurationComplete

public void configurationComplete(java.util.Set<java.lang.String> referencedClasses)

call specific configuration complete.

Specified by:

configurationComplete in interface ICommonConfigurator

Overrides:

configurationComplete in class BasicConfigurator

Parameters:

referencedClasses - you may fill this set with class referenced in current metadata

getSpecificClassConfiguratorList

protected java.util.List<ISpecificClassConfigurator<C,M,F>> getSpecificClassConfiguratorList()

Returns:

a list