org.codehaus.metaclass.tools.qdox
Interface QDoxAttributeInterceptor

All Known Implementing Classes:
DefaultQDoxAttributeInterceptor

public interface QDoxAttributeInterceptor

The interface via which attributes are passed before becoming part of the model. The Interception occurs during the building of the ClassDescriptor object from the from the JavaClass object as the interceptor may require the context of the original model during processing.

Version:
$Revision: 1.2 $ $Date: 2003/11/27 08:08:04 $
Author:
Peter Donald

Method Summary
 Attribute processClassAttribute(com.thoughtworks.qdox.model.JavaClass clazz, Attribute attribute)
          Process a single attribute at the Class level.
 Attribute[] processClassAttributes(com.thoughtworks.qdox.model.JavaClass clazz, Attribute[] attributes)
          Process the set of attributes for a specific Class.
 Attribute processFieldAttribute(com.thoughtworks.qdox.model.JavaField field, Attribute attribute)
          Process a single attribute at the Field level.
 Attribute[] processFieldAttributes(com.thoughtworks.qdox.model.JavaField field, Attribute[] attributes)
          Process the set of attributes for a specific Field.
 Attribute processMethodAttribute(com.thoughtworks.qdox.model.JavaMethod method, Attribute attribute)
          Process a single attribute at the Method level.
 Attribute[] processMethodAttributes(com.thoughtworks.qdox.model.JavaMethod method, Attribute[] attributes)
          Process the set of attributes for a specific Method.
 

Method Detail

processClassAttribute

public Attribute processClassAttribute(com.thoughtworks.qdox.model.JavaClass clazz,
                                       Attribute attribute)
Process a single attribute at the Class level. The implementation may return a new attribute instance, the old attribute instance or null to ignore attribute.

Parameters:
clazz - the corresponding JavaClass instance
attribute - the attribute
Returns:
the resulting attribute or null

processFieldAttribute

public Attribute processFieldAttribute(com.thoughtworks.qdox.model.JavaField field,
                                       Attribute attribute)
Process a single attribute at the Field level. The implementation may return a new attribute instance, the old attribute instance or null to ignore attribute.

Parameters:
field - the corresponding JavaField instance
attribute - the attribute
Returns:
the resulting attribute or null

processMethodAttribute

public Attribute processMethodAttribute(com.thoughtworks.qdox.model.JavaMethod method,
                                        Attribute attribute)
Process a single attribute at the Method level. The implementation may return a new attribute instance, the old attribute instance or null to ignore attribute.

Parameters:
method - the corresponding JavaMethod instance
attribute - the attribute
Returns:
the resulting attribute or null

processClassAttributes

public Attribute[] processClassAttributes(com.thoughtworks.qdox.model.JavaClass clazz,
                                          Attribute[] attributes)
Process the set of attributes for a specific Class. The implementation must return an array of attributes with no null entrys.

Parameters:
clazz - the corresponding JavaClass instance
attributes - the attributes
Returns:
the resulting attribute array

processFieldAttributes

public Attribute[] processFieldAttributes(com.thoughtworks.qdox.model.JavaField field,
                                          Attribute[] attributes)
Process the set of attributes for a specific Field. The implementation must return an array of attributes with no null entrys.

Parameters:
field - the corresponding JavaField instance
attributes - the attributes
Returns:
the resulting attribute array

processMethodAttributes

public Attribute[] processMethodAttributes(com.thoughtworks.qdox.model.JavaMethod method,
                                           Attribute[] attributes)
Process the set of attributes for a specific Method. The implementation must return an array of attributes with no null entrys.

Parameters:
method - the corresponding JavaMethod instance
attributes - the attributes
Returns:
the resulting attribute array


Copyright © 2003-2004 Codehaus. All Rights Reserved.