/*
 * 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.ioc.client.api;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

import com.google.gwt.core.client.GWT;

/**
 * Provides a hint to the container that the annotated element should be loaded asynchronously using
 * GWT's code splitting. This annotation can be placed on any container-managed element (beans or
 * producers).
 * 
 * A fragment name can optionally be specified using a class literal. GWT's code splitter will put
 * the code of all types with the same fragment name into the same code fragment see
 * {@link GWT#runAsync(Class, com.google.gwt.core.client.RunAsyncCallback)}.
 * 
 * @author Mike Brock
 * @author Christian Sadilek <csadilek@redhat.com>
 */
@Retention(RetentionPolicy.RUNTIME)
@java.lang.annotation.Target({ ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER })
public @interface LoadAsync {

  /**
   * The fragment name to group all types with the same name into the same code fragment.
   */
  Class<?> value() default org.jboss.errai.ioc.client.api.LoadAsync.NO_FRAGMENT.class;

  public static abstract class NO_FRAGMENT {};
}
