package org.nuiton.eugene;
   
   /*-
    * #%L
    * EUGene :: EUGene
    * %%
    * Copyright (C) 2004 - 2016 CodeLutin
    * %%
    * This program is free software: you can redistribute it and/or modify
   * it under the terms of the GNU Lesser General Public License as
   * published by the Free Software Foundation, either version 3 of the
   * License, or (at your option) any later version.
   * 
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU General Lesser Public License for more details.
   * 
   * You should have received a copy of the GNU General Lesser Public
   * License along with this program.  If not, see
   * <http://www.gnu.org/licenses/lgpl-3.0.html>.
   * #L%
   */
  
  import com.google.common.collect.ImmutableSet;
  import org.codehaus.plexus.component.annotations.Component;
  import org.nuiton.eugene.models.extension.tagvalue.TagValueMetadata;
  import org.nuiton.eugene.models.extension.tagvalue.TagValueUtil;
  import org.nuiton.eugene.models.extension.tagvalue.matcher.EqualsTagValueNameMatcher;
  import org.nuiton.eugene.models.extension.tagvalue.provider.DefaultTagValueMetadatasProvider;
  import org.nuiton.eugene.models.extension.tagvalue.provider.TagValueMetadatasProvider;
  import org.nuiton.eugene.models.object.ObjectModel;
  import org.nuiton.eugene.models.object.ObjectModelAttribute;
  import org.nuiton.eugene.models.object.ObjectModelClassifier;
  import org.nuiton.eugene.models.object.ObjectModelElement;
  import org.nuiton.eugene.models.object.ObjectModelPackage;
  
  import java.util.Set;
  
  import static org.nuiton.i18n.I18n.n;
  import static org.nuiton.i18n.I18n.t;
  
  /**
   * Created on 24/09/16.
   *
   * Defines all tag values managed by Eugene.
   *
   * In another library using eugene, please extends this contract to put your
   * own tag values, to get a unique place where to find tag values.
   *
   * @author Tony Chemit - chemit@codelutin.com
   * @since 3.0
   */
  @Component(role = TagValueMetadatasProvider.class, hint = "eugene")
  public class EugeneCoreTagValues extends DefaultTagValueMetadatasProvider {
  
      @Override
      public String getDescription() {
          return t("eugene.core.tagvalues");
      }
  
      public enum Store implements TagValueMetadata {
  
          /**
           * Tag value to add the version of the model from outside (says in the
           * properties file associated to the model)..
           *
           * Actually, the eugene api does not use to modify the model. ItaTa is only
           * used while reading the properties associated with a model and if found is
           * directly set to the {@code version} field of the model.
           *
           * @since 2.3
           */
          version(n("eugene.core.tagValues.version"), String.class, null, ObjectModel.class),
  
          /**
           * Tag value to add on constants enumeration (or other incoming dev)
           * a prefix to constant to generate.
           *
           * You can globaly use it on the complete model or to a specific classifier.
           *
           * @since 2.5
           */
          documentation(n("eugene.core.tagValues.documentation"), String.class, null, ObjectModel.class, ObjectModelPackage.class, ObjectModelElement.class),
  
          /**
           * Tag value to add on constants enumeration (or other incoming dev)
           * a prefix to constant to generate.
           *
           * You can globaly use it on the complete model or to a specific classifier.
           *
           * @since 2.3
           */
          constantPrefix(n("eugene.core.tagValues.constantPrefix"), String.class, "PROPERTY_", ObjectModel.class, ObjectModelPackage.class, ObjectModelClassifier.class),
  
          /**
           * Tag value to specify the i18n prefix to use where generating i18n keys.
           *
           * You can globaly use it on the complete model or to a specific classifier.
          *
          * @since 2.3
          */
         i18n(n("eugene.core.tagValues.i18n"), String.class, null, ObjectModel.class, ObjectModelPackage.class, ObjectModelClassifier.class),
 
         /**
          * Tag value to specify the @Generated annotation class name.
          *
          * You can globaly use it on the complete model or to a specific classifier.
          *
          * @since 3.0
          */
         generatedAnnotation(n("eugene.core.tagValues.generatedAnnotation"), String.class, null, ObjectModel.class, ObjectModelPackage.class, ObjectModelClassifier.class),
 
         /**
          * Tag value to generate also {@code getXXX} methods for a boolean property.
          *
          * @since 2.12
          */
         generateBooleanGetMethods(n("eugene.core.tagValues.generateBooleanGetMethods"), boolean.class, "false", ObjectModel.class, ObjectModelPackage.class, ObjectModelClassifier.class),
 
         /**
          * To add a generic to an attribute.
          *
          * @since 3.0
          */
         attributeGeneric(n("eugene.core.tagValues.attributeGeneric"), String.class, null, ObjectModelAttribute.class),
 
         /**
          * Stereotype to mark an attribute with multiplicity as ordered.
          *
          * It means that order of insertion is maintained: in Java, it will lead
          * to a collection typed with {@link java.util.List} or {@link java.util.LinkedHashSet}
          * or {@link java.util.LinkedHashMap}.
          *
          * @since 2.8
          */
         ordered(n("eugene.core.tagValues.ordered"), boolean.class, null, ObjectModelAttribute.class),
         /**
          * Stereotype to mark an attribute with multiplicity as unique.
          *
          * It means that uniqueness of elements is maintained in the collection: in Java, it
          * will lead to a collection typed with {@link java.util.Set}.
          */
         unique(n("eugene.core.tagValues.unique"), boolean.class, null, ObjectModelAttribute.class),
         /**
          * Stereotype to skip generation for some templates.
          */
         skip(n("eugene.core.tagValues.skip"), boolean.class, null, ObjectModelClassifier.class, ObjectModelPackage.class);
 
 
         private final Set<Class<?>> targets;
         private final Class<?> type;
         private final String i18nDescriptionKey;
         private final String defaultValue;
 
         Store(String i18nDescriptionKey, Class<?> type, String defaultValue, Class<?>... targets) {
             this.targets = ImmutableSet.copyOf(targets);
             this.type = type;
             this.i18nDescriptionKey = i18nDescriptionKey;
             this.defaultValue = defaultValue;
         }
 
         @Override
         public String getName() {
             return name();
         }
 
         @Override
         public Set<Class<?>> getTargets() {
             return targets;
         }
 
         @Override
         public Class<?> getType() {
             return type;
         }
 
         @Override
         public Class<EqualsTagValueNameMatcher> getMatcherClass() {
             return EqualsTagValueNameMatcher.class;
         }
 
         @Override
         public String getDescription() {
             return t(i18nDescriptionKey);
         }
 
         @Override
         public String getDefaultValue() {
             return defaultValue;
         }
 
         @Override
         public boolean isDeprecated() {
             return false;
         }
 
     }
 
     public EugeneCoreTagValues() {
         super((TagValueMetadata[]) Store.values());
     }
 
     /**
      * Obtain the value of the {@link Store#documentation} tag value on the given model.
      *
      * @param model model to seek
      * @return the none empty value of the found tag value or {@code null} if not found nor empty.
      * @see Store#documentation
      * @since 2.3
      */
     public String getDocumentationTagValue(ObjectModel model) {
         return TagValueUtil.findTagValue(Store.documentation, model);
     }
 
     /**
      * Obtain the value of the {@link Store#documentation} tag value on the given element.
      *
      * @param element element to seek
      * @return the none empty value of the found tag value or {@code null} if not found nor empty.
      * @see Store#documentation
      * @since 2.3
      */
     public String getDocumentationTagValue(ObjectModelElement element) {
         return TagValueUtil.findTagValue(Store.documentation, element);
     }
 
     /**
      * Obtain the value of the {@link Store#documentation} tag value on the given package.
      *
      * @param aPackage package to seek
      * @return the none empty value of the found tag value or {@code null} if not found nor empty.
      * @see Store#documentation
      * @since 2.12
      */
     public String getDocumentationTagValue(ObjectModelPackage aPackage) {
         return TagValueUtil.findTagValue(Store.documentation, aPackage);
     }
 
     /**
      * Cherche et renvoie le préfixe i18n à utiliser sur cet element, sinon sur
      * le model.
      *
      * @param element  element to seek
      * @param aPackage package to seek
      * @param model    model to seek
      * @return le préfixe i18n ou <code>null</code> si non spécifié
      * @since 2.3
      */
     public String getI18nPrefixTagValue(ObjectModelElement element, ObjectModelPackage aPackage, ObjectModel model) {
         return TagValueUtil.findTagValue(Store.i18n, element, aPackage, model);
     }
 
     /**
      * Cherche et renvoie le préfixe i18n à utiliser sur cet element, sinon sur
      * le model.
      *
      * @param element  element to seek
      * @param aPackage package to seek
      * @param model    model to seek
      * @return le préfixe i18n ou <code>null</code> si non spécifié
      * @since 2.3
      */
     public String getGeneratedAnnotationTagValue(ObjectModelElement element, ObjectModelPackage aPackage, ObjectModel model) {
         return TagValueUtil.findTagValue(Store.generatedAnnotation, element, aPackage, model);
     }
 
     /**
      * Obtain the value of the {@link Store#generateBooleanGetMethods}
      * tag value on the given model, package or classifier.
      *
      * It will first look on the model, then on package and then in the given classifier.
      *
      * @param classifier classifier to seek
      * @param aPackage   package to seek
      * @param model      model to seek
      * @return the none empty value of the found tag value or {@code null} if not found nor empty.
      * @see Store#generateBooleanGetMethods
      * @since 2.12
      */
     public boolean isGenerateBooleanGetMethods(ObjectModelClassifier classifier, ObjectModelPackage aPackage, ObjectModel model) {
         return TagValueUtil.findBooleanTagValue(Store.generateBooleanGetMethods, classifier, aPackage, model);
     }
 
     /**
      * Obtain the value of the {@link Store#constantPrefix} tag value on the given model or classifier.
      *
      * It will first look on the model, and then in the given classifier.
      *
      * @param classifier classifier to seek
      * @param aPackage   package to seek
      * @param model      model to seek
      * @return the none empty value of the found tag value or {@code null} if not found nor empty.
      * @see Store#constantPrefix
      * @since 2.3
      */
     public String getConstantPrefixTagValue(ObjectModelClassifier classifier, ObjectModelPackage aPackage, ObjectModel model) {
         return TagValueUtil.findTagValue(Store.constantPrefix, classifier, aPackage, model);
     }
 
     /**
      * Obtain the value of the {@link Store#attributeGeneric} tag value on the given attribute.
      *
      * @param attribute attribute to seek
      * @return the none empty value of the found tag value or {@code null} if not found nor empty.
      * @see Store#attributeGeneric
      * @since 3.0
      */
     public String getAttributeGenericTagValue(ObjectModelAttribute attribute) {
         return TagValueUtil.findTagValue(Store.attributeGeneric, attribute);
     }
 
     /**
      * Check if the given attribute has the {@link Store#ordered} boolean tag value.
      *
      * @param attribute attribute to test
      * @return {@code true} if boolean tag value was found, {@code false otherwise}
      * @see Store#ordered
      * @since 2.9
      */
     public static boolean isOrdered(ObjectModelAttribute attribute) {
         return TagValueUtil.findBooleanTagValue(Store.ordered, attribute);
     }
 
     /**
      * Check if the given attribute has the {@link Store#unique} boolean tag value.
      *
      * @param attribute attribute to test
      * @return {@code true} if boolean tag value was found, {@code false otherwise}
      * @see Store#unique
      * @since 2.9
      */
     public static boolean isUnique(ObjectModelAttribute attribute) {
         return TagValueUtil.findBooleanTagValue(Store.unique, attribute);
     }
 
     /**
      * Check if the given classifier has the {@link Store#skip} boolean tag value.
      *
      * @param classifier classifier to test
      * @param aPackage   package to test
      * @return {@code true} if boolean tag value was found, {@code false otherwise}
      * @see Store#skip
      * @since 2.9
      */
     public static boolean isSkip(ObjectModelClassifier classifier, ObjectModelPackage aPackage) {
         return TagValueUtil.findBooleanTagValue(Store.skip, classifier, aPackage);
     }
 
     /**
      * Check if the given package has the {@link Store#skip} boolean tag value.
      *
      * @param aPackage package to test
      * @return {@code true} if boolean tag value was found, {@code false otherwise}
      * @see Store#skip
      */
     public static boolean isSkip(ObjectModelPackage aPackage) {
         return TagValueUtil.findBooleanTagValue(Store.skip, aPackage);
     }
 }