| 1 |
<%@ jet package="org.eclipse.emf.codegen.ecore.templates.model" imports="java.util.* org.eclipse.emf.codegen.ecore.genmodel.* org.eclipse.emf.codegen.ecore.genmodel.impl.Literals" class="EnumClass"%> |
| 2 |
<% |
| 3 |
/** |
| 4 |
* Copyright (c) 2002-2019 IBM Corporation and others. |
| 5 |
* All rights reserved. This program and the accompanying materials |
| 6 |
* are made available under the terms of the Eclipse Public License v2.0 |
| 7 |
* which accompanies this distribution, and is available at |
| 8 |
* http://www.eclipse.org/legal/epl-v20.html |
| 9 |
* |
| 10 |
* Contributors: |
| 11 |
* IBM - Initial API and implementation |
| 12 |
* Alexander Fedorov <[email protected]> - Bug 546714 |
| 13 |
*/ |
| 14 |
%> |
| 15 |
<%GenEnum genEnum = (GenEnum)argument; GenPackage genPackage = genEnum.getGenPackage(); GenModel genModel=genPackage.getGenModel();%> |
| 16 |
<%final boolean isJDK50 = genModel.getComplianceLevel().getValue() >= GenJDKLevel.JDK50;%> |
| 17 |
<%final boolean forceDefaultCase = genModel.isSwitchMissingDefaultCase();%> |
| 18 |
<%@ include file="../Header.javajetinc"%> |
| 19 |
package <%=genPackage.getInterfacePackageName()%>; |
| 20 |
|
| 21 |
<%genModel.addImport("java.util.Arrays");%> |
| 22 |
<%genModel.addImport("java.util.List");%> |
| 23 |
<%genModel.addImport("java.util.Collections");%> |
| 24 |
<%genModel.markImportLocation(stringBuffer, genPackage);%> |
| 25 |
<%boolean isEnum = genModel.useGenerics();%> |
| 26 |
|
| 27 |
/** |
| 28 |
* <!-- begin-user-doc --> |
| 29 |
* A representation of the literals of the enumeration '<em><b><%=genEnum.getFormattedName()%></b></em>', |
| 30 |
* and utility methods for working with them. |
| 31 |
* <!-- end-user-doc --> |
| 32 |
<%if (genEnum.hasDocumentation()) {%> |
| 33 |
* <!-- begin-model-doc --> |
| 34 |
* <%=genEnum.getDocumentation(genModel.getIndentation(stringBuffer))%> |
| 35 |
* <!-- end-model-doc --> |
| 36 |
<%}%> |
| 37 |
* @see <%=genPackage.getQualifiedPackageInterfaceName()%>#get<%=genEnum.getName()%>() |
| 38 |
<%if (!genModel.isSuppressEMFModelTags()) { boolean first = true; for (StringTokenizer stringTokenizer = new StringTokenizer(genEnum.getModelInfo(), "\n\r"); stringTokenizer.hasMoreTokens(); ) { String modelInfo = stringTokenizer.nextToken(); if (first) { first = false;%> |
| 39 |
* @model <%=modelInfo%> |
| 40 |
<%} else {%> |
| 41 |
* <%=modelInfo%> |
| 42 |
<%}} if (first) {%> |
| 43 |
* @model |
| 44 |
<%}}%> |
| 45 |
<%if (genEnum.hasImplicitAPITags(true)) {%> |
| 46 |
* <%=genEnum.getImplicitAPITags(genModel.getIndentation(stringBuffer), true)%> |
| 47 |
<%}%> |
| 48 |
* @generated |
| 49 |
*/ |
| 50 |
<%if (isJDK50 && genEnum.hasImplicitAPIDeprecatedTag()) {%> |
| 51 |
@Deprecated |
| 52 |
<%}%> |
| 53 |
public <%if (isEnum) {%>enum<%} else {%>final class<%}%> <%=genEnum.getName()%> <%if (isEnum) {%>implements<%} else {%>extends<%}%> <%=genModel.isSuppressEMFMetaData() && !genModel.isSuppressInterfaces() ? "Internal" + genEnum.getName() : genModel.getImportedName(isEnum ? "org.eclipse.emf.common.util.Enumerator" : "org.eclipse.emf.common.util.AbstractEnumerator")%> |
| 54 |
{ |
| 55 |
<%if (isEnum) {%> |
| 56 |
<%if (genEnum.getGenEnumLiterals().isEmpty()) {%> |
| 57 |
; |
| 58 |
|
| 59 |
<%}else {%> |
| 60 |
<%for (Iterator<GenEnumLiteral> l = genEnum.getGenEnumLiterals().iterator(); l.hasNext(); ) { GenEnumLiteral genEnumLiteral = l.next(); %> |
| 61 |
/** |
| 62 |
* The '<em><b><%=genEnumLiteral.getFormattedName()%></b></em>' literal object. |
| 63 |
* <!-- begin-user-doc --> |
| 64 |
* <!-- end-user-doc --> |
| 65 |
<%if (genEnumLiteral.hasDocumentation()) {%> |
| 66 |
* <!-- begin-model-doc --> |
| 67 |
* <%=genEnumLiteral.getDocumentation(genModel.getIndentation(stringBuffer))%> |
| 68 |
* <!-- end-model-doc --> |
| 69 |
<%}%> |
| 70 |
* @see #<%=genEnumLiteral.getEnumLiteralValueConstantName()%> |
| 71 |
* @generated |
| 72 |
* @ordered |
| 73 |
*/ |
| 74 |
<%if (isJDK50 && genEnumLiteral.hasAPIDeprecatedTag()) {%> |
| 75 |
@Deprecated |
| 76 |
<%}%> |
| 77 |
<%=genEnumLiteral.getEnumLiteralInstanceConstantName()%>(<%=genEnumLiteral.getValue()%>, "<%=genEnumLiteral.getName()%>", <%=Literals.toStringLiteral(genEnumLiteral.getLiteral(), genModel)%>)<%if (l.hasNext()) {%>,<%} else {%>;<%}%><%=genModel.getNonNLS()%><%=genModel.getNonNLS(2)%> |
| 78 |
|
| 79 |
<%}%> |
| 80 |
<%}%> |
| 81 |
<%}%> |
| 82 |
<%if (genModel.hasCopyrightField()) {%> |
| 83 |
/** |
| 84 |
* <!-- begin-user-doc --> |
| 85 |
* <!-- end-user-doc --> |
| 86 |
* @generated |
| 87 |
*/ |
| 88 |
public static final <%=genModel.getImportedName("java.lang.String")%> copyright = <%=genModel.getCopyrightFieldLiteral()%>;<%=genModel.getNonNLS()%> |
| 89 |
|
| 90 |
<%}%> |
| 91 |
<%for (GenEnumLiteral genEnumLiteral : genEnum.getGenEnumLiterals()) {%> |
| 92 |
/** |
| 93 |
* The '<em><b><%=genEnumLiteral.getFormattedName()%></b></em>' literal value. |
| 94 |
* <!-- begin-user-doc --> |
| 95 |
* <!-- end-user-doc --> |
| 96 |
<%if (genEnumLiteral.hasDocumentation()) {%> |
| 97 |
* <!-- begin-model-doc --> |
| 98 |
* <%=genEnumLiteral.getDocumentation(genModel.getIndentation(stringBuffer))%> |
| 99 |
* <!-- end-model-doc --> |
| 100 |
<%}%> |
| 101 |
* @see #<%=genEnumLiteral.getEnumLiteralInstanceConstantName()%> |
| 102 |
<%if (!genModel.isSuppressEMFModelTags()) { boolean first = true; for (StringTokenizer stringTokenizer = new StringTokenizer(genEnumLiteral.getModelInfo(), "\n\r"); stringTokenizer.hasMoreTokens(); ) { String modelInfo = stringTokenizer.nextToken(); if (first) { first = false;%> |
| 103 |
* @model <%=modelInfo%> |
| 104 |
<%} else {%> |
| 105 |
* <%=modelInfo%> |
| 106 |
<%}} if (first) {%> |
| 107 |
* @model |
| 108 |
<%}}%> |
| 109 |
* @generated |
| 110 |
* @ordered |
| 111 |
*/ |
| 112 |
<%if (isJDK50 && genEnumLiteral.hasAPIDeprecatedTag()) {%> |
| 113 |
@Deprecated |
| 114 |
<%}%> |
| 115 |
public static final int <%=genEnumLiteral.getEnumLiteralValueConstantName()%> = <%=genEnumLiteral.getValue()%>; |
| 116 |
|
| 117 |
<%}%> |
| 118 |
<%if (!isEnum) for (GenEnumLiteral genEnumLiteral : genEnum.getGenEnumLiterals()) {%> |
| 119 |
/** |
| 120 |
* The '<em><b><%=genEnumLiteral.getFormattedName()%></b></em>' literal object. |
| 121 |
* <!-- begin-user-doc --> |
| 122 |
* <!-- end-user-doc --> |
| 123 |
* @see #<%=genEnumLiteral.getEnumLiteralValueConstantName()%> |
| 124 |
<%if (genEnumLiteral.hasAPITags()) {%> |
| 125 |
* <%=genEnumLiteral.getAPITags(genModel.getIndentation(stringBuffer))%> |
| 126 |
<%}%> |
| 127 |
* @generated |
| 128 |
* @ordered |
| 129 |
*/ |
| 130 |
<%if (isJDK50 && genEnumLiteral.hasAPIDeprecatedTag()) {%> |
| 131 |
@Deprecated |
| 132 |
<%}%> |
| 133 |
public static final <%=genEnum.getName()%> <%=genEnumLiteral.getEnumLiteralInstanceConstantName()%> = new <%=genEnum.getName()%>(<%=genEnumLiteral.getEnumLiteralValueConstantName()%>, "<%=genEnumLiteral.getName()%>", <%=Literals.toStringLiteral(genEnumLiteral.getLiteral(), genModel)%>);<%=genModel.getNonNLS()%><%=genModel.getNonNLS(2)%> |
| 134 |
|
| 135 |
<%}%> |
| 136 |
/** |
| 137 |
* An array of all the '<em><b><%=genEnum.getFormattedName()%></b></em>' enumerators. |
| 138 |
* <!-- begin-user-doc --> |
| 139 |
* <!-- end-user-doc --> |
| 140 |
* @generated |
| 141 |
*/ |
| 142 |
private static final <%=genEnum.getName()%>[] VALUES_ARRAY = |
| 143 |
new <%=genEnum.getName()%>[] |
| 144 |
{ |
| 145 |
<%for (GenEnumLiteral genEnumLiteral : genEnum.getGenEnumLiterals()) {%> |
| 146 |
<%=genEnumLiteral.getEnumLiteralInstanceConstantName()%>, |
| 147 |
<%}%> |
| 148 |
}; |
| 149 |
|
| 150 |
/** |
| 151 |
* A public read-only list of all the '<em><b><%=genEnum.getFormattedName()%></b></em>' enumerators. |
| 152 |
* <!-- begin-user-doc --> |
| 153 |
* <!-- end-user-doc --> |
| 154 |
* @generated |
| 155 |
*/ |
| 156 |
public static final List<%if (isEnum) {%><<%=genEnum.getName()%>><%}%> VALUES = Collections.unmodifiableList(Arrays.asList(VALUES_ARRAY)); |
| 157 |
|
| 158 |
/** |
| 159 |
* Returns the '<em><b><%=genEnum.getFormattedName()%></b></em>' literal with the specified literal value. |
| 160 |
* <!-- begin-user-doc --> |
| 161 |
* <!-- end-user-doc --> |
| 162 |
* @param literal the literal. |
| 163 |
* @return the matching enumerator or <code>null</code>. |
| 164 |
* @generated |
| 165 |
*/ |
| 166 |
public static <%=genEnum.getName()%> get(<%=genModel.getImportedName("java.lang.String")%> literal) |
| 167 |
{ |
| 168 |
for (int i = 0; i < VALUES_ARRAY.length; ++i) |
| 169 |
{ |
| 170 |
<%=genEnum.getName()%> result = VALUES_ARRAY[i]; |
| 171 |
if (result.toString().equals(literal)) |
| 172 |
{ |
| 173 |
return result; |
| 174 |
} |
| 175 |
} |
| 176 |
return null; |
| 177 |
} |
| 178 |
|
| 179 |
/** |
| 180 |
* Returns the '<em><b><%=genEnum.getFormattedName()%></b></em>' literal with the specified name. |
| 181 |
* <!-- begin-user-doc --> |
| 182 |
* <!-- end-user-doc --> |
| 183 |
* @param name the name. |
| 184 |
* @return the matching enumerator or <code>null</code>. |
| 185 |
* @generated |
| 186 |
*/ |
| 187 |
public static <%=genEnum.getName()%> getByName(<%=genModel.getImportedName("java.lang.String")%> name) |
| 188 |
{ |
| 189 |
for (int i = 0; i < VALUES_ARRAY.length; ++i) |
| 190 |
{ |
| 191 |
<%=genEnum.getName()%> result = VALUES_ARRAY[i]; |
| 192 |
if (result.getName().equals(name)) |
| 193 |
{ |
| 194 |
return result; |
| 195 |
} |
| 196 |
} |
| 197 |
return null; |
| 198 |
} |
| 199 |
|
| 200 |
/** |
| 201 |
* Returns the '<em><b><%=genEnum.getFormattedName()%></b></em>' literal with the specified integer value. |
| 202 |
* <!-- begin-user-doc --> |
| 203 |
* <!-- end-user-doc --> |
| 204 |
* @param value the integer value. |
| 205 |
* @return the matching enumerator or <code>null</code>. |
| 206 |
* @generated |
| 207 |
*/ |
| 208 |
public static <%=genEnum.getName()%> get(int value) |
| 209 |
{ |
| 210 |
switch (value) |
| 211 |
{ |
| 212 |
<%for (GenEnumLiteral genEnumLiteral : genEnum.getUniqueValuedGenEnumLiterals()) {%> |
| 213 |
case <%=genEnumLiteral.getEnumLiteralValueConstantName()%>: return <%=genEnumLiteral.getEnumLiteralInstanceConstantName()%>; |
| 214 |
<%}%> |
| 215 |
<%if (forceDefaultCase) { // {%> |
| 216 |
default: return null; |
| 217 |
} |
| 218 |
<%} else { // {%> |
| 219 |
} |
| 220 |
return null; |
| 221 |
<%} // }%> |
| 222 |
} |
| 223 |
|
| 224 |
<%if (isEnum) {%> |
| 225 |
/** |
| 226 |
* <!-- begin-user-doc --> |
| 227 |
* <!-- end-user-doc --> |
| 228 |
* @generated |
| 229 |
*/ |
| 230 |
private final int value; |
| 231 |
|
| 232 |
/** |
| 233 |
* <!-- begin-user-doc --> |
| 234 |
* <!-- end-user-doc --> |
| 235 |
* @generated |
| 236 |
*/ |
| 237 |
private final <%=genModel.getImportedName("java.lang.String")%> name; |
| 238 |
|
| 239 |
/** |
| 240 |
* <!-- begin-user-doc --> |
| 241 |
* <!-- end-user-doc --> |
| 242 |
* @generated |
| 243 |
*/ |
| 244 |
private final <%=genModel.getImportedName("java.lang.String")%> literal; |
| 245 |
|
| 246 |
<%}%> |
| 247 |
/** |
| 248 |
* Only this class can construct instances. |
| 249 |
* <!-- begin-user-doc --> |
| 250 |
* <!-- end-user-doc --> |
| 251 |
* @generated |
| 252 |
*/ |
| 253 |
private <%=genEnum.getName()%>(int value, <%=genModel.getImportedName("java.lang.String")%> name, <%=genModel.getImportedName("java.lang.String")%> literal) |
| 254 |
{ |
| 255 |
<%if (isEnum) {%> |
| 256 |
this.value = value; |
| 257 |
this.name = name; |
| 258 |
this.literal = literal; |
| 259 |
<%} else {%> |
| 260 |
super(value, name, literal); |
| 261 |
<%}%> |
| 262 |
} |
| 263 |
|
| 264 |
<%if (isEnum) {%> |
| 265 |
/** |
| 266 |
* <!-- begin-user-doc --> |
| 267 |
* <!-- end-user-doc --> |
| 268 |
* @generated |
| 269 |
*/ |
| 270 |
<%if (genModel.useInterfaceOverrideAnnotation()) {%> |
| 271 |
@Override |
| 272 |
<%}%> |
| 273 |
public int getValue() |
| 274 |
{ |
| 275 |
return value; |
| 276 |
} |
| 277 |
|
| 278 |
/** |
| 279 |
* <!-- begin-user-doc --> |
| 280 |
* <!-- end-user-doc --> |
| 281 |
* @generated |
| 282 |
*/ |
| 283 |
<%if (genModel.useInterfaceOverrideAnnotation()) {%> |
| 284 |
@Override |
| 285 |
<%}%> |
| 286 |
public <%=genModel.getImportedName("java.lang.String")%> getName() |
| 287 |
{ |
| 288 |
return name; |
| 289 |
} |
| 290 |
|
| 291 |
/** |
| 292 |
* <!-- begin-user-doc --> |
| 293 |
* <!-- end-user-doc --> |
| 294 |
* @generated |
| 295 |
*/ |
| 296 |
<%if (genModel.useInterfaceOverrideAnnotation()) {%> |
| 297 |
@Override |
| 298 |
<%}%> |
| 299 |
public <%=genModel.getImportedName("java.lang.String")%> getLiteral() |
| 300 |
{ |
| 301 |
return literal; |
| 302 |
} |
| 303 |
|
| 304 |
/** |
| 305 |
* Returns the literal value of the enumerator, which is its string representation. |
| 306 |
* <!-- begin-user-doc --> |
| 307 |
* <!-- end-user-doc --> |
| 308 |
* @generated |
| 309 |
*/ |
| 310 |
<%if (genModel.useClassOverrideAnnotation()) {%> |
| 311 |
@Override |
| 312 |
<%}%> |
| 313 |
public <%=genModel.getImportedName("java.lang.String")%> toString() |
| 314 |
{ |
| 315 |
return literal; |
| 316 |
} |
| 317 |
|
| 318 |
<%}%> |
| 319 |
} //<%=genEnum.getName()%> |
| 320 |
<%if (genModel.isSuppressEMFMetaData()&& !genModel.isSuppressInterfaces() ) {%> |
| 321 |
|
| 322 |
<%if (isEnum) {%> |
| 323 |
/** |
| 324 |
* A private implementation interface used to hide the inheritance from Enumerator. |
| 325 |
* <!-- begin-user-doc --> |
| 326 |
* <!-- end-user-doc --> |
| 327 |
* @generated |
| 328 |
*/ |
| 329 |
interface Internal<%=genEnum.getName()%> extends org.eclipse.emf.common.util.Enumerator |
| 330 |
{ |
| 331 |
// Empty |
| 332 |
} |
| 333 |
<%} else {%> |
| 334 |
/** |
| 335 |
* A private implementation class to construct the instances. |
| 336 |
* <!-- begin-user-doc --> |
| 337 |
* <!-- end-user-doc --> |
| 338 |
* @generated |
| 339 |
*/ |
| 340 |
class Internal<%=genEnum.getName()%> extends org.eclipse.emf.common.util.AbstractEnumerator |
| 341 |
{ |
| 342 |
/** |
| 343 |
* Only this class can construct instances. |
| 344 |
* <!-- begin-user-doc --> |
| 345 |
* <!-- end-user-doc --> |
| 346 |
* @generated |
| 347 |
*/ |
| 348 |
protected Internal<%=genEnum.getName()%>(int value, <%=genModel.getImportedName("java.lang.String")%> name, <%=genModel.getImportedName("java.lang.String")%> literal) |
| 349 |
{ |
| 350 |
super(value, name, literal); |
| 351 |
} |
| 352 |
} |
| 353 |
<%}%> |
| 354 |
<%}%> |
| 355 |
<%genModel.emitSortedImports();%> |