2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.mdsal.binding.java.api.generator
10 import static extension org.opendaylight.mdsal.binding.model.util.BindingGeneratorUtil.encodeAngleBrackets
11 import static org.opendaylight.mdsal.binding.model.util.Types.STRING;
13 import com.google.common.collect.ImmutableMap
14 import com.google.common.collect.ImmutableMap.Builder
15 import java.util.Optional
16 import org.opendaylight.mdsal.binding.model.api.Enumeration
17 import org.opendaylight.mdsal.binding.model.api.GeneratedType
20 * Template for generating JAVA enumeration type.
22 class EnumTemplate extends BaseTemplate {
24 * Enumeration which will be transformed to JAVA source code for enumeration
29 * Constructs instance of this class with concrete <code>enums</code>.
31 * @param enums enumeration which will be transformed to JAVA source code
33 new(AbstractJavaGeneratedType javaType, Enumeration enums) {
34 super(javaType, enums as GeneratedType)
39 * Constructs instance of this class with concrete <code>enums</code>.
41 * @param enums enumeration which will be transformed to JAVA source code
43 new(Enumeration enums) {
44 super(enums as GeneratedType)
49 * Generates only JAVA enumeration source code.
51 * @return string with JAVA enumeration source code
53 def generateAsInnerClass() {
57 def writeEnumItem(String name, String mappedName, int value, String description) '''
58 «IF description !== null»
59 «description.trim.encodeAngleBrackets.encodeJavadocSymbols.wrapToDocumentation»
61 «mappedName»(«value», "«name»")
65 * Template method which generates enumeration body (declaration + enumeration items).
67 * @return string with the enumeration body
70 «enums.formatDataForJavaDoc.wrapToDocumentation»
71 public enum «enums.name» implements «org.opendaylight.yangtools.yang.binding.Enumeration.importedName» {
72 «writeEnumeration(enums)»
74 private static final «JU_MAP.importedName»<«STRING.importedName», «enums.name»> NAME_MAP;
75 private static final «JU_MAP.importedName»<«Integer.importedName», «enums.name»> VALUE_MAP;
78 final «Builder.importedName»<«STRING.importedName», «enums.name»> nb = «ImmutableMap.importedName».builder();
79 final «Builder.importedName»<«Integer.importedName», «enums.name»> vb = «ImmutableMap.importedName».builder();
80 for («enums.name» enumItem : «enums.name».values()) {
81 vb.put(enumItem.value, enumItem);
82 nb.put(enumItem.name, enumItem);
85 NAME_MAP = nb.build();
86 VALUE_MAP = vb.build();
89 private final «STRING.importedName» name;
90 private final int value;
92 private «enums.name»(int value, «STRING.importedName» name) {
97 @«OVERRIDE.importedName»
98 public «STRING.importedName» getName() {
102 @«OVERRIDE.importedName»
103 public int getIntValue() {
108 * Return the enumeration member whose {@link #getName()} matches specified value.
110 * @param name YANG assigned name
111 * @return corresponding «enums.name» item, if present
112 * @throws NullPointerException if name is null
114 public static «Optional.importedName»<«enums.name»> forName(«STRING.importedName» name) {
115 return «Optional.importedName».ofNullable(NAME_MAP.get(«JU_OBJECTS.importedName».requireNonNull(name)));
119 * Return the enumeration member whose {@link #getIntValue()} matches specified value.
121 * @param intValue integer value
122 * @return corresponding «enums.name» item, or null if no such item exists
124 public static «enums.name» forValue(int intValue) {
125 return VALUE_MAP.get(intValue);
130 def writeEnumeration(Enumeration enumeration)
132 «FOR v : enumeration.values SEPARATOR ",\n" AFTER ";"»
133 «writeEnumItem(v.name, v.mappedName, v.value, v.description.orElse(null))»«