javax.persistence.DiscriminatorValue Maven / Gradle / Ivy
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.persistence;
import java.lang.annotation.Target;
import java.lang.annotation.Retention;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* Is used to specify the value of the discriminator column for
* entities of the given type. The DiscriminatorValue
* annotation can only be specified on a concrete entity
* class. If the DiscriminatorValue annotation is not
* specified and a discriminator column is used, a provider-specific
* function will be used to generate a value representing the
* entity type. If the {@link DiscriminatorType} is {@link
* DiscriminatorType#STRING STRING}, the discriminator value
* default is the entity name.
*
* The inheritance strategy and the discriminator column
* are only specified in the root of an entity class hierarchy
* or subhierarchy in which a different inheritance strategy is
* applied. The discriminator value, if not defaulted, should be
* specified for each entity class in the hierarchy.
*
*
*
* Example:
*
* @Entity
* @Table(name="CUST")
* @Inheritance(strategy=SINGLE_TABLE)
* @DiscriminatorColumn(name="DISC", discriminatorType=STRING,length=20)
* @DiscriminatorValue("CUSTOMER")
* public class Customer { ... }
*
* @Entity
* @DiscriminatorValue("VCUSTOMER")
* public class ValuedCustomer extends Customer { ... }
*
*
* @since Java Persistence 1.0
*/
@Target({TYPE})
@Retention(RUNTIME)
public @interface DiscriminatorValue {
/**
* (Optional) The value that indicates that the
* row is an entity of the annotated entity type.
*
* If the DiscriminatorValue annotation is not
* specified and a discriminator column is used, a provider-specific
* function will be used to generate a value representing the
* entity type. If the DiscriminatorType is {@link
* DiscriminatorType#STRING STRING}, the discriminator value
* default is the entity name.
*/
String value();
}