org.omnifaces.persistence.model.VersionedBaseEntity 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.model;

import java.io.Serializable;

import jakarta.persistence.Column;
import jakarta.persistence.Id;
import jakarta.persistence.MappedSuperclass;
import jakarta.persistence.Version;

/**
 * 
 * Mapped superclass for versioned entity.
 * It extends from {@link TimestampedBaseEntity}.
 * In addition to the "created" and "lastModified" columns, it specifies a {@link Version} column, named "version".
 * The {@link Id} column needs to be manually taken care of.
 * On pre persist, JPA will automatically set version to 0.
 * On pre update, JPA will automatically increment version with 1.
 *
 * @param  The generic ID type.
 * @author Bauke Scholtz
 */
@MappedSuperclass
public abstract class VersionedBaseEntity & Serializable> extends TimestampedBaseEntity implements Versioned {

    private static final long serialVersionUID = 1L;

    @Version
    @Column(nullable = false)
    private Long version;

    @Override
    public Long getVersion() {
        return version;
    }

    // No setter! JPA takes care of this.
}