org.omnifaces.persistence.audit.Audit Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of omnipersistence Show documentation

Utilities for JPA, JDBC and DataSources

There is a newer version: 0.22.J1

package org.omnifaces.persistence.audit;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import javax.persistence.EntityListeners;

/**
 * 
 * Instructions:
 * 

 * Extend {@link AuditListener}
 * 
Declare that listener as {@link EntityListeners} on your entity.
 * 
Put {@link Audit} annotation on column of interest.
 * 
Profit.
 * 
 * 
 * Usage example:
 * 
 * @Entity
 * @EntityListeners(YourAuditListener.class)
 * public class YourEntity extends BaseEntity<Long> {
 *
 *     @Audit
 *     @Column
 *     private String email;
 *
 *     // ...
 * }
 * 
 *
 * @author Bauke Scholtz
 */
@Retention(RUNTIME)
@Target(FIELD)
public @interface Audit {
	//
}