/*
 * Copyright (C) 2015 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.jboss.errai.jpa.client.local;

/**
 * Implementations of ErraiEntityManagerFactory are responsible for creating
 * instances of ErraiEntityManager. Users of the Errai framework don't normally
 * need to refer to this type directly; instead, they can
 * {@code @Inject EntityManager} directly into application classes, and allow
 * {@link ErraiEntityManagerProducer} to create factories as necessary.
 *
 * @author Jonathan Fuerth <jfuerth@redhat.com>
 */
public interface ErraiEntityManagerFactory {

  /**
   * Creates a new ErraiEntityManager configured according to the settings on
   * the implementing factory.
   *
   * @return a new instance of {@link ErraiEntityManager}.
   */
  ErraiEntityManager createEntityManager();
}
