/*
 * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.yangtools.sal.java.api.generator

import org.opendaylight.yangtools.sal.binding.model.api.Enumeration
import org.opendaylight.yangtools.sal.binding.model.api.GeneratedType

/**
 * Template for generating JAVA enumeration type. 
 */
class EnumTemplate extends BaseTemplate {

    
    /**
     * Enumeration which will be transformed to JAVA source code for enumeration
     */
    val Enumeration enums
    
    /**
     * Constructs instance of this class with concrete <code>enums</code>.
     * 
     * @param enums enumeration which will be transformed to JAVA source code 
     */
    new(Enumeration enums) {
        super(enums as GeneratedType )
        this.enums = enums
    }
    
    
    /**
     * Generates only JAVA enumeration source code.
     * 
     * @return string with JAVA enumeration source code
     */
    def generateAsInnerClass() {
        return body
    }
    
    /**
     * Template method which generates enumeration body (declaration + enumeration items).
     * 
     * @return string with the enumeration body 
     */
    override body() '''
        public enum «enums.name» {
        «FOR v : enums.values SEPARATOR ",\n"»
            «"    "»«v.name»(«v.value»)«
        ENDFOR»;
        
            int value;
            static java.util.Map<java.lang.Integer, «enums.name»> valueMap;

            static {
                valueMap = new java.util.HashMap<>();
                for («enums.name» enumItem : «enums.name».values())
                {
                    valueMap.put(enumItem.value, enumItem);
                }
            }
        
            private «enums.name»(int value) {
                this.value = value;
            }
            
            /**
             * @return integer value
             */
            public int getIntValue() {
                return value;
            }

            /**
             * @param valueArg
             * @return corresponding «enums.name» item
             */
            public static «enums.name» forValue(int valueArg) {
                return valueMap.get(valueArg);
            }
        }
    '''
}