/*
 * 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.ui.shared.api.annotations;

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

/**
 * <p>
 * An annotation that provides a mechanism for the developer to specify the name
 * of an i18n bundle to use when doing i18n replacements within an Errai UI Template.
 * Note that multiple bundles can be used, but all bundles are ultimately aggregated
 * together prior to translating any of the Errai UI Templates.  In other words,
 * developers are free to break up their bundles in whatever way makes sense, but
 * at the end of the day all bundles will be merged and indexed by locale.
 * </p>
 *
 * <pre>
 * package org.example;
 *
 * @Dependent
 * @Templated
 * @Bundle("loginBundle.json")
 * public class CustomComponent extends Composite
 * {
 *    @Inject @DataField("username.label")
 *    private InlineLabel usernameLabel;
 *    @Inject
 *    private TextBox username;
 *
 *    @Inject @DataField("password.label")
 *    private InlineLabel passwordLabel;
 *    @Inject
 *    private TextBox password;
 *
 *    @Inject @DataField("login")
 *    private Button login;
 *
 *    @Inject @DataField("cancel")
 *    private Button cancel;
 *
 *    @EventHandler("login")
 *    private void doLogin(ClickEvent event)
 *    {
 *       // log in
 *    }
 * }
 * </pre>
 *
 * @author eric.wittmann@redhat.com
 */
@Documented
@Target({ElementType.TYPE, ElementType.PARAMETER, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Bundle {

  /**
   * Indicates the name of the Errai i18n bundle to use for i18n replacements
   * for this class.
   */
  String value();

}