org.eclipse.persistence.annotations.IdValidation Maven / Gradle / Ivy
/*
* Copyright (c) 1998, 2024 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0,
* or the Eclipse Distribution License v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
*/
// Contributors:
// James Sutherland - allow for zero ids
package org.eclipse.persistence.annotations;
/**
* IdValidation configures which id values are considered valid when loading from the database.
* This configuration is set either using the {@linkplain PrimaryKey} annotation
* or using the {@linkplain org.eclipse.persistence.descriptors.ClassDescriptor} API.
* This configuration is also used to determine if a sequence number is required.
*
* @see PrimaryKey#validation()
* @see org.eclipse.persistence.descriptors.ClassDescriptor#setIdValidation(IdValidation)
* @author James Sutherland
* @since EclipseLink 1.0
*/
public enum IdValidation {
/**
* Only null is invalid All other values are considered valid.
*
* This is the default configuration when composite identifiers are used and sequencing is not used.
*/
NULL,
/**
* null and 0 are not allowed for primitive int and long ids.
*
* This is the default configuration for a simple identifier.
*/
ZERO,
/**
* null, 0 and negative values are not allowed for ids extending Number and primitive int and long ids.
*/
NEGATIVE,
/**
* No identifier validation is performed.
*/
NONE
}