HHH-5917: improving documentation

This commit is contained in:
Adam Warski 2011-06-29 18:27:35 +02:00 committed by Michal Skowronek
parent 8a750e28fc
commit d3e889bac4
1 changed files with 8 additions and 4 deletions

View File

@ -48,10 +48,14 @@ public @interface Audited {
RelationTargetAuditMode targetAuditMode() default RelationTargetAuditMode.AUDITED;
/**
* @return Set of superclasses which properties shall be audited. The behavior of listed classes
* is the same as if they had {@link Audited} annotation applied on a type level. The scope of this functionality
* is limited to the context of actually mapped entity and its class hierarchy. If a parent type lists any of
* its parent types using this attribute, all fields encapsulated by marked classes are implicitly audited.
* @return Specifies the superclasses for which properties should be audited, even if the superclasses are not
* annotated with {@link Audited}. Causes all properties of the listed classes to be audited, just as if the
* classes had {@link Audited} annotation applied on the class level.
*
* The scope of this functionality is limited to the class hierarchy of the annotated entity.
*
* If a parent type lists any of its parent types using this attribute, all properties in the specified classes
* will also be audited.
*/
Class[] auditParents() default {};
}