org.hibernate.envers

Annotation Type AuditOverride

@Target(value={TYPE,METHOD,FIELD})
@Retention(value=RUNTIME)
public @interface AuditOverride

The AuditingOverride annotation is used to override the auditing behavior of a superclass or single property inherited from MappedSuperclass type, or attribute inside an embedded component.

Author:

Erik-Berndt Scheper, Lukasz Antoniak (lukasz dot antoniak at gmail dot com)

See Also:

Embedded, Embeddable, MappedSuperclass, AssociationOverride, AuditJoinTable

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
AuditJoinTable	auditJoinTable
Class	forClass
boolean	isAudited
String	name

Element Detail

name

public abstract String name

Returns:

Name of the field (or property) whose mapping is being overridden. Allows empty value if AuditOverride is used to change auditing behavior of all attributes inherited from MappedSuperclass type.

Default:

""

isAudited

public abstract boolean isAudited

Returns:

Indicates if the field (or property) is audited; defaults to true.

Default:

true

auditJoinTable

public abstract AuditJoinTable auditJoinTable

Returns:

New AuditJoinTable used for this field (or property). Its value is ignored if isAudited() equals to false.

Default:

@org.hibernate.envers.AuditJoinTable

forClass

public abstract Class forClass

Returns:

Specifies class which field (or property) mapping is being overridden. Required if AuditOverride is used to change auditing behavior of attributes inherited from MappedSuperclass type.

Default:

void.class