001/*
002 * Copyright (c) 2008, 2009, 2011 Oracle, Inc. All rights reserved.
003 *
004 * This program and the accompanying materials are made available under the
005 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
006 * which accompanies this distribution.  The Eclipse Public License is available
007 * at http://www.eclipse.org/legal/epl-v10.html and the Eclipse Distribution License
008 * is available at http://www.eclipse.org/org/documents/edl-v10.php.
009 */
010package javax.persistence;
011
012import java.lang.annotation.Documented;
013import java.lang.annotation.Retention;
014import java.lang.annotation.Target;
015
016import static java.lang.annotation.ElementType.TYPE;
017import static java.lang.annotation.RetentionPolicy.RUNTIME;
018
019/**
020 * Specifies that the class is an entity. This annotation is applied to the
021 * entity class.
022 *
023 * @since Java Persistence 1.0
024 */
025@Documented
026@Target(TYPE)
027@Retention(RUNTIME)
028public @interface Entity {
029
030  /**
031   * (Optional) The entity name. Defaults to the unqualified
032   * name of the entity class. This name is used to refer to the
033   * entity in queries. The name must not be a reserved literal
034   * in the Java Persistence query language.
035   *
036   * @return entity name
037   */
038  String name() default "";
039}