org.hibernate.usertype.UserVersionType Maven / Gradle / Ivy
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2008, Red Hat Middleware LLC or third-party contributors as
* indicated by the @author tags or express copyright attribution
* statements applied by the authors. All third-party contributions are
* distributed under license by Red Hat Middleware LLC.
*
* This copyrighted material is made available to anyone wishing to use, modify,
* copy, or redistribute it subject to the terms and conditions of the GNU
* Lesser General Public License, as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this distribution; if not, write to:
* Free Software Foundation, Inc.
* 51 Franklin Street, Fifth Floor
* Boston, MA 02110-1301 USA
*
*/
package org.hibernate.usertype;
import java.util.Comparator;
import org.hibernate.engine.SessionImplementor;
/**
* A user type that may be used for a version property
*
* @author Gavin King
*/
public interface UserVersionType extends UserType, Comparator {
/**
* Generate an initial version.
*
* @param session The session from which this request originates. May be
* null; currently this only happens during startup when trying to determine
* the "unsaved value" of entities.
* @return an instance of the type
*/
public Object seed(SessionImplementor session);
/**
* Increment the version.
*
* @param session The session from which this request originates.
* @param current the current version
* @return an instance of the type
*/
public Object next(Object current, SessionImplementor session);
}