HHH-4439 - Javadoc change

This commit is contained in:
Lukasz Antoniak 2012-01-09 21:18:57 +01:00
parent 05df3d8638
commit 53b32e9e8d
2 changed files with 8 additions and 8 deletions

View File

@ -11,7 +11,7 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME;
/** /**
* The {@code AuditingOverride} annotation is used to override the auditing * The {@code AuditingOverride} annotation is used to override the auditing
* behavior of a superclass or single property inherited from {@link MappedSuperclass} * behavior of a superclass or single property inherited from {@link MappedSuperclass}
* type, or inside an embedded component. * type, or attribute inside an embedded component.
* *
* @author Erik-Berndt Scheper * @author Erik-Berndt Scheper
* @author Lukasz Antoniak (lukasz dot antoniak at gmail dot com) * @author Lukasz Antoniak (lukasz dot antoniak at gmail dot com)

View File

@ -94,7 +94,7 @@ public class AuditedPropertiesReader {
// Retrieve classes and properties that are explicitly marked for auditing process by any superclass // Retrieve classes and properties that are explicitly marked for auditing process by any superclass
// of currently mapped entity or itself. // of currently mapped entity or itself.
XClass clazz = persistentPropertiesSource.getXClass(); XClass clazz = persistentPropertiesSource.getXClass();
doReadOverrideAudited(clazz); readAuditOverrides(clazz);
// Adding all properties from the given class. // Adding all properties from the given class.
addPropertiesFromClass(clazz); addPropertiesFromClass(clazz);
@ -105,7 +105,7 @@ public class AuditedPropertiesReader {
* using {@link AuditOverride} annotation. * using {@link AuditOverride} annotation.
* @param clazz Class that is being processed. Currently mapped entity shall be passed during first invocation. * @param clazz Class that is being processed. Currently mapped entity shall be passed during first invocation.
*/ */
private void doReadOverrideAudited(XClass clazz) { private void readAuditOverrides(XClass clazz) {
/* TODO: Code to remove with @Audited.auditParents - start. */ /* TODO: Code to remove with @Audited.auditParents - start. */
Audited allClassAudited = clazz.getAnnotation(Audited.class); Audited allClassAudited = clazz.getAnnotation(Audited.class);
if (allClassAudited != null && allClassAudited.auditParents().length > 0) { if (allClassAudited != null && allClassAudited.auditParents().length > 0) {
@ -157,7 +157,7 @@ public class AuditedPropertiesReader {
} }
XClass superclass = clazz.getSuperclass(); XClass superclass = clazz.getSuperclass();
if (!clazz.isInterface() && !Object.class.getName().equals(superclass.getName())) { if (!clazz.isInterface() && !Object.class.getName().equals(superclass.getName())) {
doReadOverrideAudited(superclass); readAuditOverrides(superclass);
} }
} }
@ -239,10 +239,10 @@ public class AuditedPropertiesReader {
/** /**
* @param clazz Class which properties are currently being added. * @param clazz Class which properties are currently being added.
* @return {@link Audited} annotation of specified class. If processed type hasn't been explicitly marked, method * @return {@link Audited} annotation of specified class. If processed type hasn't been explicitly marked, method
* checks whether given class exists in {@code overriddenAuditedClasses} collection. In case of success, * checks whether given class exists in {@link AuditedPropertiesReader#overriddenAuditedClasses} collection.
* {@link Audited} configuration of currently mapped entity is returned (or the default if {@link Audited} * In case of success, {@link Audited} configuration of currently mapped entity is returned, otherwise
* applied on property level), otherwise {@code null}. If processed type exists in * {@code null}. If processed type exists in {@link AuditedPropertiesReader#overriddenNotAuditedClasses}
* {@code overriddenNotAuditedClasses} collection, the result is also {@code null}. * collection, the result is also {@code null}.
*/ */
private Audited computeAuditConfiguration(XClass clazz) { private Audited computeAuditConfiguration(XClass clazz) {
Audited allClassAudited = clazz.getAnnotation(Audited.class); Audited allClassAudited = clazz.getAnnotation(Audited.class);