/*
 * Copyright (c) 2008, 2009, 2011 Oracle, Inc. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
 * which accompanies this distribution.  The Eclipse Public License is available
 * at http://www.eclipse.org/legal/epl-v10.html and the Eclipse Distribution License
 * is available at http://www.eclipse.org/org/documents/edl-v10.php.
 */
package javax.persistence;

import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

Expresses a dependency on a container-managed EntityManager and its associated persistence context. 
Since:
Java Persistence 1.0/**
 * Expresses a dependency on a container-managed {@link EntityManager} and its
 * associated persistence context.
 *
 * @since Java Persistence 1.0
 */
@Target({TYPE, METHOD, FIELD})
@Retention(RUNTIME)
@Repeatable(PersistenceContexts.class)
public @interface PersistenceContext {

  
(Optional) The name by which the entity manager is to be accessed in the
environment referencing context; not needed when dependency
injection is used.
Returns:
Name/**
   * (Optional) The name by which the entity manager is to be accessed in the
   * environment referencing context; not needed when dependency
   * injection is used.
   *
   * @return Name
   */
  String name() default "";

  
(Optional) The name of the persistence unit as defined in the
persistence.xml file. If the unitName element is
specified, the persistence unit for the entity manager that is
accessible in JNDI must have the same name.
Returns:
unit name/**
   * (Optional) The name of the persistence unit as defined in the
   * <code>persistence.xml</code> file. If the <code>unitName</code> element is
   * specified, the persistence unit for the entity manager that is
   * accessible in JNDI must have the same name.
   *
   * @return unit name
   */
  String unitName() default "";

  
(Optional) Specifies whether a transaction-scoped persistence context
or an extended persistence context is to be used.
Returns:
type/**
   * (Optional) Specifies whether a transaction-scoped persistence context
   * or an extended persistence context is to be used.
   *
   * @return type
   */
  PersistenceContextType type() default PersistenceContextType.TRANSACTION;

  
(Optional) Specifies whether the persistence context is always automatically synchronized with the current
JTA transaction or whether the persistence context must be explicitly joined to the current JTA transaction by
means of the EntityManager joinTransaction method
Returns:
sync
Since:
Java Persistence 2.1/**
   * (Optional) Specifies whether the persistence context is always automatically synchronized with the current
   * JTA transaction or whether the persistence context must be explicitly joined to the current JTA transaction by
   * means of the EntityManager joinTransaction method
   *
   * @return sync
   * @since Java Persistence 2.1
   */
  SynchronizationType synchronization() default SynchronizationType.SYNCHRONIZED;

  
(Optional) Properties for the container or persistence
provider.  Vendor specific properties may be included in this
set of properties.  Properties that are not recognized by
a vendor are ignored.
Returns:
properties/**
   * (Optional) Properties for the container or persistence
   * provider.  Vendor specific properties may be included in this
   * set of properties.  Properties that are not recognized by
   * a vendor are ignored.
   *
   * @return properties
   */
  PersistenceProperty[] properties() default {};
}