1/* 2 * Copyright (c) 1995, 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 26package java.lang; 27 28import java.io.*; 29import java.math.BigInteger; 30import java.util.ArrayList; 31import java.util.regex.Matcher; 32import java.util.regex.Pattern; 33import java.util.stream.Collectors; 34import java.util.Collections; 35import java.util.List; 36import java.util.Optional; 37import java.util.StringTokenizer; 38import jdk.internal.reflect.CallerSensitive; 39import jdk.internal.reflect.Reflection; 40 41/** 42 * Every Java application has a single instance of class 43 * {@code Runtime} that allows the application to interface with 44 * the environment in which the application is running. The current 45 * runtime can be obtained from the {@code getRuntime} method. 46 * <p> 47 * An application cannot create its own instance of this class. 48 * 49 * @author unascribed 50 * @see java.lang.Runtime#getRuntime() 51 * @since 1.0 52 */ 53 54public class Runtime { 55 private static final Runtime currentRuntime = new Runtime(); 56 57 private static Version version; 58 59 /** 60 * Returns the runtime object associated with the current Java application. 61 * Most of the methods of class {@code Runtime} are instance 62 * methods and must be invoked with respect to the current runtime object. 63 * 64 * @return the {@code Runtime} object associated with the current 65 * Java application. 66 */ 67 public static Runtime getRuntime() { 68 return currentRuntime; 69 } 70 71 /** Don't let anyone else instantiate this class */ 72 private Runtime() {} 73 74 /** 75 * Terminates the currently running Java virtual machine by initiating its 76 * shutdown sequence. This method never returns normally. The argument 77 * serves as a status code; by convention, a nonzero status code indicates 78 * abnormal termination. 79 * 80 * <p> The virtual machine's shutdown sequence consists of two phases. In 81 * the first phase all registered {@link #addShutdownHook shutdown hooks}, 82 * if any, are started in some unspecified order and allowed to run 83 * concurrently until they finish. In the second phase all uninvoked 84 * finalizers are run if {@link #runFinalizersOnExit finalization-on-exit} 85 * has been enabled. Once this is done the virtual machine {@link #halt halts}. 86 * 87 * <p> If this method is invoked after the virtual machine has begun its 88 * shutdown sequence then if shutdown hooks are being run this method will 89 * block indefinitely. If shutdown hooks have already been run and on-exit 90 * finalization has been enabled then this method halts the virtual machine 91 * with the given status code if the status is nonzero; otherwise, it 92 * blocks indefinitely. 93 * 94 * <p> The {@link System#exit(int) System.exit} method is the 95 * conventional and convenient means of invoking this method. 96 * 97 * @param status 98 * Termination status. By convention, a nonzero status code 99 * indicates abnormal termination. 100 * 101 * @throws SecurityException 102 * If a security manager is present and its 103 * {@link SecurityManager#checkExit checkExit} method does not permit 104 * exiting with the specified status 105 * 106 * @see java.lang.SecurityException 107 * @see java.lang.SecurityManager#checkExit(int) 108 * @see #addShutdownHook 109 * @see #removeShutdownHook 110 * @see #runFinalizersOnExit 111 * @see #halt(int) 112 */ 113 public void exit(int status) { 114 SecurityManager security = System.getSecurityManager(); 115 if (security != null) { 116 security.checkExit(status); 117 } 118 Shutdown.exit(status); 119 } 120 121 /** 122 * Registers a new virtual-machine shutdown hook. 123 * 124 * <p> The Java virtual machine <i>shuts down</i> in response to two kinds 125 * of events: 126 * 127 * <ul> 128 * 129 * <li> The program <i>exits</i> normally, when the last non-daemon 130 * thread exits or when the {@link #exit exit} (equivalently, 131 * {@link System#exit(int) System.exit}) method is invoked, or 132 * 133 * <li> The virtual machine is <i>terminated</i> in response to a 134 * user interrupt, such as typing {@code ^C}, or a system-wide event, 135 * such as user logoff or system shutdown. 136 * 137 * </ul> 138 * 139 * <p> A <i>shutdown hook</i> is simply an initialized but unstarted 140 * thread. When the virtual machine begins its shutdown sequence it will 141 * start all registered shutdown hooks in some unspecified order and let 142 * them run concurrently. When all the hooks have finished it will then 143 * run all uninvoked finalizers if finalization-on-exit has been enabled. 144 * Finally, the virtual machine will halt. Note that daemon threads will 145 * continue to run during the shutdown sequence, as will non-daemon threads 146 * if shutdown was initiated by invoking the {@link #exit exit} method. 147 * 148 * <p> Once the shutdown sequence has begun it can be stopped only by 149 * invoking the {@link #halt halt} method, which forcibly 150 * terminates the virtual machine. 151 * 152 * <p> Once the shutdown sequence has begun it is impossible to register a 153 * new shutdown hook or de-register a previously-registered hook. 154 * Attempting either of these operations will cause an 155 * {@link IllegalStateException} to be thrown. 156 * 157 * <p> Shutdown hooks run at a delicate time in the life cycle of a virtual 158 * machine and should therefore be coded defensively. They should, in 159 * particular, be written to be thread-safe and to avoid deadlocks insofar 160 * as possible. They should also not rely blindly upon services that may 161 * have registered their own shutdown hooks and therefore may themselves in 162 * the process of shutting down. Attempts to use other thread-based 163 * services such as the AWT event-dispatch thread, for example, may lead to 164 * deadlocks. 165 * 166 * <p> Shutdown hooks should also finish their work quickly. When a 167 * program invokes {@link #exit exit} the expectation is 168 * that the virtual machine will promptly shut down and exit. When the 169 * virtual machine is terminated due to user logoff or system shutdown the 170 * underlying operating system may only allow a fixed amount of time in 171 * which to shut down and exit. It is therefore inadvisable to attempt any 172 * user interaction or to perform a long-running computation in a shutdown 173 * hook. 174 * 175 * <p> Uncaught exceptions are handled in shutdown hooks just as in any 176 * other thread, by invoking the 177 * {@link ThreadGroup#uncaughtException uncaughtException} method of the 178 * thread's {@link ThreadGroup} object. The default implementation of this 179 * method prints the exception's stack trace to {@link System#err} and 180 * terminates the thread; it does not cause the virtual machine to exit or 181 * halt. 182 * 183 * <p> In rare circumstances the virtual machine may <i>abort</i>, that is, 184 * stop running without shutting down cleanly. This occurs when the 185 * virtual machine is terminated externally, for example with the 186 * {@code SIGKILL} signal on Unix or the {@code TerminateProcess} call on 187 * Microsoft Windows. The virtual machine may also abort if a native 188 * method goes awry by, for example, corrupting internal data structures or 189 * attempting to access nonexistent memory. If the virtual machine aborts 190 * then no guarantee can be made about whether or not any shutdown hooks 191 * will be run. 192 * 193 * @param hook 194 * An initialized but unstarted {@link Thread} object 195 * 196 * @throws IllegalArgumentException 197 * If the specified hook has already been registered, 198 * or if it can be determined that the hook is already running or 199 * has already been run 200 * 201 * @throws IllegalStateException 202 * If the virtual machine is already in the process 203 * of shutting down 204 * 205 * @throws SecurityException 206 * If a security manager is present and it denies 207 * {@link RuntimePermission}("shutdownHooks") 208 * 209 * @see #removeShutdownHook 210 * @see #halt(int) 211 * @see #exit(int) 212 * @since 1.3 213 */ 214 public void addShutdownHook(Thread hook) { 215 SecurityManager sm = System.getSecurityManager(); 216 if (sm != null) { 217 sm.checkPermission(new RuntimePermission("shutdownHooks")); 218 } 219 ApplicationShutdownHooks.add(hook); 220 } 221 222 /** 223 * De-registers a previously-registered virtual-machine shutdown hook. 224 * 225 * @param hook the hook to remove 226 * @return {@code true} if the specified hook had previously been 227 * registered and was successfully de-registered, {@code false} 228 * otherwise. 229 * 230 * @throws IllegalStateException 231 * If the virtual machine is already in the process of shutting 232 * down 233 * 234 * @throws SecurityException 235 * If a security manager is present and it denies 236 * {@link RuntimePermission}("shutdownHooks") 237 * 238 * @see #addShutdownHook 239 * @see #exit(int) 240 * @since 1.3 241 */ 242 public boolean removeShutdownHook(Thread hook) { 243 SecurityManager sm = System.getSecurityManager(); 244 if (sm != null) { 245 sm.checkPermission(new RuntimePermission("shutdownHooks")); 246 } 247 return ApplicationShutdownHooks.remove(hook); 248 } 249 250 /** 251 * Forcibly terminates the currently running Java virtual machine. This 252 * method never returns normally. 253 * 254 * <p> This method should be used with extreme caution. Unlike the 255 * {@link #exit exit} method, this method does not cause shutdown 256 * hooks to be started and does not run uninvoked finalizers if 257 * finalization-on-exit has been enabled. If the shutdown sequence has 258 * already been initiated then this method does not wait for any running 259 * shutdown hooks or finalizers to finish their work. 260 * 261 * @param status 262 * Termination status. By convention, a nonzero status code 263 * indicates abnormal termination. If the {@link Runtime#exit exit} 264 * (equivalently, {@link System#exit(int) System.exit}) method 265 * has already been invoked then this status code 266 * will override the status code passed to that method. 267 * 268 * @throws SecurityException 269 * If a security manager is present and its 270 * {@link SecurityManager#checkExit checkExit} method 271 * does not permit an exit with the specified status 272 * 273 * @see #exit 274 * @see #addShutdownHook 275 * @see #removeShutdownHook 276 * @since 1.3 277 */ 278 public void halt(int status) { 279 SecurityManager sm = System.getSecurityManager(); 280 if (sm != null) { 281 sm.checkExit(status); 282 } 283 Shutdown.halt(status); 284 } 285 286 /** 287 * Enable or disable finalization on exit; doing so specifies that the 288 * finalizers of all objects that have finalizers that have not yet been 289 * automatically invoked are to be run before the Java runtime exits. 290 * By default, finalization on exit is disabled. 291 * 292 * <p>If there is a security manager, 293 * its {@code checkExit} method is first called 294 * with 0 as its argument to ensure the exit is allowed. 295 * This could result in a SecurityException. 296 * 297 * @param value true to enable finalization on exit, false to disable 298 * @deprecated This method is inherently unsafe. It may result in 299 * finalizers being called on live objects while other threads are 300 * concurrently manipulating those objects, resulting in erratic 301 * behavior or deadlock. 302 * This method is subject to removal in a future version of Java SE. 303 * 304 * @throws SecurityException 305 * if a security manager exists and its {@code checkExit} 306 * method doesn't allow the exit. 307 * 308 * @see java.lang.Runtime#exit(int) 309 * @see java.lang.Runtime#gc() 310 * @see java.lang.SecurityManager#checkExit(int) 311 * @since 1.1 312 */ 313 @Deprecated(since="1.2", forRemoval=true) 314 public static void runFinalizersOnExit(boolean value) { 315 SecurityManager security = System.getSecurityManager(); 316 if (security != null) { 317 try { 318 security.checkExit(0); 319 } catch (SecurityException e) { 320 throw new SecurityException("runFinalizersOnExit"); 321 } 322 } 323 Shutdown.setRunFinalizersOnExit(value); 324 } 325 326 /** 327 * Executes the specified string command in a separate process. 328 * 329 * <p>This is a convenience method. An invocation of the form 330 * {@code exec(command)} 331 * behaves in exactly the same way as the invocation 332 * {@link #exec(String, String[], File) exec}{@code (command, null, null)}. 333 * 334 * @param command a specified system command. 335 * 336 * @return A new {@link Process} object for managing the subprocess 337 * 338 * @throws SecurityException 339 * If a security manager exists and its 340 * {@link SecurityManager#checkExec checkExec} 341 * method doesn't allow creation of the subprocess 342 * 343 * @throws IOException 344 * If an I/O error occurs 345 * 346 * @throws NullPointerException 347 * If {@code command} is {@code null} 348 * 349 * @throws IllegalArgumentException 350 * If {@code command} is empty 351 * 352 * @see #exec(String[], String[], File) 353 * @see ProcessBuilder 354 */ 355 public Process exec(String command) throws IOException { 356 return exec(command, null, null); 357 } 358 359 /** 360 * Executes the specified string command in a separate process with the 361 * specified environment. 362 * 363 * <p>This is a convenience method. An invocation of the form 364 * {@code exec(command, envp)} 365 * behaves in exactly the same way as the invocation 366 * {@link #exec(String, String[], File) exec}{@code (command, envp, null)}. 367 * 368 * @param command a specified system command. 369 * 370 * @param envp array of strings, each element of which 371 * has environment variable settings in the format 372 * <i>name</i>=<i>value</i>, or 373 * {@code null} if the subprocess should inherit 374 * the environment of the current process. 375 * 376 * @return A new {@link Process} object for managing the subprocess 377 * 378 * @throws SecurityException 379 * If a security manager exists and its 380 * {@link SecurityManager#checkExec checkExec} 381 * method doesn't allow creation of the subprocess 382 * 383 * @throws IOException 384 * If an I/O error occurs 385 * 386 * @throws NullPointerException 387 * If {@code command} is {@code null}, 388 * or one of the elements of {@code envp} is {@code null} 389 * 390 * @throws IllegalArgumentException 391 * If {@code command} is empty 392 * 393 * @see #exec(String[], String[], File) 394 * @see ProcessBuilder 395 */ 396 public Process exec(String command, String[] envp) throws IOException { 397 return exec(command, envp, null); 398 } 399 400 /** 401 * Executes the specified string command in a separate process with the 402 * specified environment and working directory. 403 * 404 * <p>This is a convenience method. An invocation of the form 405 * {@code exec(command, envp, dir)} 406 * behaves in exactly the same way as the invocation 407 * {@link #exec(String[], String[], File) exec}{@code (cmdarray, envp, dir)}, 408 * where {@code cmdarray} is an array of all the tokens in 409 * {@code command}. 410 * 411 * <p>More precisely, the {@code command} string is broken 412 * into tokens using a {@link StringTokenizer} created by the call 413 * {@code new {@link StringTokenizer}(command)} with no 414 * further modification of the character categories. The tokens 415 * produced by the tokenizer are then placed in the new string 416 * array {@code cmdarray}, in the same order. 417 * 418 * @param command a specified system command. 419 * 420 * @param envp array of strings, each element of which 421 * has environment variable settings in the format 422 * <i>name</i>=<i>value</i>, or 423 * {@code null} if the subprocess should inherit 424 * the environment of the current process. 425 * 426 * @param dir the working directory of the subprocess, or 427 * {@code null} if the subprocess should inherit 428 * the working directory of the current process. 429 * 430 * @return A new {@link Process} object for managing the subprocess 431 * 432 * @throws SecurityException 433 * If a security manager exists and its 434 * {@link SecurityManager#checkExec checkExec} 435 * method doesn't allow creation of the subprocess 436 * 437 * @throws IOException 438 * If an I/O error occurs 439 * 440 * @throws NullPointerException 441 * If {@code command} is {@code null}, 442 * or one of the elements of {@code envp} is {@code null} 443 * 444 * @throws IllegalArgumentException 445 * If {@code command} is empty 446 * 447 * @see ProcessBuilder 448 * @since 1.3 449 */ 450 public Process exec(String command, String[] envp, File dir) 451 throws IOException { 452 if (command.length() == 0) 453 throw new IllegalArgumentException("Empty command"); 454 455 StringTokenizer st = new StringTokenizer(command); 456 String[] cmdarray = new String[st.countTokens()]; 457 for (int i = 0; st.hasMoreTokens(); i++) 458 cmdarray[i] = st.nextToken(); 459 return exec(cmdarray, envp, dir); 460 } 461 462 /** 463 * Executes the specified command and arguments in a separate process. 464 * 465 * <p>This is a convenience method. An invocation of the form 466 * {@code exec(cmdarray)} 467 * behaves in exactly the same way as the invocation 468 * {@link #exec(String[], String[], File) exec}{@code (cmdarray, null, null)}. 469 * 470 * @param cmdarray array containing the command to call and 471 * its arguments. 472 * 473 * @return A new {@link Process} object for managing the subprocess 474 * 475 * @throws SecurityException 476 * If a security manager exists and its 477 * {@link SecurityManager#checkExec checkExec} 478 * method doesn't allow creation of the subprocess 479 * 480 * @throws IOException 481 * If an I/O error occurs 482 * 483 * @throws NullPointerException 484 * If {@code cmdarray} is {@code null}, 485 * or one of the elements of {@code cmdarray} is {@code null} 486 * 487 * @throws IndexOutOfBoundsException 488 * If {@code cmdarray} is an empty array 489 * (has length {@code 0}) 490 * 491 * @see ProcessBuilder 492 */ 493 public Process exec(String cmdarray[]) throws IOException { 494 return exec(cmdarray, null, null); 495 } 496 497 /** 498 * Executes the specified command and arguments in a separate process 499 * with the specified environment. 500 * 501 * <p>This is a convenience method. An invocation of the form 502 * {@code exec(cmdarray, envp)} 503 * behaves in exactly the same way as the invocation 504 * {@link #exec(String[], String[], File) exec}{@code (cmdarray, envp, null)}. 505 * 506 * @param cmdarray array containing the command to call and 507 * its arguments. 508 * 509 * @param envp array of strings, each element of which 510 * has environment variable settings in the format 511 * <i>name</i>=<i>value</i>, or 512 * {@code null} if the subprocess should inherit 513 * the environment of the current process. 514 * 515 * @return A new {@link Process} object for managing the subprocess 516 * 517 * @throws SecurityException 518 * If a security manager exists and its 519 * {@link SecurityManager#checkExec checkExec} 520 * method doesn't allow creation of the subprocess 521 * 522 * @throws IOException 523 * If an I/O error occurs 524 * 525 * @throws NullPointerException 526 * If {@code cmdarray} is {@code null}, 527 * or one of the elements of {@code cmdarray} is {@code null}, 528 * or one of the elements of {@code envp} is {@code null} 529 * 530 * @throws IndexOutOfBoundsException 531 * If {@code cmdarray} is an empty array 532 * (has length {@code 0}) 533 * 534 * @see ProcessBuilder 535 */ 536 public Process exec(String[] cmdarray, String[] envp) throws IOException { 537 return exec(cmdarray, envp, null); 538 } 539 540 541 /** 542 * Executes the specified command and arguments in a separate process with 543 * the specified environment and working directory. 544 * 545 * <p>Given an array of strings {@code cmdarray}, representing the 546 * tokens of a command line, and an array of strings {@code envp}, 547 * representing "environment" variable settings, this method creates 548 * a new process in which to execute the specified command. 549 * 550 * <p>This method checks that {@code cmdarray} is a valid operating 551 * system command. Which commands are valid is system-dependent, 552 * but at the very least the command must be a non-empty list of 553 * non-null strings. 554 * 555 * <p>If {@code envp} is {@code null}, the subprocess inherits the 556 * environment settings of the current process. 557 * 558 * <p>A minimal set of system dependent environment variables may 559 * be required to start a process on some operating systems. 560 * As a result, the subprocess may inherit additional environment variable 561 * settings beyond those in the specified environment. 562 * 563 * <p>{@link ProcessBuilder#start()} is now the preferred way to 564 * start a process with a modified environment. 565 * 566 * <p>The working directory of the new subprocess is specified by {@code dir}. 567 * If {@code dir} is {@code null}, the subprocess inherits the 568 * current working directory of the current process. 569 * 570 * <p>If a security manager exists, its 571 * {@link SecurityManager#checkExec checkExec} 572 * method is invoked with the first component of the array 573 * {@code cmdarray} as its argument. This may result in a 574 * {@link SecurityException} being thrown. 575 * 576 * <p>Starting an operating system process is highly system-dependent. 577 * Among the many things that can go wrong are: 578 * <ul> 579 * <li>The operating system program file was not found. 580 * <li>Access to the program file was denied. 581 * <li>The working directory does not exist. 582 * </ul> 583 * 584 * <p>In such cases an exception will be thrown. The exact nature 585 * of the exception is system-dependent, but it will always be a 586 * subclass of {@link IOException}. 587 * 588 * <p>If the operating system does not support the creation of 589 * processes, an {@link UnsupportedOperationException} will be thrown. 590 * 591 * 592 * @param cmdarray array containing the command to call and 593 * its arguments. 594 * 595 * @param envp array of strings, each element of which 596 * has environment variable settings in the format 597 * <i>name</i>=<i>value</i>, or 598 * {@code null} if the subprocess should inherit 599 * the environment of the current process. 600 * 601 * @param dir the working directory of the subprocess, or 602 * {@code null} if the subprocess should inherit 603 * the working directory of the current process. 604 * 605 * @return A new {@link Process} object for managing the subprocess 606 * 607 * @throws SecurityException 608 * If a security manager exists and its 609 * {@link SecurityManager#checkExec checkExec} 610 * method doesn't allow creation of the subprocess 611 * 612 * @throws UnsupportedOperationException 613 * If the operating system does not support the creation of processes. 614 * 615 * @throws IOException 616 * If an I/O error occurs 617 * 618 * @throws NullPointerException 619 * If {@code cmdarray} is {@code null}, 620 * or one of the elements of {@code cmdarray} is {@code null}, 621 * or one of the elements of {@code envp} is {@code null} 622 * 623 * @throws IndexOutOfBoundsException 624 * If {@code cmdarray} is an empty array 625 * (has length {@code 0}) 626 * 627 * @see ProcessBuilder 628 * @since 1.3 629 */ 630 public Process exec(String[] cmdarray, String[] envp, File dir) 631 throws IOException { 632 return new ProcessBuilder(cmdarray) 633 .environment(envp) 634 .directory(dir) 635 .start(); 636 } 637 638 /** 639 * Returns the number of processors available to the Java virtual machine. 640 * 641 * <p> This value may change during a particular invocation of the virtual 642 * machine. Applications that are sensitive to the number of available 643 * processors should therefore occasionally poll this property and adjust 644 * their resource usage appropriately. </p> 645 * 646 * @return the maximum number of processors available to the virtual 647 * machine; never smaller than one 648 * @since 1.4 649 */ 650 public native int availableProcessors(); 651 652 /** 653 * Returns the amount of free memory in the Java Virtual Machine. 654 * Calling the 655 * {@code gc} method may result in increasing the value returned 656 * by {@code freeMemory.} 657 * 658 * @return an approximation to the total amount of memory currently 659 * available for future allocated objects, measured in bytes. 660 */ 661 public native long freeMemory(); 662 663 /** 664 * Returns the total amount of memory in the Java virtual machine. 665 * The value returned by this method may vary over time, depending on 666 * the host environment. 667 * <p> 668 * Note that the amount of memory required to hold an object of any 669 * given type may be implementation-dependent. 670 * 671 * @return the total amount of memory currently available for current 672 * and future objects, measured in bytes. 673 */ 674 public native long totalMemory(); 675 676 /** 677 * Returns the maximum amount of memory that the Java virtual machine 678 * will attempt to use. If there is no inherent limit then the value 679 * {@link java.lang.Long#MAX_VALUE} will be returned. 680 * 681 * @return the maximum amount of memory that the virtual machine will 682 * attempt to use, measured in bytes 683 * @since 1.4 684 */ 685 public native long maxMemory(); 686 687 /** 688 * Runs the garbage collector. 689 * Calling this method suggests that the Java virtual machine expend 690 * effort toward recycling unused objects in order to make the memory 691 * they currently occupy available for quick reuse. When control 692 * returns from the method call, the virtual machine has made 693 * its best effort to recycle all discarded objects. 694 * <p> 695 * The name {@code gc} stands for "garbage 696 * collector". The virtual machine performs this recycling 697 * process automatically as needed, in a separate thread, even if the 698 * {@code gc} method is not invoked explicitly. 699 * <p> 700 * The method {@link System#gc()} is the conventional and convenient 701 * means of invoking this method. 702 */ 703 public native void gc(); 704 705 /* Wormhole for calling java.lang.ref.Finalizer.runFinalization */ 706 private static native void runFinalization0(); 707 708 /** 709 * Runs the finalization methods of any objects pending finalization. 710 * Calling this method suggests that the Java virtual machine expend 711 * effort toward running the {@code finalize} methods of objects 712 * that have been found to be discarded but whose {@code finalize} 713 * methods have not yet been run. When control returns from the 714 * method call, the virtual machine has made a best effort to 715 * complete all outstanding finalizations. 716 * <p> 717 * The virtual machine performs the finalization process 718 * automatically as needed, in a separate thread, if the 719 * {@code runFinalization} method is not invoked explicitly. 720 * <p> 721 * The method {@link System#runFinalization()} is the conventional 722 * and convenient means of invoking this method. 723 * 724 * @see java.lang.Object#finalize() 725 */ 726 public void runFinalization() { 727 runFinalization0(); 728 } 729 730 /** 731 * Not implemented, does nothing. 732 * 733 * @deprecated 734 * This method was intended to control instruction tracing. 735 * It has been superseded by JVM-specific tracing mechanisms. 736 * This method is subject to removal in a future version of Java SE. 737 * 738 * @param on ignored 739 */ 740 @Deprecated(since="9", forRemoval=true) 741 public void traceInstructions(boolean on) { } 742 743 /** 744 * Not implemented, does nothing. 745 * 746 * @deprecated 747 * This method was intended to control method call tracing. 748 * It has been superseded by JVM-specific tracing mechanisms. 749 * This method is subject to removal in a future version of Java SE. 750 * 751 * @param on ignored 752 */ 753 @Deprecated(since="9", forRemoval=true) 754 public void traceMethodCalls(boolean on) { } 755 756 /** 757 * Loads the native library specified by the filename argument. The filename 758 * argument must be an absolute path name. 759 * (for example 760 * {@code Runtime.getRuntime().load("/home/avh/lib/libX11.so");}). 761 * 762 * If the filename argument, when stripped of any platform-specific library 763 * prefix, path, and file extension, indicates a library whose name is, 764 * for example, L, and a native library called L is statically linked 765 * with the VM, then the JNI_OnLoad_L function exported by the library 766 * is invoked rather than attempting to load a dynamic library. 767 * A filename matching the argument does not have to exist in the file 768 * system. See the JNI Specification for more details. 769 * 770 * Otherwise, the filename argument is mapped to a native library image in 771 * an implementation-dependent manner. 772 * <p> 773 * First, if there is a security manager, its {@code checkLink} 774 * method is called with the {@code filename} as its argument. 775 * This may result in a security exception. 776 * <p> 777 * This is similar to the method {@link #loadLibrary(String)}, but it 778 * accepts a general file name as an argument rather than just a library 779 * name, allowing any file of native code to be loaded. 780 * <p> 781 * The method {@link System#load(String)} is the conventional and 782 * convenient means of invoking this method. 783 * 784 * @param filename the file to load. 785 * @exception SecurityException if a security manager exists and its 786 * {@code checkLink} method doesn't allow 787 * loading of the specified dynamic library 788 * @exception UnsatisfiedLinkError if either the filename is not an 789 * absolute path name, the native library is not statically 790 * linked with the VM, or the library cannot be mapped to 791 * a native library image by the host system. 792 * @exception NullPointerException if {@code filename} is 793 * {@code null} 794 * @see java.lang.Runtime#getRuntime() 795 * @see java.lang.SecurityException 796 * @see java.lang.SecurityManager#checkLink(java.lang.String) 797 */ 798 @CallerSensitive 799 public void load(String filename) { 800 load0(Reflection.getCallerClass(), filename); 801 } 802 803 synchronized void load0(Class<?> fromClass, String filename) { 804 SecurityManager security = System.getSecurityManager(); 805 if (security != null) { 806 security.checkLink(filename); 807 } 808 if (!(new File(filename).isAbsolute())) { 809 throw new UnsatisfiedLinkError( 810 "Expecting an absolute path of the library: " + filename); 811 } 812 ClassLoader.loadLibrary(fromClass, filename, true); 813 } 814 815 /** 816 * Loads the native library specified by the {@code libname} 817 * argument. The {@code libname} argument must not contain any platform 818 * specific prefix, file extension or path. If a native library 819 * called {@code libname} is statically linked with the VM, then the 820 * JNI_OnLoad_{@code libname} function exported by the library is invoked. 821 * See the JNI Specification for more details. 822 * 823 * Otherwise, the libname argument is loaded from a system library 824 * location and mapped to a native library image in an implementation- 825 * dependent manner. 826 * <p> 827 * First, if there is a security manager, its {@code checkLink} 828 * method is called with the {@code libname} as its argument. 829 * This may result in a security exception. 830 * <p> 831 * The method {@link System#loadLibrary(String)} is the conventional 832 * and convenient means of invoking this method. If native 833 * methods are to be used in the implementation of a class, a standard 834 * strategy is to put the native code in a library file (call it 835 * {@code LibFile}) and then to put a static initializer: 836 * <blockquote><pre> 837 * static { System.loadLibrary("LibFile"); } 838 * </pre></blockquote> 839 * within the class declaration. When the class is loaded and 840 * initialized, the necessary native code implementation for the native 841 * methods will then be loaded as well. 842 * <p> 843 * If this method is called more than once with the same library 844 * name, the second and subsequent calls are ignored. 845 * 846 * @param libname the name of the library. 847 * @exception SecurityException if a security manager exists and its 848 * {@code checkLink} method doesn't allow 849 * loading of the specified dynamic library 850 * @exception UnsatisfiedLinkError if either the libname argument 851 * contains a file path, the native library is not statically 852 * linked with the VM, or the library cannot be mapped to a 853 * native library image by the host system. 854 * @exception NullPointerException if {@code libname} is 855 * {@code null} 856 * @see java.lang.SecurityException 857 * @see java.lang.SecurityManager#checkLink(java.lang.String) 858 */ 859 @CallerSensitive 860 public void loadLibrary(String libname) { 861 loadLibrary0(Reflection.getCallerClass(), libname); 862 } 863 864 synchronized void loadLibrary0(Class<?> fromClass, String libname) { 865 SecurityManager security = System.getSecurityManager(); 866 if (security != null) { 867 security.checkLink(libname); 868 } 869 if (libname.indexOf((int)File.separatorChar) != -1) { 870 throw new UnsatisfiedLinkError( 871 "Directory separator should not appear in library name: " + libname); 872 } 873 ClassLoader.loadLibrary(fromClass, libname, false); 874 } 875 876 /** 877 * Creates a localized version of an input stream. This method takes 878 * an {@code InputStream} and returns an {@code InputStream} 879 * equivalent to the argument in all respects except that it is 880 * localized: as characters in the local character set are read from 881 * the stream, they are automatically converted from the local 882 * character set to Unicode. 883 * <p> 884 * If the argument is already a localized stream, it may be returned 885 * as the result. 886 * 887 * @param in InputStream to localize 888 * @return a localized input stream 889 * @see java.io.InputStream 890 * @see java.io.BufferedReader#BufferedReader(java.io.Reader) 891 * @see java.io.InputStreamReader#InputStreamReader(java.io.InputStream) 892 * @deprecated As of JDK 1.1, the preferred way to translate a byte 893 * stream in the local encoding into a character stream in Unicode is via 894 * the {@code InputStreamReader} and {@code BufferedReader} 895 * classes. 896 * This method is subject to removal in a future version of Java SE. 897 */ 898 @Deprecated(since="1.1", forRemoval=true) 899 public InputStream getLocalizedInputStream(InputStream in) { 900 return in; 901 } 902 903 /** 904 * Creates a localized version of an output stream. This method 905 * takes an {@code OutputStream} and returns an 906 * {@code OutputStream} equivalent to the argument in all respects 907 * except that it is localized: as Unicode characters are written to 908 * the stream, they are automatically converted to the local 909 * character set. 910 * <p> 911 * If the argument is already a localized stream, it may be returned 912 * as the result. 913 * 914 * @deprecated As of JDK 1.1, the preferred way to translate a 915 * Unicode character stream into a byte stream in the local encoding is via 916 * the {@code OutputStreamWriter}, {@code BufferedWriter}, and 917 * {@code PrintWriter} classes. 918 * This method is subject to removal in a future version of Java SE. 919 * 920 * @param out OutputStream to localize 921 * @return a localized output stream 922 * @see java.io.OutputStream 923 * @see java.io.BufferedWriter#BufferedWriter(java.io.Writer) 924 * @see java.io.OutputStreamWriter#OutputStreamWriter(java.io.OutputStream) 925 * @see java.io.PrintWriter#PrintWriter(java.io.OutputStream) 926 */ 927 @Deprecated(since="1.1", forRemoval=true) 928 public OutputStream getLocalizedOutputStream(OutputStream out) { 929 return out; 930 } 931 932 /** 933 * Returns the version of the Java Runtime Environment as a {@link Version}. 934 * 935 * @return the {@link Version} of the Java Runtime Environment 936 * 937 * @since 9 938 */ 939 public static Version version() { 940 if (version == null) { 941 version = new Version(VersionProps.versionNumbers(), 942 VersionProps.pre(), VersionProps.build(), 943 VersionProps.optional()); 944 } 945 return version; 946 } 947 948 /** 949 * A representation of a version string for an implementation of the 950 * Java SE Platform. A version string consists of a version number 951 * optionally followed by pre-release and build information. 952 * 953 * <h2><a id="verNum">Version numbers</a></h2> 954 * 955 * <p> A <em>version number</em>, {@code $VNUM}, is a non-empty sequence 956 * of elements separated by period characters (U+002E). An element is 957 * either zero, or an unsigned integer numeral without leading zeros. The 958 * final element in a version number must not be zero. The format is: 959 * </p> 960 * 961 * <blockquote><pre> 962 * [1-9][0-9]*((\.0)*\.[1-9][0-9]*)* 963 * </pre></blockquote> 964 * 965 * <p> The sequence may be of arbitrary length but the first three 966 * elements are assigned specific meanings, as follows:</p> 967 * 968 * <blockquote><pre> 969 * $MAJOR.$MINOR.$SECURITY 970 * </pre></blockquote> 971 * 972 * <ul> 973 * 974 * <li><p> <a id="major">{@code $MAJOR}</a> --- The major version 975 * number, incremented for a major release that contains significant new 976 * features as specified in a new edition of the Java SE Platform 977 * Specification, <em>e.g.</em>, <a 978 * href="https://jcp.org/en/jsr/detail?id=337">JSR 337</a> for 979 * Java SE 8. Features may be removed in a major release, given 980 * advance notice at least one major release ahead of time, and 981 * incompatible changes may be made when justified. The {@code $MAJOR} 982 * version number of JDK 8 is {@code 8}; the {@code $MAJOR} version 983 * number of JDK 9 is {@code 9}. When {@code $MAJOR} is incremented, 984 * all subsequent elements are removed. </p></li> 985 * 986 * <li><p> <a id="minor">{@code $MINOR}</a> --- The minor version 987 * number, incremented for a minor update release that may contain 988 * compatible bug fixes, revisions to standard APIs mandated by a 989 * <a href="https://jcp.org/en/procedures/jcp2#5.3">Maintenance Release</a> 990 * of the relevant Platform Specification, and implementation features 991 * outside the scope of that Specification such as new JDK-specific APIs, 992 * additional service providers, new garbage collectors, and ports to new 993 * hardware architectures. </p></li> 994 * 995 * <li><p> <a id="security">{@code $SECURITY}</a> --- The security 996 * level, incremented for a security update release that contains critical 997 * fixes including those necessary to improve security. {@code $SECURITY} 998 * is <strong>not</strong> reset when {@code $MINOR} is incremented. A 999 * higher value of {@code $SECURITY} for a given {@code $MAJOR} value, 1000 * therefore, always indicates a more secure release, regardless of the 1001 * value of {@code $MINOR}. </p></li> 1002 * 1003 * </ul> 1004 * 1005 * <p> The fourth and later elements of a version number are free for use 1006 * by downstream consumers of this code base. Such a consumer may, 1007 * <em>e.g.</em>, use the fourth element to identify patch releases which 1008 * contain a small number of critical non-security fixes in addition to 1009 * the security fixes in the corresponding security release. </p> 1010 * 1011 * <p> The version number does not include trailing zero elements; 1012 * <em>i.e.</em>, {@code $SECURITY} is omitted if it has the value zero, 1013 * and {@code $MINOR} is omitted if both {@code $MINOR} and {@code 1014 * $SECURITY} have the value zero. </p> 1015 * 1016 * <p> The sequence of numerals in a version number is compared to another 1017 * such sequence in numerical, pointwise fashion; <em>e.g.</em>, {@code 1018 * 9.9.1} is less than {@code 9.10.3}. If one sequence is shorter than 1019 * another then the missing elements of the shorter sequence are 1020 * considered to be less than the corresponding elements of the longer 1021 * sequence; <em>e.g.</em>, {@code 9.1.2} is less than {@code 9.1.2.1}. 1022 * </p> 1023 * 1024 * <h2><a id="verStr">Version strings</a></h2> 1025 * 1026 * <p> A <em>version string</em>, {@code $VSTR}, consists of a version 1027 * number {@code $VNUM}, as described above, optionally followed by 1028 * pre-release and build information, in one of the following formats: 1029 * </p> 1030 * 1031 * <blockquote><pre> 1032 * $VNUM(-$PRE)?\+$BUILD(-$OPT)? 1033 * $VNUM-$PRE(-$OPT)? 1034 * $VNUM(+-$OPT)? 1035 * </pre></blockquote> 1036 * 1037 * <p> where: </p> 1038 * 1039 * <ul> 1040 * 1041 * <li><p> <a id="pre">{@code $PRE}</a>, matching {@code ([a-zA-Z0-9]+)} 1042 * --- A pre-release identifier. Typically {@code ea}, for a 1043 * potentially unstable early-access release under active development, 1044 * or {@code internal}, for an internal developer build. </p></li> 1045 * 1046 * <li><p> <a id="build">{@code $BUILD}</a>, matching {@code 1047 * (0|[1-9][0-9]*)} --- The build number, incremented for each promoted 1048 * build. {@code $BUILD} is reset to {@code 1} when any portion of {@code 1049 * $VNUM} is incremented. </p></li> 1050 * 1051 * <li><p> <a id="opt">{@code $OPT}</a>, matching {@code 1052 * ([-a-zA-Z0-9.]+)} --- Additional build information, if desired. In 1053 * the case of an {@code internal} build this will often contain the date 1054 * and time of the build. </p></li> 1055 * 1056 * </ul> 1057 * 1058 * <p> A version string {@code 10-ea} matches {@code $VNUM = "10"} and 1059 * {@code $PRE = "ea"}. The version string {@code 10+-ea} matches 1060 * {@code $VNUM = "10"} and {@code $OPT = "ea"}. </p> 1061 * 1062 * <p> When comparing two version strings, the value of {@code $OPT}, if 1063 * present, may or may not be significant depending on the chosen 1064 * comparison method. The comparison methods {@link #compareTo(Version) 1065 * compareTo()} and {@link #compareToIgnoreOptional(Version) 1066 * compareToIgnoreOptional()} should be used consistently with the 1067 * corresponding methods {@link #equals(Object) equals()} and {@link 1068 * #equalsIgnoreOptional(Object) equalsIgnoreOptional()}. </p> 1069 * 1070 * <p> A <em>short version string</em>, {@code $SVSTR}, often useful in 1071 * less formal contexts, is a version number optionally followed by a 1072 * pre-release identifier:</p> 1073 * 1074 * <blockquote><pre> 1075 * $VNUM(-$PRE)? 1076 * </pre></blockquote> 1077 * 1078 * <p>This is a <a href="./doc-files/ValueBased.html">value-based</a> 1079 * class; use of identity-sensitive operations (including reference equality 1080 * ({@code ==}), identity hash code, or synchronization) on instances of 1081 * {@code Version} may have unpredictable results and should be avoided. 1082 * </p> 1083 * 1084 * @since 9 1085 */ 1086 public static final class Version 1087 implements Comparable<Version> 1088 { 1089 private final List<Integer> version; 1090 private final Optional<String> pre; 1091 private final Optional<Integer> build; 1092 private final Optional<String> optional; 1093 1094 /* 1095 * List of version number components passed to this constructor MUST 1096 * be at least unmodifiable (ideally immutable). In the case on an 1097 * unmodifiable list, the caller MUST hand the list over to this 1098 * constructor and never change the underlying list. 1099 */ 1100 private Version(List<Integer> unmodifiableListOfVersions, 1101 Optional<String> pre, 1102 Optional<Integer> build, 1103 Optional<String> optional) 1104 { 1105 this.version = unmodifiableListOfVersions; 1106 this.pre = pre; 1107 this.build = build; 1108 this.optional = optional; 1109 } 1110 1111 /** 1112 * Parses the given string as a valid 1113 * <a href="#verStr">version string</a> containing a 1114 * <a href="#verNum">version number</a> followed by pre-release and 1115 * build information. 1116 * 1117 * @param s 1118 * A string to interpret as a version 1119 * 1120 * @throws IllegalArgumentException 1121 * If the given string cannot be interpreted as a valid 1122 * version 1123 * 1124 * @throws NullPointerException 1125 * If the given string is {@code null} 1126 * 1127 * @throws NumberFormatException 1128 * If an element of the version number or the build number 1129 * cannot be represented as an {@link Integer} 1130 * 1131 * @return The Version of the given string 1132 */ 1133 public static Version parse(String s) { 1134 if (s == null) 1135 throw new NullPointerException(); 1136 1137 // Shortcut to avoid initializing VersionPattern when creating 1138 // major version constants during startup 1139 if (isSimpleNumber(s)) { 1140 return new Version(List.of(Integer.parseInt(s)), 1141 Optional.empty(), Optional.empty(), Optional.empty()); 1142 } 1143 Matcher m = VersionPattern.VSTR_PATTERN.matcher(s); 1144 if (!m.matches()) 1145 throw new IllegalArgumentException("Invalid version string: '" 1146 + s + "'"); 1147 1148 // $VNUM is a dot-separated list of integers of arbitrary length 1149 String[] split = m.group(VersionPattern.VNUM_GROUP).split("\\."); 1150 Integer[] version = new Integer[split.length]; 1151 for (int i = 0; i < split.length; i++) { 1152 version[i] = Integer.parseInt(split[i]); 1153 } 1154 1155 Optional<String> pre = Optional.ofNullable( 1156 m.group(VersionPattern.PRE_GROUP)); 1157 1158 String b = m.group(VersionPattern.BUILD_GROUP); 1159 // $BUILD is an integer 1160 Optional<Integer> build = (b == null) 1161 ? Optional.empty() 1162 : Optional.of(Integer.parseInt(b)); 1163 1164 Optional<String> optional = Optional.ofNullable( 1165 m.group(VersionPattern.OPT_GROUP)); 1166 1167 // empty '+' 1168 if ((m.group(VersionPattern.PLUS_GROUP) != null) 1169 && !build.isPresent()) { 1170 if (optional.isPresent()) { 1171 if (pre.isPresent()) 1172 throw new IllegalArgumentException("'+' found with" 1173 + " pre-release and optional components:'" + s 1174 + "'"); 1175 } else { 1176 throw new IllegalArgumentException("'+' found with neither" 1177 + " build or optional components: '" + s + "'"); 1178 } 1179 } 1180 return new Version(List.of(version), pre, build, optional); 1181 } 1182 1183 private static boolean isSimpleNumber(String s) { 1184 for (int i = 0; i < s.length(); i++) { 1185 char c = s.charAt(i); 1186 char lowerBound = (i > 0) ? '0' : '1'; 1187 if (c < lowerBound || c > '9') { 1188 return false; 1189 } 1190 } 1191 return true; 1192 } 1193 1194 /** 1195 * Returns the <a href="#major">major</a> version number. 1196 * 1197 * @return The major version number 1198 */ 1199 public int major() { 1200 return version.get(0); 1201 } 1202 1203 /** 1204 * Returns the <a href="#minor">minor</a> version number or zero if it 1205 * was not set. 1206 * 1207 * @return The minor version number or zero if it was not set 1208 */ 1209 public int minor() { 1210 return (version.size() > 1 ? version.get(1) : 0); 1211 } 1212 1213 /** 1214 * Returns the <a href="#security">security</a> version number or zero 1215 * if it was not set. 1216 * 1217 * @return The security version number or zero if it was not set 1218 */ 1219 public int security() { 1220 return (version.size() > 2 ? version.get(2) : 0); 1221 } 1222 1223 /** 1224 * Returns an unmodifiable {@link java.util.List List} of the 1225 * integer numerals contained in the <a href="#verNum">version 1226 * number</a>. The {@code List} always contains at least one 1227 * element corresponding to the <a href="#major">major version 1228 * number</a>. 1229 * 1230 * @return An unmodifiable list of the integer numerals 1231 * contained in the version number 1232 */ 1233 public List<Integer> version() { 1234 return version; 1235 } 1236 1237 /** 1238 * Returns the optional <a href="#pre">pre-release</a> information. 1239 * 1240 * @return The optional pre-release information as a String 1241 */ 1242 public Optional<String> pre() { 1243 return pre; 1244 } 1245 1246 /** 1247 * Returns the <a href="#build">build number</a>. 1248 * 1249 * @return The optional build number. 1250 */ 1251 public Optional<Integer> build() { 1252 return build; 1253 } 1254 1255 /** 1256 * Returns <a href="#opt">optional</a> additional identifying build 1257 * information. 1258 * 1259 * @return Additional build information as a String 1260 */ 1261 public Optional<String> optional() { 1262 return optional; 1263 } 1264 1265 /** 1266 * Compares this version to another. 1267 * 1268 * <p> Each of the components in the <a href="#verStr">version</a> is 1269 * compared in the following order of precedence: version numbers, 1270 * pre-release identifiers, build numbers, optional build information. 1271 * </p> 1272 * 1273 * <p> Comparison begins by examining the sequence of version numbers. 1274 * If one sequence is shorter than another, then the missing elements 1275 * of the shorter sequence are considered to be less than the 1276 * corresponding elements of the longer sequence. </p> 1277 * 1278 * <p> A version with a pre-release identifier is always considered to 1279 * be less than a version without one. Pre-release identifiers are 1280 * compared numerically when they consist only of digits, and 1281 * lexicographically otherwise. Numeric identifiers are considered to 1282 * be less than non-numeric identifiers. </p> 1283 * 1284 * <p> A version without a build number is always less than one with a 1285 * build number; otherwise build numbers are compared numerically. </p> 1286 * 1287 * <p> The optional build information is compared lexicographically. 1288 * During this comparison, a version with optional build information is 1289 * considered to be greater than a version without one. </p> 1290 * 1291 * @param obj 1292 * The object to be compared 1293 * 1294 * @return A negative integer, zero, or a positive integer if this 1295 * {@code Version} is less than, equal to, or greater than the 1296 * given {@code Version} 1297 * 1298 * @throws NullPointerException 1299 * If the given object is {@code null} 1300 */ 1301 @Override 1302 public int compareTo(Version obj) { 1303 return compare(obj, false); 1304 } 1305 1306 /** 1307 * Compares this version to another disregarding optional build 1308 * information. 1309 * 1310 * <p> Two versions are compared by examining the version string as 1311 * described in {@link #compareTo(Version)} with the exception that the 1312 * optional build information is always ignored. </p> 1313 * 1314 * <p> This method provides ordering which is consistent with 1315 * {@code equalsIgnoreOptional()}. </p> 1316 * 1317 * @param obj 1318 * The object to be compared 1319 * 1320 * @return A negative integer, zero, or a positive integer if this 1321 * {@code Version} is less than, equal to, or greater than the 1322 * given {@code Version} 1323 * 1324 * @throws NullPointerException 1325 * If the given object is {@code null} 1326 */ 1327 public int compareToIgnoreOptional(Version obj) { 1328 return compare(obj, true); 1329 } 1330 1331 private int compare(Version obj, boolean ignoreOpt) { 1332 if (obj == null) 1333 throw new NullPointerException(); 1334 1335 int ret = compareVersion(obj); 1336 if (ret != 0) 1337 return ret; 1338 1339 ret = comparePre(obj); 1340 if (ret != 0) 1341 return ret; 1342 1343 ret = compareBuild(obj); 1344 if (ret != 0) 1345 return ret; 1346 1347 if (!ignoreOpt) 1348 return compareOptional(obj); 1349 1350 return 0; 1351 } 1352 1353 private int compareVersion(Version obj) { 1354 int size = version.size(); 1355 int oSize = obj.version().size(); 1356 int min = Math.min(size, oSize); 1357 for (int i = 0; i < min; i++) { 1358 int val = version.get(i); 1359 int oVal = obj.version().get(i); 1360 if (val != oVal) 1361 return val - oVal; 1362 } 1363 return size - oSize; 1364 } 1365 1366 private int comparePre(Version obj) { 1367 Optional<String> oPre = obj.pre(); 1368 if (!pre.isPresent()) { 1369 if (oPre.isPresent()) 1370 return 1; 1371 } else { 1372 if (!oPre.isPresent()) 1373 return -1; 1374 String val = pre.get(); 1375 String oVal = oPre.get(); 1376 if (val.matches("\\d+")) { 1377 return (oVal.matches("\\d+") 1378 ? (new BigInteger(val)).compareTo(new BigInteger(oVal)) 1379 : -1); 1380 } else { 1381 return (oVal.matches("\\d+") 1382 ? 1 1383 : val.compareTo(oVal)); 1384 } 1385 } 1386 return 0; 1387 } 1388 1389 private int compareBuild(Version obj) { 1390 Optional<Integer> oBuild = obj.build(); 1391 if (oBuild.isPresent()) { 1392 return (build.isPresent() 1393 ? build.get().compareTo(oBuild.get()) 1394 : -1); 1395 } else if (build.isPresent()) { 1396 return 1; 1397 } 1398 return 0; 1399 } 1400 1401 private int compareOptional(Version obj) { 1402 Optional<String> oOpt = obj.optional(); 1403 if (!optional.isPresent()) { 1404 if (oOpt.isPresent()) 1405 return -1; 1406 } else { 1407 if (!oOpt.isPresent()) 1408 return 1; 1409 return optional.get().compareTo(oOpt.get()); 1410 } 1411 return 0; 1412 } 1413 1414 /** 1415 * Returns a string representation of this version. 1416 * 1417 * @return The version string 1418 */ 1419 @Override 1420 public String toString() { 1421 StringBuilder sb 1422 = new StringBuilder(version.stream() 1423 .map(Object::toString) 1424 .collect(Collectors.joining("."))); 1425 1426 pre.ifPresent(v -> sb.append("-").append(v)); 1427 1428 if (build.isPresent()) { 1429 sb.append("+").append(build.get()); 1430 if (optional.isPresent()) 1431 sb.append("-").append(optional.get()); 1432 } else { 1433 if (optional.isPresent()) { 1434 sb.append(pre.isPresent() ? "-" : "+-"); 1435 sb.append(optional.get()); 1436 } 1437 } 1438 1439 return sb.toString(); 1440 } 1441 1442 /** 1443 * Determines whether this {@code Version} is equal to another object. 1444 * 1445 * <p> Two {@code Version}s are equal if and only if they represent the 1446 * same version string. 1447 * 1448 * @param obj 1449 * The object to which this {@code Version} is to be compared 1450 * 1451 * @return {@code true} if, and only if, the given object is a {@code 1452 * Version} that is identical to this {@code Version} 1453 * 1454 */ 1455 @Override 1456 public boolean equals(Object obj) { 1457 boolean ret = equalsIgnoreOptional(obj); 1458 if (!ret) 1459 return false; 1460 1461 Version that = (Version)obj; 1462 return (this.optional().equals(that.optional())); 1463 } 1464 1465 /** 1466 * Determines whether this {@code Version} is equal to another 1467 * disregarding optional build information. 1468 * 1469 * <p> Two {@code Version}s are equal if and only if they represent the 1470 * same version string disregarding the optional build information. 1471 * 1472 * @param obj 1473 * The object to which this {@code Version} is to be compared 1474 * 1475 * @return {@code true} if, and only if, the given object is a {@code 1476 * Version} that is identical to this {@code Version} 1477 * ignoring the optional build information 1478 * 1479 */ 1480 public boolean equalsIgnoreOptional(Object obj) { 1481 if (this == obj) 1482 return true; 1483 if (!(obj instanceof Version)) 1484 return false; 1485 1486 Version that = (Version)obj; 1487 return (this.version().equals(that.version()) 1488 && this.pre().equals(that.pre()) 1489 && this.build().equals(that.build())); 1490 } 1491 1492 /** 1493 * Returns the hash code of this version. 1494 * 1495 * @return The hashcode of this version 1496 */ 1497 @Override 1498 public int hashCode() { 1499 int h = 1; 1500 int p = 17; 1501 1502 h = p * h + version.hashCode(); 1503 h = p * h + pre.hashCode(); 1504 h = p * h + build.hashCode(); 1505 h = p * h + optional.hashCode(); 1506 1507 return h; 1508 } 1509 } 1510 1511 private static class VersionPattern { 1512 // $VNUM(-$PRE)?(\+($BUILD)?(\-$OPT)?)? 1513 // RE limits the format of version strings 1514 // ([1-9][0-9]*(?:(?:\.0)*\.[1-9][0-9]*)*)(?:-([a-zA-Z0-9]+))?(?:(\+)(0|[1-9][0-9]*)?)?(?:-([-a-zA-Z0-9.]+))? 1515 1516 private static final String VNUM 1517 = "(?<VNUM>[1-9][0-9]*(?:(?:\\.0)*\\.[1-9][0-9]*)*)"; 1518 private static final String PRE = "(?:-(?<PRE>[a-zA-Z0-9]+))?"; 1519 private static final String BUILD 1520 = "(?:(?<PLUS>\\+)(?<BUILD>0|[1-9][0-9]*)?)?"; 1521 private static final String OPT = "(?:-(?<OPT>[-a-zA-Z0-9.]+))?"; 1522 private static final String VSTR_FORMAT = VNUM + PRE + BUILD + OPT; 1523 1524 static final Pattern VSTR_PATTERN = Pattern.compile(VSTR_FORMAT); 1525 1526 static final String VNUM_GROUP = "VNUM"; 1527 static final String PRE_GROUP = "PRE"; 1528 static final String PLUS_GROUP = "PLUS"; 1529 static final String BUILD_GROUP = "BUILD"; 1530 static final String OPT_GROUP = "OPT"; 1531 } 1532} 1533