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

The newest version!

/*
 * Copyright 2021 OmniFaces
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */
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 jakarta.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 {
    //
}