/*
     * #%L
     * Quadrige3 Core
     * %%
     * Copyright (C) 2017 Ifremer
     * %%
     * This program is free software: you can redistribute it and/or modify
     * it under the terms of the GNU Affero 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 Public License for more details.
    *
    * You should have received a copy of the GNU Affero General Public License
    * along with this program.  If not, see <http://www.gnu.org/licenses/>.
    * #L%
    */
  //
  // Attention: Generated code! Do not modify by hand!
  // Generated by: TypeSafeEnumeration.vsl in andromda-java-cartridge.
  // Model Class:  Données::fr.ifremer.quadrige3.core::dao::referential::QualityFlagCode
  // Metafacade:   org.andromda.metafacades.uml.Enumeration
  // Stereotype:  Enumeration
  //
  package fr.ifremer.quadrige3.core.dao.referential;
  
  import fr.ifremer.quadrige3.core.dao.technical.QuadrigeEnumerationDef;
  import java.io.Serializable;
  import java.util.ArrayList;
  import java.util.Collections;
  import java.util.LinkedHashMap;
  import java.util.List;
  import java.util.Map;
  import static org.nuiton.i18n.I18n.n;
  
  /**
   * 
   */
  public enum QualityFlagCode
      implements Serializable, QuadrigeEnumerationDef<String>
  {
      NOT_QUALIFIED (
  			"quadrige3.enumeration.QualityFlagCode.NOT_QUALIFIED",
  			n("quadrige3.enumeration.QualityFlagCode.NOT_QUALIFIED.description"),
  			"0"),
      GOOD (
  			"quadrige3.enumeration.QualityFlagCode.GOOD",
  			n("quadrige3.enumeration.QualityFlagCode.GOOD.description"),
  			"1"),
      DOUBTFUL (
  			"quadrige3.enumeration.QualityFlagCode.DOUBTFUL",
  			n("quadrige3.enumeration.QualityFlagCode.DOUBTFUL.description"),
  			"3"),
      BAD (
  			"quadrige3.enumeration.QualityFlagCode.BAD",
  			n("quadrige3.enumeration.QualityFlagCode.BAD.description"),
  			"4");
  
      /**
       * The serial version UID of this class. Needed for serialization.
       */
      private static final long serialVersionUID = -9083805314634950024L;
  
      private String key;
      private String description;
      private String enumValue;
  
      /**
       * The constructor with enumeration literal value allowing
       * super classes to access it.
       */
      private QualityFlagCode(String key, String description, String value)
      {
      	this.key = key;
      	this.description = description;
          this.enumValue = value;
      }
      
      @Override
       /**
        * Setter for value. Use to override value, from configuration
        */
       public void setValue(String newValue) {
  		if (newValue != null && !this.enumValue.equals(newValue)) {
  			// Update static lists
  	    	values.remove(this.enumValue);
  	    	literals.remove(this.enumValue);
  	    	this.enumValue = newValue;
  	    	values.put(this.enumValue, this);
  	    	literals.add(this.enumValue);
  		}
      }
      
  
      @Override
      public String getValueAsString()
     {
         return String.valueOf(this.enumValue);
     }
 
     /**
      * Retrieves an instance of QualityFlagCode from <code>its name</code>.
      *
      * @param name the name to create the QualityFlagCode from.
      * @return The enumeration literal named after the 'name' argument
      */
     public static QualityFlagCode fromString(String name)
     {
         return QualityFlagCode.valueOf(name);
     }
 
     /**
      * Returns an enumeration literal String <code>value</code>.
      * Required by JAXB2 enumeration implementation
      *
      * @return String with corresponding value
      */
     public String value()
     {
         return this.enumValue;
     }
 
     /**
      * Returns an instance of QualityFlagCode from String <code>value</code>.
      * Required by JAXB2 enumeration implementation
      *
      * @param value the value to create the QualityFlagCode from.
      * @return static Enumeration with corresponding value
      */
     public static QualityFlagCode fromValue(String value)
     {
         for (QualityFlagCode enumName: QualityFlagCode.values())
         {
             if (enumName.getValue().equals(value))
             {
                 return enumName;
             }
         }
         throw new IllegalArgumentException("QualityFlagCode.fromValue(" + value + ')');
     }
 
     /**
      * Gets the underlying value of this type safe enumeration.
      * This method is necessary to comply with DaoBase implementation.
      * @return The name of this literal.
      */
     public String getValue()
     {
         return this.enumValue;
     }
     
     @Override
     public String getDescription() {
     	return description;
     }
     
     @Override
     public String getKey() {
     	return key;
     }
     
     @Override
     public Class<?> getType() {
     	return String.class;
     }
     
     /**
      * Returns an unmodifiable list containing the literals that are known by this enumeration.
      *
      * @return A List containing the actual literals defined by this enumeration, this list
      *         can not be modified.
      */
     public static List<String> literals()
     {
         return QualityFlagCode.literals;
     }
 
     /**
      * Returns an unmodifiable list containing the names of the literals that are known
      * by this enumeration.
      *
      * @return A List containing the actual names of the literals defined by this
      *         enumeration, this list can not be modified.
      */
     public static List<String> names()
     {
         return QualityFlagCode.names;
     }
 
     private static Map<String, QualityFlagCode> values = new LinkedHashMap<String, QualityFlagCode>(4, 1);
     private static List<String> literals = new ArrayList<String>(4);
     private static List<String> names = new ArrayList<String>(4);
     private static List<QualityFlagCode> valueList = new ArrayList<QualityFlagCode>(4);
 
     /**
      * Initializes the values.
      */
     static
     {
         synchronized (QualityFlagCode.values)
         {
             QualityFlagCode.values.put(NOT_QUALIFIED.enumValue, NOT_QUALIFIED);
             QualityFlagCode.values.put(GOOD.enumValue, GOOD);
             QualityFlagCode.values.put(DOUBTFUL.enumValue, DOUBTFUL);
             QualityFlagCode.values.put(BAD.enumValue, BAD);
         }
         synchronized (QualityFlagCode.valueList)
         {
             QualityFlagCode.valueList.add(NOT_QUALIFIED);
             QualityFlagCode.valueList.add(GOOD);
             QualityFlagCode.valueList.add(DOUBTFUL);
             QualityFlagCode.valueList.add(BAD);
             // For Quadrige3, lists could be reload from configuration (see method 'setValue')
             //QualityFlagCode.valueList = Collections.unmodifiableList(valueList);
         }
         synchronized (QualityFlagCode.literals)
         {
             QualityFlagCode.literals.add(NOT_QUALIFIED.enumValue);
             QualityFlagCode.literals.add(GOOD.enumValue);
             QualityFlagCode.literals.add(DOUBTFUL.enumValue);
             QualityFlagCode.literals.add(BAD.enumValue);
             // For Quadrige3, lists could be reload from configuration (see method 'setValue')
             //QualityFlagCode.literals = Collections.unmodifiableList(literals);
         }
         synchronized (QualityFlagCode.names)
         {
             QualityFlagCode.names.add("NOT_QUALIFIED");
             QualityFlagCode.names.add("GOOD");
             QualityFlagCode.names.add("DOUBTFUL");
             QualityFlagCode.names.add("BAD");
             QualityFlagCode.names = Collections.unmodifiableList(names);
         }
     }
     // type-safe-enumeration-object java merge-point
 }