/*
     * #%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::transcribing::TranscribingSideId
  // Metafacade:   org.andromda.metafacades.uml.Enumeration
  // Stereotype:  Enumeration
  //
  package fr.ifremer.quadrige3.core.dao.referential.transcribing;
  
  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 TranscribingSideId
      implements Serializable, QuadrigeEnumerationDef<Integer>
  {
      IN (
  			"quadrige3.enumeration.TranscribingSideId.IN",
  			n("quadrige3.enumeration.TranscribingSideId.IN.description"),
  			2),
      IN_OUT (
  			"quadrige3.enumeration.TranscribingSideId.IN_OUT",
  			n("quadrige3.enumeration.TranscribingSideId.IN_OUT.description"),
  			3),
      OUT (
  			"quadrige3.enumeration.TranscribingSideId.OUT",
  			n("quadrige3.enumeration.TranscribingSideId.OUT.description"),
  			1);
  
      /**
       * The serial version UID of this class. Needed for serialization.
       */
      private static final long serialVersionUID = -3482211600946580696L;
  
      private String key;
      private String description;
      private Integer enumValue;
  
      /**
       * The constructor with enumeration literal value allowing
       * super classes to access it.
       */
      private TranscribingSideId(String key, String description, Integer value)
      {
      	this.key = key;
      	this.description = description;
          this.enumValue = value;
      }
      
      @Override
       /**
        * Setter for value. Use to override value, from configuration
        */
       public void setValue(Integer 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 TranscribingSideId from <code>its name</code>.
      *
      * @param name the name to create the TranscribingSideId from.
      * @return The enumeration literal named after the 'name' argument
      */
     public static TranscribingSideId fromString(String name)
     {
         return TranscribingSideId.valueOf(name);
     }
 
     /**
      * Returns an enumeration literal Integer <code>value</code>.
      * Required by JAXB2 enumeration implementation
      *
      * @return Integer with corresponding value
      */
     public Integer value()
     {
         return this.enumValue;
     }
 
     /**
      * Returns an instance of TranscribingSideId from Integer <code>value</code>.
      * Required by JAXB2 enumeration implementation
      *
      * @param value the value to create the TranscribingSideId from.
      * @return static Enumeration with corresponding value
      */
     public static TranscribingSideId fromValue(Integer value)
     {
         for (TranscribingSideId enumName: TranscribingSideId.values())
         {
             if (enumName.getValue().equals(value))
             {
                 return enumName;
             }
         }
         throw new IllegalArgumentException("TranscribingSideId.fromValue(" + value.toString() + ')');
     }
 
     /**
      * 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 Integer getValue()
     {
         return this.enumValue;
     }
     
     @Override
     public String getDescription() {
     	return description;
     }
     
     @Override
     public String getKey() {
     	return key;
     }
     
     @Override
     public Class<?> getType() {
     	return Integer.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<Integer> literals()
     {
         return TranscribingSideId.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 TranscribingSideId.names;
     }
 
     private static Map<Integer, TranscribingSideId> values = new LinkedHashMap<Integer, TranscribingSideId>(3, 1);
     private static List<Integer> literals = new ArrayList<Integer>(3);
     private static List<String> names = new ArrayList<String>(3);
     private static List<TranscribingSideId> valueList = new ArrayList<TranscribingSideId>(3);
 
     /**
      * Initializes the values.
      */
     static
     {
         synchronized (TranscribingSideId.values)
         {
             TranscribingSideId.values.put(IN.enumValue, IN);
             TranscribingSideId.values.put(IN_OUT.enumValue, IN_OUT);
             TranscribingSideId.values.put(OUT.enumValue, OUT);
         }
         synchronized (TranscribingSideId.valueList)
         {
             TranscribingSideId.valueList.add(IN);
             TranscribingSideId.valueList.add(IN_OUT);
             TranscribingSideId.valueList.add(OUT);
             // For Quadrige3, lists could be reload from configuration (see method 'setValue')
             //TranscribingSideId.valueList = Collections.unmodifiableList(valueList);
         }
         synchronized (TranscribingSideId.literals)
         {
             TranscribingSideId.literals.add(IN.enumValue);
             TranscribingSideId.literals.add(IN_OUT.enumValue);
             TranscribingSideId.literals.add(OUT.enumValue);
             // For Quadrige3, lists could be reload from configuration (see method 'setValue')
             //TranscribingSideId.literals = Collections.unmodifiableList(literals);
         }
         synchronized (TranscribingSideId.names)
         {
             TranscribingSideId.names.add("IN");
             TranscribingSideId.names.add("IN_OUT");
             TranscribingSideId.names.add("OUT");
             TranscribingSideId.names = Collections.unmodifiableList(names);
         }
     }
     // type-safe-enumeration-object java merge-point
 }