1 /*
   2  * Copyright (c) 2005, 2017, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.lang.model;
  27 
  28 import java.util.Collections;
  29 import java.util.Set;
  30 import java.util.HashSet;
  31 
  32 /**
  33  * Source versions of the Java™ programming language.
  34  *
  35  * See the appropriate edition of
  36  * <cite>The Java&trade; Language Specification</cite>
  37  * for information about a particular source version.
  38  *
  39  * <p>Note that additional source version constants will be added to
  40  * model future releases of the language.
  41  *
  42  * @author Joseph D. Darcy
  43  * @author Scott Seligman
  44  * @author Peter von der Ah&eacute;
  45  * @since 1.6
  46  */
  47 public enum SourceVersion {
  48     /*
  49      * Summary of language evolution
  50      * 1.1: nested classes
  51      * 1.2: strictfp
  52      * 1.3: no changes
  53      * 1.4: assert
  54      * 1.5: annotations, generics, autoboxing, var-args...
  55      * 1.6: no changes
  56      * 1.7: diamond syntax, try-with-resources, etc.
  57      * 1.8: lambda expressions and default methods
  58      *   9: modules, small cleanups to 1.7 and 1.8 changes
  59      *  10: to-be-determined changes
  60      */
  61 
  62     /**
  63      * The original version.
  64      *
  65      * The language described in
  66      * <cite>The Java&trade; Language Specification, First Edition</cite>.
  67      */
  68     RELEASE_0,
  69 
  70     /**
  71      * The version recognized by the Java Platform 1.1.
  72      *
  73      * The language is {@code RELEASE_0} augmented with nested classes as described in the 1.1 update to
  74      * <cite>The Java&trade; Language Specification, First Edition</cite>.
  75      */
  76     RELEASE_1,
  77 
  78     /**
  79      * The version recognized by the Java 2 Platform, Standard Edition,
  80      * v 1.2.
  81      *
  82      * The language described in
  83      * <cite>The Java&trade; Language Specification,
  84      * Second Edition</cite>, which includes the {@code
  85      * strictfp} modifier.
  86      */
  87     RELEASE_2,
  88 
  89     /**
  90      * The version recognized by the Java 2 Platform, Standard Edition,
  91      * v 1.3.
  92      *
  93      * No major changes from {@code RELEASE_2}.
  94      */
  95     RELEASE_3,
  96 
  97     /**
  98      * The version recognized by the Java 2 Platform, Standard Edition,
  99      * v 1.4.
 100      *
 101      * Added a simple assertion facility.
 102      */
 103     RELEASE_4,
 104 
 105     /**
 106      * The version recognized by the Java 2 Platform, Standard
 107      * Edition 5.0.
 108      *
 109      * The language described in
 110      * <cite>The Java&trade; Language Specification,
 111      * Third Edition</cite>.  First release to support
 112      * generics, annotations, autoboxing, var-args, enhanced {@code
 113      * for} loop, and hexadecimal floating-point literals.
 114      */
 115     RELEASE_5,
 116 
 117     /**
 118      * The version recognized by the Java Platform, Standard Edition
 119      * 6.
 120      *
 121      * No major changes from {@code RELEASE_5}.
 122      */
 123     RELEASE_6,
 124 
 125     /**
 126      * The version recognized by the Java Platform, Standard Edition
 127      * 7.
 128      *
 129      * Additions in this release include, diamond syntax for
 130      * constructors, {@code try}-with-resources, strings in switch,
 131      * binary literals, and multi-catch.
 132      * @since 1.7
 133      */
 134     RELEASE_7,
 135 
 136     /**
 137      * The version recognized by the Java Platform, Standard Edition
 138      * 8.
 139      *
 140      * Additions in this release include lambda expressions and default methods.
 141      * @since 1.8
 142      */
 143     RELEASE_8,
 144 
 145     /**
 146      * The version recognized by the Java Platform, Standard Edition
 147      * 9.
 148      *
 149      * Additions in this release include modules and removal of a
 150      * single underscore from the set of legal identifier names.
 151      *
 152      * @since 9
 153      */
 154      RELEASE_9,
 155 
 156     /**
 157      * The version recognized by the Java Platform, Standard Edition
 158      * 10.
 159      *
 160      * @since 10
 161      */
 162      RELEASE_10,
 163 
 164     /**
 165      * The version recognized by the Java Platform, Standard Edition
 166      * 11.
 167      *
 168      * @since 11
 169      */
 170      RELEASE_11;
 171 
 172     // Note that when adding constants for newer releases, the
 173     // behavior of latest() and latestSupported() must be updated too.
 174 
 175     /**
 176      * Returns the latest source version that can be modeled.
 177      *
 178      * @return the latest source version that can be modeled
 179      */
 180     public static SourceVersion latest() {
 181         return RELEASE_11;
 182     }
 183 
 184     private static final SourceVersion latestSupported = getLatestSupported();
 185 
 186     private static SourceVersion getLatestSupported() {
 187         try {
 188             String specVersion = System.getProperty("java.specification.version");
 189 
 190             switch (specVersion) {
 191                 case "11":
 192                     return RELEASE_11;
 193                 case "10":
 194                     return RELEASE_10;
 195                 case "9":
 196                     return RELEASE_9;
 197                 case "1.8":
 198                     return RELEASE_8;
 199                 case "1.7":
 200                     return RELEASE_7;
 201                 case "1.6":
 202                     return RELEASE_6;
 203             }
 204         } catch (SecurityException se) {}
 205 
 206         return RELEASE_5;
 207     }
 208 
 209     /**
 210      * Returns the latest source version fully supported by the
 211      * current execution environment.  {@code RELEASE_5} or later must
 212      * be returned.
 213      *
 214      * @return the latest source version that is fully supported
 215      */
 216     public static SourceVersion latestSupported() {
 217         return latestSupported;
 218     }
 219 
 220     /**
 221      * Returns whether or not {@code name} is a syntactically valid
 222      * identifier (simple name) or keyword in the latest source
 223      * version.  The method returns {@code true} if the name consists
 224      * of an initial character for which {@link
 225      * Character#isJavaIdentifierStart(int)} returns {@code true},
 226      * followed only by characters for which {@link
 227      * Character#isJavaIdentifierPart(int)} returns {@code true}.
 228      * This pattern matches regular identifiers, keywords, restricted
 229      * keywords, and the literals {@code "true"}, {@code "false"}, and
 230      * {@code "null"}.
 231      * The method returns {@code false} for all other strings.
 232      *
 233      * @param name the string to check
 234      * @return {@code true} if this string is a
 235      * syntactically valid identifier or keyword, {@code false}
 236      * otherwise.
 237      */
 238     public static boolean isIdentifier(CharSequence name) {
 239         String id = name.toString();
 240 
 241         if (id.length() == 0) {
 242             return false;
 243         }
 244         int cp = id.codePointAt(0);
 245         if (!Character.isJavaIdentifierStart(cp)) {
 246             return false;
 247         }
 248         for (int i = Character.charCount(cp);
 249                 i < id.length();
 250                 i += Character.charCount(cp)) {
 251             cp = id.codePointAt(i);
 252             if (!Character.isJavaIdentifierPart(cp)) {
 253                 return false;
 254             }
 255         }
 256         return true;
 257     }
 258 
 259     /**
 260      * Returns whether or not {@code name} is a syntactically valid
 261      * qualified name in the latest source version.  Unlike {@link
 262      * #isIdentifier isIdentifier}, this method returns {@code false}
 263      * for keywords, boolean literals, and the null literal.
 264      * This method returns {@code true} for <i>restricted
 265      * keywords</i>.
 266      *
 267      * @param name the string to check
 268      * @return {@code true} if this string is a
 269      * syntactically valid name, {@code false} otherwise.
 270      * @jls 3.9 Keywords
 271      * @jls 6.2 Names and Identifiers
 272      */
 273     public static boolean isName(CharSequence name) {
 274         return isName(name, latest());
 275     }
 276 
 277     /**
 278      * Returns whether or not {@code name} is a syntactically valid
 279      * qualified name in the given source version.  Unlike {@link
 280      * #isIdentifier isIdentifier}, this method returns {@code false}
 281      * for keywords, boolean literals, and the null literal.
 282      * This method returns {@code true} for <i>restricted
 283      * keywords</i>.
 284      *
 285      * @param name the string to check
 286      * @param version the version to use
 287      * @return {@code true} if this string is a
 288      * syntactically valid name, {@code false} otherwise.
 289      * @jls 3.9 Keywords
 290      * @jls 6.2 Names and Identifiers
 291      * @since 9
 292      */
 293     public static boolean isName(CharSequence name, SourceVersion version) {
 294         String id = name.toString();
 295 
 296         for(String s : id.split("\\.", -1)) {
 297             if (!isIdentifier(s) || isKeyword(s, version))
 298                 return false;
 299         }
 300         return true;
 301     }
 302 
 303     /**
 304      * Returns whether or not {@code s} is a keyword, boolean literal,
 305      * or null literal in the latest source version.
 306      * This method returns {@code false} for <i>restricted
 307      * keywords</i>.
 308      *
 309      * @param s the string to check
 310      * @return {@code true} if {@code s} is a keyword, or boolean
 311      * literal, or null literal, {@code false} otherwise.
 312      * @jls 3.9 Keywords
 313      * @jls 3.10.3 Boolean Literals
 314      * @jls 3.10.7 The Null Literal
 315      */
 316     public static boolean isKeyword(CharSequence s) {
 317         return isKeyword(s, latest());
 318     }
 319 
 320     /**
 321      * Returns whether or not {@code s} is a keyword, boolean literal,
 322      * or null literal in the given source version.
 323      * This method returns {@code false} for <i>restricted
 324      * keywords</i>.
 325      *
 326      * @param s the string to check
 327      * @param version the version to use
 328      * @return {@code true} if {@code s} is a keyword, or boolean
 329      * literal, or null literal, {@code false} otherwise.
 330      * @jls 3.9 Keywords
 331      * @jls 3.10.3 Boolean Literals
 332      * @jls 3.10.7 The Null Literal
 333      * @since 9
 334      */
 335     public static boolean isKeyword(CharSequence s, SourceVersion version) {
 336         String id = s.toString();
 337         switch(id) {
 338             // A trip through history
 339         case "strictfp":
 340             return version.compareTo(RELEASE_2) >= 0;
 341 
 342         case "assert":
 343             return version.compareTo(RELEASE_4) >= 0;
 344 
 345         case "enum":
 346             return version.compareTo(RELEASE_5) >= 0;
 347 
 348         case "_":
 349             return version.compareTo(RELEASE_9) >= 0;
 350 
 351             // Keywords common across versions
 352 
 353             // Modifiers
 354         case "public":    case "protected": case "private":
 355         case "abstract":  case "static":    case "final":
 356         case "transient": case "volatile":  case "synchronized":
 357         case "native":
 358 
 359             // Declarations
 360         case "class":     case "interface": case "extends":
 361         case "package":   case "throws":    case "implements":
 362 
 363             // Primitive types and void
 364         case "boolean":   case "byte":      case "char":
 365         case "short":     case "int":       case "long":
 366         case "float":     case "double":
 367         case "void":
 368 
 369             // Control flow
 370         case "if":      case "else":
 371         case "try":     case "catch":    case "finally":
 372         case "do":      case "while":
 373         case "for":     case "continue":
 374         case "switch":  case "case":     case "default":
 375         case "break":   case "throw":    case "return":
 376 
 377             // Other keywords
 378         case  "this":   case "new":      case "super":
 379         case "import":  case "instanceof":
 380 
 381             // Forbidden!
 382         case "goto":        case "const":
 383 
 384             // literals
 385         case "null":         case "true":       case "false":
 386             return true;
 387 
 388         default:
 389             return false;
 390         }
 391     }
 392 }