src/java.base/share/classes/java/lang/System.java
author mchung
Tue, 22 Oct 2019 09:20:21 -0700
changeset 58739 2b0c5800fb1c
parent 58574 dcc760954243
permissions -rw-r--r--
8232617: Update the outdated code comments in java.lang.System class Reviewed-by: dholmes, bchristi
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
53160
7d1efad039a3 8216205: Java API documentation formatting error in System.getEnv
rriggs
parents: 52978
diff changeset
     2
 * Copyright (c) 1994, 2019, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4355
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4355
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4355
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4355
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4355
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
package java.lang;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
    27
import java.io.BufferedInputStream;
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
    28
import java.io.BufferedOutputStream;
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
    29
import java.io.Console;
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
    30
import java.io.FileDescriptor;
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
    31
import java.io.FileInputStream;
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
    32
import java.io.FileOutputStream;
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
    33
import java.io.IOException;
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
    34
import java.io.InputStream;
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
    35
import java.io.PrintStream;
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
    36
import java.io.UnsupportedEncodingException;
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
    37
import java.lang.annotation.Annotation;
44545
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
    38
import java.lang.module.ModuleDescriptor;
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
    39
import java.lang.reflect.Constructor;
15510
898d924a7efd 8004698: Implement Core Reflection for Type Annotations
jfranck
parents: 14676
diff changeset
    40
import java.lang.reflect.Executable;
42338
a60f280f803c 8169069: Module system implementation refresh (11/2016)
alanb
parents: 40261
diff changeset
    41
import java.lang.reflect.Method;
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
    42
import java.lang.reflect.Modifier;
44545
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
    43
import java.net.URI;
50820
35f52a3cd6bd 8205058: (fs) Files read/writeString should throw CharacterCodingException instead of IOException with an IllegalArgumentException as cause
joehw
parents: 50817
diff changeset
    44
import java.nio.charset.CharacterCodingException;
20805
ae41216325dd 8013739: Better LDAP resource management
weijun
parents: 18546
diff changeset
    45
import java.security.AccessControlContext;
44359
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
    46
import java.security.ProtectionDomain;
34370
70d1245398ed 8143931: Back out JDK-8140450
ctornqvi
parents: 34362
diff changeset
    47
import java.security.AccessController;
70d1245398ed 8143931: Back out JDK-8140450
ctornqvi
parents: 34362
diff changeset
    48
import java.security.PrivilegedAction;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
import java.nio.channels.Channel;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
import java.nio.channels.spi.SelectorProvider;
50552
7439ceaae8e4 8201276: (fs) Add methods to Files for reading/writing a string from/to a file
joehw
parents: 50531
diff changeset
    51
import java.nio.charset.Charset;
45652
33342314ce89 8181087: Module system implementation refresh (6/2017)
alanb
parents: 45124
diff changeset
    52
import java.util.Iterator;
33342314ce89 8181087: Module system implementation refresh (6/2017)
alanb
parents: 45124
diff changeset
    53
import java.util.List;
44545
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
    54
import java.util.Map;
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
    55
import java.util.Objects;
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
    56
import java.util.Properties;
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
    57
import java.util.PropertyPermission;
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
    58
import java.util.ResourceBundle;
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
    59
import java.util.function.Supplier;
36972
27147cde3256 8152115: (proxy) Examine performance of dynamic proxy creation
plevart
parents: 36511
diff changeset
    60
import java.util.concurrent.ConcurrentHashMap;
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
    61
import java.util.stream.Stream;
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
    62
50817
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
    63
import jdk.internal.util.StaticProperty;
44545
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
    64
import jdk.internal.module.ModuleBootstrap;
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
    65
import jdk.internal.module.ServicesCatalog;
37363
329dba26ffd2 8137058: Clear out all non-Critical APIs from sun.reflect
chegar
parents: 36972
diff changeset
    66
import jdk.internal.reflect.CallerSensitive;
329dba26ffd2 8137058: Clear out all non-Critical APIs from sun.reflect
chegar
parents: 36972
diff changeset
    67
import jdk.internal.reflect.Reflection;
31671
362e0c0acece 8076112: Add @HotSpotIntrinsicCandidate annotation to indicate methods for which Java Runtime has intrinsics
zmajo
parents: 29986
diff changeset
    68
import jdk.internal.HotSpotIntrinsicCandidate;
52427
3c6aa484536c 8211122: Reduce the number of internal classes made accessible to jdk.unsupported
mchung
parents: 52084
diff changeset
    69
import jdk.internal.access.JavaLangAccess;
3c6aa484536c 8211122: Reduce the number of internal classes made accessible to jdk.unsupported
mchung
parents: 52084
diff changeset
    70
import jdk.internal.access.SharedSecrets;
34882
ce2a8ec851c1 8145544: Move sun.misc.VM to jdk.internal.misc
chegar
parents: 34774
diff changeset
    71
import jdk.internal.misc.VM;
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
    72
import jdk.internal.logger.LoggerFinderLoader;
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
    73
import jdk.internal.logger.LazyLoggers;
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
    74
import jdk.internal.logger.LocalizedLoggerWrapper;
52724
0bdbf854472f 4947890: Minimize JNI upcalls in system-properties initialization
rriggs
parents: 52615
diff changeset
    75
import jdk.internal.util.SystemProps;
52084
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
    76
import jdk.internal.vm.annotation.Stable;
57792
1b6806340400 8229773: Resolve permissions for code source URLs lazily
redestad
parents: 55693
diff changeset
    77
import sun.nio.fs.DefaultFileSystemProvider;
44545
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
    78
import sun.reflect.annotation.AnnotationType;
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
    79
import sun.nio.ch.Interruptible;
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
    80
import sun.security.util.SecurityConstants;
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
    81
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
/**
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
    83
 * The {@code System} class contains several useful class fields
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
 * and methods. It cannot be instantiated.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
 *
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
    86
 * Among the facilities provided by the {@code System} class
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
 * are standard input, standard output, and error output streams;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
 * access to externally defined properties and environment
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
 * variables; a means of loading files and libraries; and a utility
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
 * method for quickly copying a portion of an array.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
 *
24865
09b1d992ca72 8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents: 24367
diff changeset
    92
 * @since   1.0
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
public final class System {
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
    95
    /* Register the natives via the static initializer.
6882
637546039be3 6977738: Deadlock between java.lang.ClassLoader and java.util.Properties
mchung
parents: 6668
diff changeset
    96
     *
58739
2b0c5800fb1c 8232617: Update the outdated code comments in java.lang.System class
mchung
parents: 58574
diff changeset
    97
     * The VM will invoke the initPhase1 method to complete the initialization
2b0c5800fb1c 8232617: Update the outdated code comments in java.lang.System class
mchung
parents: 58574
diff changeset
    98
     * of this class separate from <clinit>.
6882
637546039be3 6977738: Deadlock between java.lang.ClassLoader and java.util.Properties
mchung
parents: 6668
diff changeset
    99
     */
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
    private static native void registerNatives();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
    static {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
        registerNatives();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
    /** Don't let anyone instantiate this class */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
    private System() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
     * The "standard" input stream. This stream is already
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
     * open and ready to supply input data. Typically this stream
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
     * corresponds to keyboard input or another input source specified by
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
     * the host environment or user.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
     */
32649
2ee9017c7597 8136583: Core libraries should use blessed modifier order
martin
parents: 32033
diff changeset
   115
    public static final InputStream in = null;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
     * The "standard" output stream. This stream is already
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
     * open and ready to accept output data. Typically this stream
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
     * corresponds to display output or another output destination
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
     * specified by the host environment or user.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
     * For simple stand-alone Java applications, a typical way to write
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
     * a line of output data is:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
     * <blockquote><pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
     *     System.out.println(data)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127
     * </pre></blockquote>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
     * <p>
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   129
     * See the {@code println} methods in class {@code PrintStream}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   130
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   131
     * @see     java.io.PrintStream#println()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   132
     * @see     java.io.PrintStream#println(boolean)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   133
     * @see     java.io.PrintStream#println(char)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   134
     * @see     java.io.PrintStream#println(char[])
90ce3da70b43 Initial load
duke
parents:
diff changeset
   135
     * @see     java.io.PrintStream#println(double)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   136
     * @see     java.io.PrintStream#println(float)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   137
     * @see     java.io.PrintStream#println(int)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   138
     * @see     java.io.PrintStream#println(long)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   139
     * @see     java.io.PrintStream#println(java.lang.Object)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   140
     * @see     java.io.PrintStream#println(java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   141
     */
32649
2ee9017c7597 8136583: Core libraries should use blessed modifier order
martin
parents: 32033
diff changeset
   142
    public static final PrintStream out = null;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   143
90ce3da70b43 Initial load
duke
parents:
diff changeset
   144
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   145
     * The "standard" error output stream. This stream is already
90ce3da70b43 Initial load
duke
parents:
diff changeset
   146
     * open and ready to accept output data.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   147
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   148
     * Typically this stream corresponds to display output or another
90ce3da70b43 Initial load
duke
parents:
diff changeset
   149
     * output destination specified by the host environment or user. By
90ce3da70b43 Initial load
duke
parents:
diff changeset
   150
     * convention, this output stream is used to display error messages
90ce3da70b43 Initial load
duke
parents:
diff changeset
   151
     * or other information that should come to the immediate attention
90ce3da70b43 Initial load
duke
parents:
diff changeset
   152
     * of a user even if the principal output stream, the value of the
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   153
     * variable {@code out}, has been redirected to a file or other
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   154
     * destination that is typically not continuously monitored.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   155
     */
32649
2ee9017c7597 8136583: Core libraries should use blessed modifier order
martin
parents: 32033
diff changeset
   156
    public static final PrintStream err = null;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   157
52084
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   158
    // indicates if a security manager is possible
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   159
    private static final int NEVER = 1;
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   160
    private static final int MAYBE = 2;
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   161
    private static @Stable int allowSecurityManager;
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   162
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   163
    // current security manager
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   164
    private static volatile SecurityManager security;   // read by VM
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   165
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   166
    // return true if a security manager is allowed
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   167
    private static boolean allowSecurityManager() {
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   168
        return (allowSecurityManager != NEVER);
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   169
    }
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   170
90ce3da70b43 Initial load
duke
parents:
diff changeset
   171
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   172
     * Reassigns the "standard" input stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   173
     *
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   174
     * First, if there is a security manager, its {@code checkPermission}
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   175
     * method is called with a {@code RuntimePermission("setIO")} permission
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   176
     *  to see if it's ok to reassign the "standard" input stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   177
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   178
     * @param in the new standard input stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   179
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   180
     * @throws SecurityException
90ce3da70b43 Initial load
duke
parents:
diff changeset
   181
     *        if a security manager exists and its
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   182
     *        {@code checkPermission} method doesn't allow
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   183
     *        reassigning of the standard input stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   184
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   185
     * @see SecurityManager#checkPermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   186
     * @see java.lang.RuntimePermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   187
     *
24865
09b1d992ca72 8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents: 24367
diff changeset
   188
     * @since   1.1
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   189
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   190
    public static void setIn(InputStream in) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   191
        checkIO();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   192
        setIn0(in);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   193
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   194
90ce3da70b43 Initial load
duke
parents:
diff changeset
   195
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   196
     * Reassigns the "standard" output stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   197
     *
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   198
     * First, if there is a security manager, its {@code checkPermission}
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   199
     * method is called with a {@code RuntimePermission("setIO")} permission
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   200
     *  to see if it's ok to reassign the "standard" output stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   201
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   202
     * @param out the new standard output stream
90ce3da70b43 Initial load
duke
parents:
diff changeset
   203
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   204
     * @throws SecurityException
90ce3da70b43 Initial load
duke
parents:
diff changeset
   205
     *        if a security manager exists and its
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   206
     *        {@code checkPermission} method doesn't allow
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   207
     *        reassigning of the standard output stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   208
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   209
     * @see SecurityManager#checkPermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   210
     * @see java.lang.RuntimePermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   211
     *
24865
09b1d992ca72 8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents: 24367
diff changeset
   212
     * @since   1.1
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   213
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   214
    public static void setOut(PrintStream out) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   215
        checkIO();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   216
        setOut0(out);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   217
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   218
90ce3da70b43 Initial load
duke
parents:
diff changeset
   219
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   220
     * Reassigns the "standard" error output stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   221
     *
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   222
     * First, if there is a security manager, its {@code checkPermission}
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   223
     * method is called with a {@code RuntimePermission("setIO")} permission
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   224
     *  to see if it's ok to reassign the "standard" error output stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   225
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   226
     * @param err the new standard error output stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   227
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   228
     * @throws SecurityException
90ce3da70b43 Initial load
duke
parents:
diff changeset
   229
     *        if a security manager exists and its
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   230
     *        {@code checkPermission} method doesn't allow
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   231
     *        reassigning of the standard error output stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   232
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   233
     * @see SecurityManager#checkPermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   234
     * @see java.lang.RuntimePermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   235
     *
24865
09b1d992ca72 8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents: 24367
diff changeset
   236
     * @since   1.1
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   237
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   238
    public static void setErr(PrintStream err) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   239
        checkIO();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   240
        setErr0(err);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   241
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   242
34774
03b4e6dc367b 8145680: Remove unnecessary explicit initialization of volatile variables in java.base
redestad
parents: 34372
diff changeset
   243
    private static volatile Console cons;
52084
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   244
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   245
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   246
     * Returns the unique {@link java.io.Console Console} object associated
90ce3da70b43 Initial load
duke
parents:
diff changeset
   247
     * with the current Java virtual machine, if any.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   248
     *
32033
bf24e33c7919 8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents: 31671
diff changeset
   249
     * @return  The system console, if any, otherwise {@code null}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   250
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   251
     * @since   1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   252
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   253
     public static Console console() {
39826
5dba95a26226 8162563: Fix double checked locking in System.console()
martin
parents: 38861
diff changeset
   254
         Console c;
5dba95a26226 8162563: Fix double checked locking in System.console()
martin
parents: 38861
diff changeset
   255
         if ((c = cons) == null) {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   256
             synchronized (System.class) {
39826
5dba95a26226 8162563: Fix double checked locking in System.console()
martin
parents: 38861
diff changeset
   257
                 if ((c = cons) == null) {
5dba95a26226 8162563: Fix double checked locking in System.console()
martin
parents: 38861
diff changeset
   258
                     cons = c = SharedSecrets.getJavaIOAccess().console();
5dba95a26226 8162563: Fix double checked locking in System.console()
martin
parents: 38861
diff changeset
   259
                 }
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   260
             }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   261
         }
34774
03b4e6dc367b 8145680: Remove unnecessary explicit initialization of volatile variables in java.base
redestad
parents: 34372
diff changeset
   262
         return c;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   263
     }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   264
90ce3da70b43 Initial load
duke
parents:
diff changeset
   265
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   266
     * Returns the channel inherited from the entity that created this
90ce3da70b43 Initial load
duke
parents:
diff changeset
   267
     * Java virtual machine.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   268
     *
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   269
     * This method returns the channel obtained by invoking the
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   270
     * {@link java.nio.channels.spi.SelectorProvider#inheritedChannel
90ce3da70b43 Initial load
duke
parents:
diff changeset
   271
     * inheritedChannel} method of the system-wide default
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   272
     * {@link java.nio.channels.spi.SelectorProvider} object.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   273
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   274
     * <p> In addition to the network-oriented channels described in
90ce3da70b43 Initial load
duke
parents:
diff changeset
   275
     * {@link java.nio.channels.spi.SelectorProvider#inheritedChannel
90ce3da70b43 Initial load
duke
parents:
diff changeset
   276
     * inheritedChannel}, this method may return other kinds of
90ce3da70b43 Initial load
duke
parents:
diff changeset
   277
     * channels in the future.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   278
     *
32033
bf24e33c7919 8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents: 31671
diff changeset
   279
     * @return  The inherited channel, if any, otherwise {@code null}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   280
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   281
     * @throws  IOException
90ce3da70b43 Initial load
duke
parents:
diff changeset
   282
     *          If an I/O error occurs
90ce3da70b43 Initial load
duke
parents:
diff changeset
   283
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   284
     * @throws  SecurityException
90ce3da70b43 Initial load
duke
parents:
diff changeset
   285
     *          If a security manager is present and it does not
90ce3da70b43 Initial load
duke
parents:
diff changeset
   286
     *          permit access to the channel.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   287
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   288
     * @since 1.5
90ce3da70b43 Initial load
duke
parents:
diff changeset
   289
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   290
    public static Channel inheritedChannel() throws IOException {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   291
        return SelectorProvider.provider().inheritedChannel();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   292
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   293
90ce3da70b43 Initial load
duke
parents:
diff changeset
   294
    private static void checkIO() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   295
        SecurityManager sm = getSecurityManager();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   296
        if (sm != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   297
            sm.checkPermission(new RuntimePermission("setIO"));
90ce3da70b43 Initial load
duke
parents:
diff changeset
   298
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   299
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   300
90ce3da70b43 Initial load
duke
parents:
diff changeset
   301
    private static native void setIn0(InputStream in);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   302
    private static native void setOut0(PrintStream out);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   303
    private static native void setErr0(PrintStream err);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   304
90ce3da70b43 Initial load
duke
parents:
diff changeset
   305
    /**
52084
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   306
     * Sets the system-wide security manager.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   307
     *
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   308
     * If there is a security manager already installed, this method first
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   309
     * calls the security manager's {@code checkPermission} method
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   310
     * with a {@code RuntimePermission("setSecurityManager")}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   311
     * permission to ensure it's ok to replace the existing
90ce3da70b43 Initial load
duke
parents:
diff changeset
   312
     * security manager.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   313
     * This may result in throwing a {@code SecurityException}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   314
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   315
     * <p> Otherwise, the argument is established as the current
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   316
     * security manager. If the argument is {@code null} and no
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   317
     * security manager has been established, then no action is taken and
90ce3da70b43 Initial load
duke
parents:
diff changeset
   318
     * the method simply returns.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   319
     *
52084
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   320
     * @implNote In the JDK implementation, if the Java virtual machine is
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   321
     * started with the system property {@code java.security.manager} set to
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   322
     * the special token "{@code disallow}" then the {@code setSecurityManager}
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   323
     * method cannot be used to set a security manager.
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   324
     *
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   325
     * @param  sm the security manager or {@code null}
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   326
     * @throws SecurityException
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   327
     *         if the security manager has already been set and its {@code
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   328
     *         checkPermission} method doesn't allow it to be replaced
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   329
     * @throws UnsupportedOperationException
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   330
     *         if {@code sm} is non-null and a security manager is not allowed
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   331
     *         to be set dynamically
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   332
     * @see #getSecurityManager
90ce3da70b43 Initial load
duke
parents:
diff changeset
   333
     * @see SecurityManager#checkPermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   334
     * @see java.lang.RuntimePermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   335
     */
52084
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   336
    public static void setSecurityManager(SecurityManager sm) {
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   337
        if (allowSecurityManager()) {
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   338
            if (security == null) {
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   339
                // ensure image reader is initialized
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   340
                Object.class.getResource("java/lang/ANY");
57792
1b6806340400 8229773: Resolve permissions for code source URLs lazily
redestad
parents: 55693
diff changeset
   341
                // ensure the default file system is initialized
1b6806340400 8229773: Resolve permissions for code source URLs lazily
redestad
parents: 55693
diff changeset
   342
                DefaultFileSystemProvider.theFileSystem();
52084
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   343
            }
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   344
            if (sm != null) {
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   345
                try {
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   346
                    // pre-populates the SecurityManager.packageAccess cache
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   347
                    // to avoid recursive permission checking issues with custom
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   348
                    // SecurityManager implementations
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   349
                    sm.checkPackageAccess("java.lang");
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   350
                } catch (Exception e) {
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   351
                    // no-op
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   352
                }
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   353
            }
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   354
            setSecurityManager0(sm);
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   355
        } else {
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   356
            // security manager not allowed
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   357
            if (sm != null) {
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   358
                throw new UnsupportedOperationException(
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   359
                    "Runtime configured to disallow security manager");
43221
eef9383d25cb 8055206: Update SecurityManager::checkPackageAccess to restrict non-exported JDK packages by default
mullan
parents: 42338
diff changeset
   360
            }
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   361
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   362
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   363
90ce3da70b43 Initial load
duke
parents:
diff changeset
   364
    private static synchronized
90ce3da70b43 Initial load
duke
parents:
diff changeset
   365
    void setSecurityManager0(final SecurityManager s) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   366
        SecurityManager sm = getSecurityManager();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   367
        if (sm != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   368
            // ask the currently installed security manager if we
90ce3da70b43 Initial load
duke
parents:
diff changeset
   369
            // can replace it.
52084
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   370
            sm.checkPermission(new RuntimePermission("setSecurityManager"));
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   371
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   372
90ce3da70b43 Initial load
duke
parents:
diff changeset
   373
        if ((s != null) && (s.getClass().getClassLoader() != null)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   374
            // New security manager class is not on bootstrap classpath.
52084
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   375
            // Force policy to get initialized before we install the new
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   376
            // security manager, in order to prevent infinite loops when
90ce3da70b43 Initial load
duke
parents:
diff changeset
   377
            // trying to initialize the policy (which usually involves
90ce3da70b43 Initial load
duke
parents:
diff changeset
   378
            // accessing some security and/or system properties, which in turn
90ce3da70b43 Initial load
duke
parents:
diff changeset
   379
            // calls the installed security manager's checkPermission method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   380
            // which will loop infinitely if there is a non-system class
90ce3da70b43 Initial load
duke
parents:
diff changeset
   381
            // (in this case: the new security manager class) on the stack).
29986
97167d851fc4 8078467: Update core libraries to use diamond with anonymous classes
darcy
parents: 28668
diff changeset
   382
            AccessController.doPrivileged(new PrivilegedAction<>() {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   383
                public Object run() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   384
                    s.getClass().getProtectionDomain().implies
90ce3da70b43 Initial load
duke
parents:
diff changeset
   385
                        (SecurityConstants.ALL_PERMISSION);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   386
                    return null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   387
                }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   388
            });
90ce3da70b43 Initial load
duke
parents:
diff changeset
   389
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   390
90ce3da70b43 Initial load
duke
parents:
diff changeset
   391
        security = s;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   392
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   393
90ce3da70b43 Initial load
duke
parents:
diff changeset
   394
    /**
52084
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   395
     * Gets the system-wide security manager.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   396
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   397
     * @return  if a security manager has already been established for the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   398
     *          current application, then that security manager is returned;
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   399
     *          otherwise, {@code null} is returned.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   400
     * @see     #setSecurityManager
90ce3da70b43 Initial load
duke
parents:
diff changeset
   401
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   402
    public static SecurityManager getSecurityManager() {
52084
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   403
        if (allowSecurityManager()) {
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   404
            return security;
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   405
        } else {
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   406
            return null;
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
   407
        }
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   408
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   409
90ce3da70b43 Initial load
duke
parents:
diff changeset
   410
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   411
     * Returns the current time in milliseconds.  Note that
90ce3da70b43 Initial load
duke
parents:
diff changeset
   412
     * while the unit of time of the return value is a millisecond,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   413
     * the granularity of the value depends on the underlying
90ce3da70b43 Initial load
duke
parents:
diff changeset
   414
     * operating system and may be larger.  For example, many
90ce3da70b43 Initial load
duke
parents:
diff changeset
   415
     * operating systems measure time in units of tens of
90ce3da70b43 Initial load
duke
parents:
diff changeset
   416
     * milliseconds.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   417
     *
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   418
     * <p> See the description of the class {@code Date} for
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   419
     * a discussion of slight discrepancies that may arise between
90ce3da70b43 Initial load
duke
parents:
diff changeset
   420
     * "computer time" and coordinated universal time (UTC).
90ce3da70b43 Initial load
duke
parents:
diff changeset
   421
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   422
     * @return  the difference, measured in milliseconds, between
90ce3da70b43 Initial load
duke
parents:
diff changeset
   423
     *          the current time and midnight, January 1, 1970 UTC.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   424
     * @see     java.util.Date
90ce3da70b43 Initial load
duke
parents:
diff changeset
   425
     */
31671
362e0c0acece 8076112: Add @HotSpotIntrinsicCandidate annotation to indicate methods for which Java Runtime has intrinsics
zmajo
parents: 29986
diff changeset
   426
    @HotSpotIntrinsicCandidate
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   427
    public static native long currentTimeMillis();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   428
90ce3da70b43 Initial load
duke
parents:
diff changeset
   429
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   430
     * Returns the current value of the running Java Virtual Machine's
90ce3da70b43 Initial load
duke
parents:
diff changeset
   431
     * high-resolution time source, in nanoseconds.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   432
     *
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   433
     * This method can only be used to measure elapsed time and is
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   434
     * not related to any other notion of system or wall-clock time.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   435
     * The value returned represents nanoseconds since some fixed but
90ce3da70b43 Initial load
duke
parents:
diff changeset
   436
     * arbitrary <i>origin</i> time (perhaps in the future, so values
90ce3da70b43 Initial load
duke
parents:
diff changeset
   437
     * may be negative).  The same origin is used by all invocations of
90ce3da70b43 Initial load
duke
parents:
diff changeset
   438
     * this method in an instance of a Java virtual machine; other
90ce3da70b43 Initial load
duke
parents:
diff changeset
   439
     * virtual machine instances are likely to use a different origin.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   440
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   441
     * <p>This method provides nanosecond precision, but not necessarily
90ce3da70b43 Initial load
duke
parents:
diff changeset
   442
     * nanosecond resolution (that is, how frequently the value changes)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   443
     * - no guarantees are made except that the resolution is at least as
90ce3da70b43 Initial load
duke
parents:
diff changeset
   444
     * good as that of {@link #currentTimeMillis()}.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   445
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   446
     * <p>Differences in successive calls that span greater than
90ce3da70b43 Initial load
duke
parents:
diff changeset
   447
     * approximately 292 years (2<sup>63</sup> nanoseconds) will not
90ce3da70b43 Initial load
duke
parents:
diff changeset
   448
     * correctly compute elapsed time due to numerical overflow.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   449
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   450
     * <p>The values returned by this method become meaningful only when
90ce3da70b43 Initial load
duke
parents:
diff changeset
   451
     * the difference between two such values, obtained within the same
90ce3da70b43 Initial load
duke
parents:
diff changeset
   452
     * instance of a Java virtual machine, is computed.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   453
     *
28668
a5b9168af1bb 8069269: (spec) Defect in the System.nanoTime spec
bpb
parents: 27565
diff changeset
   454
     * <p>For example, to measure how long some code takes to execute:
a5b9168af1bb 8069269: (spec) Defect in the System.nanoTime spec
bpb
parents: 27565
diff changeset
   455
     * <pre> {@code
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   456
     * long startTime = System.nanoTime();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   457
     * // ... the code being measured ...
28668
a5b9168af1bb 8069269: (spec) Defect in the System.nanoTime spec
bpb
parents: 27565
diff changeset
   458
     * long elapsedNanos = System.nanoTime() - startTime;}</pre>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   459
     *
28668
a5b9168af1bb 8069269: (spec) Defect in the System.nanoTime spec
bpb
parents: 27565
diff changeset
   460
     * <p>To compare elapsed time against a timeout, use <pre> {@code
a5b9168af1bb 8069269: (spec) Defect in the System.nanoTime spec
bpb
parents: 27565
diff changeset
   461
     * if (System.nanoTime() - startTime >= timeoutNanos) ...}</pre>
a5b9168af1bb 8069269: (spec) Defect in the System.nanoTime spec
bpb
parents: 27565
diff changeset
   462
     * instead of <pre> {@code
a5b9168af1bb 8069269: (spec) Defect in the System.nanoTime spec
bpb
parents: 27565
diff changeset
   463
     * if (System.nanoTime() >= startTime + timeoutNanos) ...}</pre>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   464
     * because of the possibility of numerical overflow.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   465
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   466
     * @return the current value of the running Java Virtual Machine's
90ce3da70b43 Initial load
duke
parents:
diff changeset
   467
     *         high-resolution time source, in nanoseconds
90ce3da70b43 Initial load
duke
parents:
diff changeset
   468
     * @since 1.5
90ce3da70b43 Initial load
duke
parents:
diff changeset
   469
     */
31671
362e0c0acece 8076112: Add @HotSpotIntrinsicCandidate annotation to indicate methods for which Java Runtime has intrinsics
zmajo
parents: 29986
diff changeset
   470
    @HotSpotIntrinsicCandidate
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   471
    public static native long nanoTime();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   472
90ce3da70b43 Initial load
duke
parents:
diff changeset
   473
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   474
     * Copies an array from the specified source array, beginning at the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   475
     * specified position, to the specified position of the destination array.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   476
     * A subsequence of array components are copied from the source
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   477
     * array referenced by {@code src} to the destination array
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   478
     * referenced by {@code dest}. The number of components copied is
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   479
     * equal to the {@code length} argument. The components at
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   480
     * positions {@code srcPos} through
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   481
     * {@code srcPos+length-1} in the source array are copied into
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   482
     * positions {@code destPos} through
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   483
     * {@code destPos+length-1}, respectively, of the destination
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   484
     * array.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   485
     * <p>
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   486
     * If the {@code src} and {@code dest} arguments refer to the
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   487
     * same array object, then the copying is performed as if the
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   488
     * components at positions {@code srcPos} through
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   489
     * {@code srcPos+length-1} were first copied to a temporary
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   490
     * array with {@code length} components and then the contents of
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   491
     * the temporary array were copied into positions
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   492
     * {@code destPos} through {@code destPos+length-1} of the
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   493
     * destination array.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   494
     * <p>
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   495
     * If {@code dest} is {@code null}, then a
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   496
     * {@code NullPointerException} is thrown.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   497
     * <p>
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   498
     * If {@code src} is {@code null}, then a
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   499
     * {@code NullPointerException} is thrown and the destination
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   500
     * array is not modified.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   501
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   502
     * Otherwise, if any of the following is true, an
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   503
     * {@code ArrayStoreException} is thrown and the destination is
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   504
     * not modified:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   505
     * <ul>
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   506
     * <li>The {@code src} argument refers to an object that is not an
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   507
     *     array.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   508
     * <li>The {@code dest} argument refers to an object that is not an
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   509
     *     array.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   510
     * <li>The {@code src} argument and {@code dest} argument refer
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   511
     *     to arrays whose component types are different primitive types.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   512
     * <li>The {@code src} argument refers to an array with a primitive
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   513
     *    component type and the {@code dest} argument refers to an array
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   514
     *     with a reference component type.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   515
     * <li>The {@code src} argument refers to an array with a reference
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   516
     *    component type and the {@code dest} argument refers to an array
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   517
     *     with a primitive component type.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   518
     * </ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   519
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   520
     * Otherwise, if any of the following is true, an
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   521
     * {@code IndexOutOfBoundsException} is
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   522
     * thrown and the destination is not modified:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   523
     * <ul>
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   524
     * <li>The {@code srcPos} argument is negative.
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   525
     * <li>The {@code destPos} argument is negative.
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   526
     * <li>The {@code length} argument is negative.
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   527
     * <li>{@code srcPos+length} is greater than
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   528
     *     {@code src.length}, the length of the source array.
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   529
     * <li>{@code destPos+length} is greater than
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   530
     *     {@code dest.length}, the length of the destination array.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   531
     * </ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   532
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   533
     * Otherwise, if any actual component of the source array from
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   534
     * position {@code srcPos} through
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   535
     * {@code srcPos+length-1} cannot be converted to the component
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   536
     * type of the destination array by assignment conversion, an
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   537
     * {@code ArrayStoreException} is thrown. In this case, let
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   538
     * <b><i>k</i></b> be the smallest nonnegative integer less than
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   539
     * length such that {@code src[srcPos+}<i>k</i>{@code ]}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   540
     * cannot be converted to the component type of the destination
90ce3da70b43 Initial load
duke
parents:
diff changeset
   541
     * array; when the exception is thrown, source array components from
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   542
     * positions {@code srcPos} through
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   543
     * {@code srcPos+}<i>k</i>{@code -1}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   544
     * will already have been copied to destination array positions
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   545
     * {@code destPos} through
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   546
     * {@code destPos+}<i>k</I>{@code -1} and no other
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   547
     * positions of the destination array will have been modified.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   548
     * (Because of the restrictions already itemized, this
90ce3da70b43 Initial load
duke
parents:
diff changeset
   549
     * paragraph effectively applies only to the situation where both
90ce3da70b43 Initial load
duke
parents:
diff changeset
   550
     * arrays have component types that are reference types.)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   551
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   552
     * @param      src      the source array.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   553
     * @param      srcPos   starting position in the source array.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   554
     * @param      dest     the destination array.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   555
     * @param      destPos  starting position in the destination data.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   556
     * @param      length   the number of array elements to be copied.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   557
     * @throws     IndexOutOfBoundsException  if copying would cause
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   558
     *             access of data outside array bounds.
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   559
     * @throws     ArrayStoreException  if an element in the {@code src}
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   560
     *             array could not be stored into the {@code dest} array
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   561
     *             because of a type mismatch.
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   562
     * @throws     NullPointerException if either {@code src} or
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   563
     *             {@code dest} is {@code null}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   564
     */
31671
362e0c0acece 8076112: Add @HotSpotIntrinsicCandidate annotation to indicate methods for which Java Runtime has intrinsics
zmajo
parents: 29986
diff changeset
   565
    @HotSpotIntrinsicCandidate
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   566
    public static native void arraycopy(Object src,  int  srcPos,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   567
                                        Object dest, int destPos,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   568
                                        int length);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   569
90ce3da70b43 Initial load
duke
parents:
diff changeset
   570
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   571
     * Returns the same hash code for the given object as
90ce3da70b43 Initial load
duke
parents:
diff changeset
   572
     * would be returned by the default method hashCode(),
90ce3da70b43 Initial load
duke
parents:
diff changeset
   573
     * whether or not the given object's class overrides
90ce3da70b43 Initial load
duke
parents:
diff changeset
   574
     * hashCode().
90ce3da70b43 Initial load
duke
parents:
diff changeset
   575
     * The hash code for the null reference is zero.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   576
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   577
     * @param x object for which the hashCode is to be calculated
90ce3da70b43 Initial load
duke
parents:
diff changeset
   578
     * @return  the hashCode
24865
09b1d992ca72 8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents: 24367
diff changeset
   579
     * @since   1.1
43891
59f9fbf2b7f0 8172928: Add doc link from System.identityHashCode to Object.hashCode
darcy
parents: 43221
diff changeset
   580
     * @see Object#hashCode
59f9fbf2b7f0 8172928: Add doc link from System.identityHashCode to Object.hashCode
darcy
parents: 43221
diff changeset
   581
     * @see java.util.Objects#hashCode(Object)
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   582
     */
31671
362e0c0acece 8076112: Add @HotSpotIntrinsicCandidate annotation to indicate methods for which Java Runtime has intrinsics
zmajo
parents: 29986
diff changeset
   583
    @HotSpotIntrinsicCandidate
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   584
    public static native int identityHashCode(Object x);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   585
90ce3da70b43 Initial load
duke
parents:
diff changeset
   586
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   587
     * System properties. The following properties are guaranteed to be defined:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   588
     * <dl>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   589
     * <dt>java.version         <dd>Java version number
48327
d2a837cf9ff1 8192833: JEP 322: Time-Based Release Versioning
mr
parents: 48262
diff changeset
   590
     * <dt>java.version.date    <dd>Java version date
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   591
     * <dt>java.vendor          <dd>Java vendor specific string
90ce3da70b43 Initial load
duke
parents:
diff changeset
   592
     * <dt>java.vendor.url      <dd>Java vendor URL
48327
d2a837cf9ff1 8192833: JEP 322: Time-Based Release Versioning
mr
parents: 48262
diff changeset
   593
     * <dt>java.vendor.version  <dd>Java vendor version
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   594
     * <dt>java.home            <dd>Java installation directory
90ce3da70b43 Initial load
duke
parents:
diff changeset
   595
     * <dt>java.class.version   <dd>Java class version number
90ce3da70b43 Initial load
duke
parents:
diff changeset
   596
     * <dt>java.class.path      <dd>Java classpath
90ce3da70b43 Initial load
duke
parents:
diff changeset
   597
     * <dt>os.name              <dd>Operating System Name
90ce3da70b43 Initial load
duke
parents:
diff changeset
   598
     * <dt>os.arch              <dd>Operating System Architecture
90ce3da70b43 Initial load
duke
parents:
diff changeset
   599
     * <dt>os.version           <dd>Operating System Version
90ce3da70b43 Initial load
duke
parents:
diff changeset
   600
     * <dt>file.separator       <dd>File separator ("/" on Unix)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   601
     * <dt>path.separator       <dd>Path separator (":" on Unix)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   602
     * <dt>line.separator       <dd>Line separator ("\n" on Unix)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   603
     * <dt>user.name            <dd>User account name
90ce3da70b43 Initial load
duke
parents:
diff changeset
   604
     * <dt>user.home            <dd>User home directory
90ce3da70b43 Initial load
duke
parents:
diff changeset
   605
     * <dt>user.dir             <dd>User's current working directory
90ce3da70b43 Initial load
duke
parents:
diff changeset
   606
     * </dl>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   607
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   608
90ce3da70b43 Initial load
duke
parents:
diff changeset
   609
    private static Properties props;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   610
90ce3da70b43 Initial load
duke
parents:
diff changeset
   611
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   612
     * Determines the current system properties.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   613
     *
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   614
     * First, if there is a security manager, its
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   615
     * {@code checkPropertiesAccess} method is called with no
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   616
     * arguments. This may result in a security exception.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   617
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   618
     * The current set of system properties for use by the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   619
     * {@link #getProperty(String)} method is returned as a
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   620
     * {@code Properties} object. If there is no current set of
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   621
     * system properties, a set of system properties is first created and
55265
d80becbcd3c1 8197927: Allow the system property `java.vendor.version` to be undefined
mr
parents: 55231
diff changeset
   622
     * initialized. This set of system properties includes a value
d80becbcd3c1 8197927: Allow the system property `java.vendor.version` to be undefined
mr
parents: 55231
diff changeset
   623
     * for each of the following keys unless the description of the associated
d80becbcd3c1 8197927: Allow the system property `java.vendor.version` to be undefined
mr
parents: 55231
diff changeset
   624
     * value indicates that the value is optional.
46148
6d8e27cd2f1e 8186052: Fix a11y and HTML issues in the java.base/java.lang[.*] packages
jjg
parents: 46096
diff changeset
   625
     * <table class="striped" style="text-align:left">
45124
144479e89cdb 8179592: Update tables in java.base to be HTML 5-friendly.
jjg
parents: 45005
diff changeset
   626
     * <caption style="display:none">Shows property keys and associated values</caption>
144479e89cdb 8179592: Update tables in java.base to be HTML 5-friendly.
jjg
parents: 45005
diff changeset
   627
     * <thead>
45881
aaec0fbe17ae 8184208: update class="striped" tables for accessibility
jjg
parents: 45705
diff changeset
   628
     * <tr><th scope="col">Key</th>
aaec0fbe17ae 8184208: update class="striped" tables for accessibility
jjg
parents: 45705
diff changeset
   629
     *     <th scope="col">Description of Associated Value</th></tr>
45124
144479e89cdb 8179592: Update tables in java.base to be HTML 5-friendly.
jjg
parents: 45005
diff changeset
   630
     * </thead>
144479e89cdb 8179592: Update tables in java.base to be HTML 5-friendly.
jjg
parents: 45005
diff changeset
   631
     * <tbody>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   632
     * <tr><th scope="row">{@systemProperty java.version}</th>
48327
d2a837cf9ff1 8192833: JEP 322: Time-Based Release Versioning
mr
parents: 48262
diff changeset
   633
     *     <td>Java Runtime Environment version, which may be interpreted
38432
892603099bb0 8144062: Move jdk.Version to java.lang.Runtime.Version
iris
parents: 37780
diff changeset
   634
     *     as a {@link Runtime.Version}</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   635
     * <tr><th scope="row">{@systemProperty java.version.date}</th>
48327
d2a837cf9ff1 8192833: JEP 322: Time-Based Release Versioning
mr
parents: 48262
diff changeset
   636
     *     <td>Java Runtime Environment version date, in ISO-8601 YYYY-MM-DD
d2a837cf9ff1 8192833: JEP 322: Time-Based Release Versioning
mr
parents: 48262
diff changeset
   637
     *     format, which may be interpreted as a {@link
d2a837cf9ff1 8192833: JEP 322: Time-Based Release Versioning
mr
parents: 48262
diff changeset
   638
     *     java.time.LocalDate}</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   639
     * <tr><th scope="row">{@systemProperty java.vendor}</th>
14014
da3648e13e67 8000269: Cleanup javadoc warnings
alanb
parents: 12038
diff changeset
   640
     *     <td>Java Runtime Environment vendor</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   641
     * <tr><th scope="row">{@systemProperty java.vendor.url}</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   642
     *     <td>Java vendor URL</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   643
     * <tr><th scope="row">{@systemProperty java.vendor.version}</th>
55265
d80becbcd3c1 8197927: Allow the system property `java.vendor.version` to be undefined
mr
parents: 55231
diff changeset
   644
     *     <td>Java vendor version <em>(optional)</em> </td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   645
     * <tr><th scope="row">{@systemProperty java.home}</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   646
     *     <td>Java installation directory</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   647
     * <tr><th scope="row">{@systemProperty java.vm.specification.version}</th>
50531
aeb7fb702890 8204565: (spec) Document java.{vm.}?specification.version system properties' relation to $FEATURE
bchristi
parents: 49203
diff changeset
   648
     *     <td>Java Virtual Machine specification version, whose value is the
aeb7fb702890 8204565: (spec) Document java.{vm.}?specification.version system properties' relation to $FEATURE
bchristi
parents: 49203
diff changeset
   649
     *     {@linkplain Runtime.Version#feature feature} element of the
aeb7fb702890 8204565: (spec) Document java.{vm.}?specification.version system properties' relation to $FEATURE
bchristi
parents: 49203
diff changeset
   650
     *     {@linkplain Runtime#version() runtime version}</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   651
     * <tr><th scope="row">{@systemProperty java.vm.specification.vendor}</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   652
     *     <td>Java Virtual Machine specification vendor</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   653
     * <tr><th scope="row">{@systemProperty java.vm.specification.name}</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   654
     *     <td>Java Virtual Machine specification name</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   655
     * <tr><th scope="row">{@systemProperty java.vm.version}</th>
38432
892603099bb0 8144062: Move jdk.Version to java.lang.Runtime.Version
iris
parents: 37780
diff changeset
   656
     *     <td>Java Virtual Machine implementation version which may be
892603099bb0 8144062: Move jdk.Version to java.lang.Runtime.Version
iris
parents: 37780
diff changeset
   657
     *     interpreted as a {@link Runtime.Version}</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   658
     * <tr><th scope="row">{@systemProperty java.vm.vendor}</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   659
     *     <td>Java Virtual Machine implementation vendor</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   660
     * <tr><th scope="row">{@systemProperty java.vm.name}</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   661
     *     <td>Java Virtual Machine implementation name</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   662
     * <tr><th scope="row">{@systemProperty java.specification.version}</th>
50531
aeb7fb702890 8204565: (spec) Document java.{vm.}?specification.version system properties' relation to $FEATURE
bchristi
parents: 49203
diff changeset
   663
     *     <td>Java Runtime Environment specification version, whose value is
aeb7fb702890 8204565: (spec) Document java.{vm.}?specification.version system properties' relation to $FEATURE
bchristi
parents: 49203
diff changeset
   664
     *     the {@linkplain Runtime.Version#feature feature} element of the
aeb7fb702890 8204565: (spec) Document java.{vm.}?specification.version system properties' relation to $FEATURE
bchristi
parents: 49203
diff changeset
   665
     *     {@linkplain Runtime#version() runtime version}</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   666
     * <tr><th scope="row">{@systemProperty java.specification.vendor}</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   667
     *     <td>Java Runtime Environment specification  vendor</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   668
     * <tr><th scope="row">{@systemProperty java.specification.name}</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   669
     *     <td>Java Runtime Environment specification  name</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   670
     * <tr><th scope="row">{@systemProperty java.class.version}</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   671
     *     <td>Java class format version number</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   672
     * <tr><th scope="row">{@systemProperty java.class.path}</th>
48671
a47ee8b3d308 8191170: Clarify if java.class.path can be undefined
mchung
parents: 48327
diff changeset
   673
     *     <td>Java class path  (refer to
a47ee8b3d308 8191170: Clarify if java.class.path can be undefined
mchung
parents: 48327
diff changeset
   674
     *        {@link ClassLoader#getSystemClassLoader()} for details)</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   675
     * <tr><th scope="row">{@systemProperty java.library.path}</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   676
     *     <td>List of paths to search when loading libraries</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   677
     * <tr><th scope="row">{@systemProperty java.io.tmpdir}</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   678
     *     <td>Default temp file path</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   679
     * <tr><th scope="row">{@systemProperty java.compiler}</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   680
     *     <td>Name of JIT compiler to use</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   681
     * <tr><th scope="row">{@systemProperty os.name}</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   682
     *     <td>Operating system name</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   683
     * <tr><th scope="row">{@systemProperty os.arch}</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   684
     *     <td>Operating system architecture</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   685
     * <tr><th scope="row">{@systemProperty os.version}</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   686
     *     <td>Operating system version</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   687
     * <tr><th scope="row">{@systemProperty file.separator}</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   688
     *     <td>File separator ("/" on UNIX)</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   689
     * <tr><th scope="row">{@systemProperty path.separator}</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   690
     *     <td>Path separator (":" on UNIX)</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   691
     * <tr><th scope="row">{@systemProperty line.separator}</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   692
     *     <td>Line separator ("\n" on UNIX)</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   693
     * <tr><th scope="row">{@systemProperty user.name}</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   694
     *     <td>User's account name</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   695
     * <tr><th scope="row">{@systemProperty user.home}</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   696
     *     <td>User's home directory</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   697
     * <tr><th scope="row">{@systemProperty user.dir}</th>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   698
     *     <td>User's current working directory</td></tr>
45124
144479e89cdb 8179592: Update tables in java.base to be HTML 5-friendly.
jjg
parents: 45005
diff changeset
   699
     * </tbody>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   700
     * </table>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   701
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   702
     * Multiple paths in a system property value are separated by the path
90ce3da70b43 Initial load
duke
parents:
diff changeset
   703
     * separator character of the platform.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   704
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   705
     * Note that even if the security manager does not permit the
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   706
     * {@code getProperties} operation, it may choose to permit the
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   707
     * {@link #getProperty(String)} operation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   708
     *
50817
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   709
     * @apiNote
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   710
     * <strong>Changing a standard system property may have unpredictable results
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   711
     * unless otherwise specified.</strong>
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   712
     * Property values may be cached during initialization or on first use.
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   713
     * Setting a standard property after initialization using {@link #getProperties()},
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   714
     * {@link #setProperties(Properties)}, {@link #setProperty(String, String)}, or
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   715
     * {@link #clearProperty(String)} may not have the desired effect.
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   716
     *
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   717
     * @implNote
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   718
     * In addition to the standard system properties, the system
40261
86a49ba76f52 8136930: Simplify use of module-system options by custom launchers
mchung
parents: 39826
diff changeset
   719
     * properties may include the following keys:
45124
144479e89cdb 8179592: Update tables in java.base to be HTML 5-friendly.
jjg
parents: 45005
diff changeset
   720
     * <table class="striped">
144479e89cdb 8179592: Update tables in java.base to be HTML 5-friendly.
jjg
parents: 45005
diff changeset
   721
     * <caption style="display:none">Shows property keys and associated values</caption>
144479e89cdb 8179592: Update tables in java.base to be HTML 5-friendly.
jjg
parents: 45005
diff changeset
   722
     * <thead>
45881
aaec0fbe17ae 8184208: update class="striped" tables for accessibility
jjg
parents: 45705
diff changeset
   723
     * <tr><th scope="col">Key</th>
aaec0fbe17ae 8184208: update class="striped" tables for accessibility
jjg
parents: 45705
diff changeset
   724
     *     <th scope="col">Description of Associated Value</th></tr>
45124
144479e89cdb 8179592: Update tables in java.base to be HTML 5-friendly.
jjg
parents: 45005
diff changeset
   725
     * </thead>
144479e89cdb 8179592: Update tables in java.base to be HTML 5-friendly.
jjg
parents: 45005
diff changeset
   726
     * <tbody>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   727
     * <tr><th scope="row">{@systemProperty jdk.module.path}</th>
40261
86a49ba76f52 8136930: Simplify use of module-system options by custom launchers
mchung
parents: 39826
diff changeset
   728
     *     <td>The application module path</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   729
     * <tr><th scope="row">{@systemProperty jdk.module.upgrade.path}</th>
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
   730
     *     <td>The upgrade module path</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   731
     * <tr><th scope="row">{@systemProperty jdk.module.main}</th>
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
   732
     *     <td>The module name of the initial/main module</td></tr>
52615
9a899e2c3e64 8213920: Use {@systemProperty} tag for properties listed in System.getProperties
pmuthuswamy
parents: 52478
diff changeset
   733
     * <tr><th scope="row">{@systemProperty jdk.module.main.class}</th>
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
   734
     *     <td>The main class name of the initial module</td></tr>
45124
144479e89cdb 8179592: Update tables in java.base to be HTML 5-friendly.
jjg
parents: 45005
diff changeset
   735
     * </tbody>
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
   736
     * </table>
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
   737
     *
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   738
     * @return     the system properties
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   739
     * @throws     SecurityException  if a security manager exists and its
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   740
     *             {@code checkPropertiesAccess} method doesn't allow access
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   741
     *             to the system properties.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   742
     * @see        #setProperties
90ce3da70b43 Initial load
duke
parents:
diff changeset
   743
     * @see        java.lang.SecurityException
90ce3da70b43 Initial load
duke
parents:
diff changeset
   744
     * @see        java.lang.SecurityManager#checkPropertiesAccess()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   745
     * @see        java.util.Properties
90ce3da70b43 Initial load
duke
parents:
diff changeset
   746
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   747
    public static Properties getProperties() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   748
        SecurityManager sm = getSecurityManager();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   749
        if (sm != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   750
            sm.checkPropertiesAccess();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   751
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   752
90ce3da70b43 Initial load
duke
parents:
diff changeset
   753
        return props;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   754
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   755
90ce3da70b43 Initial load
duke
parents:
diff changeset
   756
    /**
4355
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   757
     * Returns the system-dependent line separator string.  It always
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   758
     * returns the same value - the initial value of the {@linkplain
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   759
     * #getProperty(String) system property} {@code line.separator}.
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   760
     *
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   761
     * <p>On UNIX systems, it returns {@code "\n"}; on Microsoft
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   762
     * Windows systems it returns {@code "\r\n"}.
18546
862067c6481c 8017550: Fix doclint issues in java.lang and subpackages
darcy
parents: 17426
diff changeset
   763
     *
862067c6481c 8017550: Fix doclint issues in java.lang and subpackages
darcy
parents: 17426
diff changeset
   764
     * @return the system-dependent line separator string
10360
d1a6fafde2fa 7082231: Put a @since 1.7 on System.lineSeparator
darcy
parents: 9035
diff changeset
   765
     * @since 1.7
4355
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   766
     */
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   767
    public static String lineSeparator() {
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   768
        return lineSeparator;
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   769
    }
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   770
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   771
    private static String lineSeparator;
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   772
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   773
    /**
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   774
     * Sets the system properties to the {@code Properties} argument.
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   775
     *
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   776
     * First, if there is a security manager, its
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   777
     * {@code checkPropertiesAccess} method is called with no
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   778
     * arguments. This may result in a security exception.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   779
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   780
     * The argument becomes the current set of system properties for use
90ce3da70b43 Initial load
duke
parents:
diff changeset
   781
     * by the {@link #getProperty(String)} method. If the argument is
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   782
     * {@code null}, then the current set of system properties is
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   783
     * forgotten.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   784
     *
50817
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   785
     * @apiNote
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   786
     * <strong>Changing a standard system property may have unpredictable results
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   787
     * unless otherwise specified</strong>.
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   788
     * See {@linkplain #getProperties getProperties} for details.
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   789
     *
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   790
     * @param      props   the new system properties.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   791
     * @throws     SecurityException  if a security manager exists and its
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   792
     *             {@code checkPropertiesAccess} method doesn't allow access
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   793
     *             to the system properties.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   794
     * @see        #getProperties
90ce3da70b43 Initial load
duke
parents:
diff changeset
   795
     * @see        java.util.Properties
90ce3da70b43 Initial load
duke
parents:
diff changeset
   796
     * @see        java.lang.SecurityException
90ce3da70b43 Initial load
duke
parents:
diff changeset
   797
     * @see        java.lang.SecurityManager#checkPropertiesAccess()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   798
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   799
    public static void setProperties(Properties props) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   800
        SecurityManager sm = getSecurityManager();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   801
        if (sm != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   802
            sm.checkPropertiesAccess();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   803
        }
52724
0bdbf854472f 4947890: Minimize JNI upcalls in system-properties initialization
rriggs
parents: 52615
diff changeset
   804
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   805
        if (props == null) {
52978
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
   806
            Map<String, String> tempProps = SystemProps.initProperties();
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
   807
            VersionProps.init(tempProps);
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
   808
            props = createProperties(tempProps);
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   809
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   810
        System.props = props;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   811
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   812
90ce3da70b43 Initial load
duke
parents:
diff changeset
   813
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   814
     * Gets the system property indicated by the specified key.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   815
     *
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   816
     * First, if there is a security manager, its
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   817
     * {@code checkPropertyAccess} method is called with the key as
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   818
     * its argument. This may result in a SecurityException.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   819
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   820
     * If there is no current set of system properties, a set of system
90ce3da70b43 Initial load
duke
parents:
diff changeset
   821
     * properties is first created and initialized in the same manner as
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   822
     * for the {@code getProperties} method.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   823
     *
50817
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   824
     * @apiNote
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   825
     * <strong>Changing a standard system property may have unpredictable results
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   826
     * unless otherwise specified</strong>.
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   827
     * See {@linkplain #getProperties getProperties} for details.
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   828
     *
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   829
     * @param      key   the name of the system property.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   830
     * @return     the string value of the system property,
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   831
     *             or {@code null} if there is no property with that key.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   832
     *
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   833
     * @throws     SecurityException  if a security manager exists and its
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   834
     *             {@code checkPropertyAccess} method doesn't allow
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   835
     *             access to the specified system property.
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   836
     * @throws     NullPointerException if {@code key} is {@code null}.
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   837
     * @throws     IllegalArgumentException if {@code key} is empty.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   838
     * @see        #setProperty
90ce3da70b43 Initial load
duke
parents:
diff changeset
   839
     * @see        java.lang.SecurityException
90ce3da70b43 Initial load
duke
parents:
diff changeset
   840
     * @see        java.lang.SecurityManager#checkPropertyAccess(java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   841
     * @see        java.lang.System#getProperties()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   842
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   843
    public static String getProperty(String key) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   844
        checkKey(key);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   845
        SecurityManager sm = getSecurityManager();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   846
        if (sm != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   847
            sm.checkPropertyAccess(key);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   848
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   849
90ce3da70b43 Initial load
duke
parents:
diff changeset
   850
        return props.getProperty(key);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   851
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   852
90ce3da70b43 Initial load
duke
parents:
diff changeset
   853
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   854
     * Gets the system property indicated by the specified key.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   855
     *
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   856
     * First, if there is a security manager, its
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   857
     * {@code checkPropertyAccess} method is called with the
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   858
     * {@code key} as its argument.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   859
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   860
     * If there is no current set of system properties, a set of system
90ce3da70b43 Initial load
duke
parents:
diff changeset
   861
     * properties is first created and initialized in the same manner as
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   862
     * for the {@code getProperties} method.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   863
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   864
     * @param      key   the name of the system property.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   865
     * @param      def   a default value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   866
     * @return     the string value of the system property,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   867
     *             or the default value if there is no property with that key.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   868
     *
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   869
     * @throws     SecurityException  if a security manager exists and its
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   870
     *             {@code checkPropertyAccess} method doesn't allow
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   871
     *             access to the specified system property.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   872
     * @throws     NullPointerException if {@code key} is {@code null}.
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   873
     * @throws     IllegalArgumentException if {@code key} is empty.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   874
     * @see        #setProperty
90ce3da70b43 Initial load
duke
parents:
diff changeset
   875
     * @see        java.lang.SecurityManager#checkPropertyAccess(java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   876
     * @see        java.lang.System#getProperties()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   877
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   878
    public static String getProperty(String key, String def) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   879
        checkKey(key);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   880
        SecurityManager sm = getSecurityManager();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   881
        if (sm != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   882
            sm.checkPropertyAccess(key);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   883
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   884
90ce3da70b43 Initial load
duke
parents:
diff changeset
   885
        return props.getProperty(key, def);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   886
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   887
90ce3da70b43 Initial load
duke
parents:
diff changeset
   888
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   889
     * Sets the system property indicated by the specified key.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   890
     *
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   891
     * First, if a security manager exists, its
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   892
     * {@code SecurityManager.checkPermission} method
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   893
     * is called with a {@code PropertyPermission(key, "write")}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   894
     * permission. This may result in a SecurityException being thrown.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   895
     * If no exception is thrown, the specified property is set to the given
90ce3da70b43 Initial load
duke
parents:
diff changeset
   896
     * value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   897
     *
50817
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   898
     * @apiNote
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   899
     * <strong>Changing a standard system property may have unpredictable results
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   900
     * unless otherwise specified</strong>.
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   901
     * See {@linkplain #getProperties getProperties} for details.
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   902
     *
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   903
     * @param      key   the name of the system property.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   904
     * @param      value the value of the system property.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   905
     * @return     the previous value of the system property,
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   906
     *             or {@code null} if it did not have one.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   907
     *
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   908
     * @throws     SecurityException  if a security manager exists and its
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   909
     *             {@code checkPermission} method doesn't allow
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   910
     *             setting of the specified property.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   911
     * @throws     NullPointerException if {@code key} or
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   912
     *             {@code value} is {@code null}.
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   913
     * @throws     IllegalArgumentException if {@code key} is empty.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   914
     * @see        #getProperty
90ce3da70b43 Initial load
duke
parents:
diff changeset
   915
     * @see        java.lang.System#getProperty(java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   916
     * @see        java.lang.System#getProperty(java.lang.String, java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   917
     * @see        java.util.PropertyPermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   918
     * @see        SecurityManager#checkPermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   919
     * @since      1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   920
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   921
    public static String setProperty(String key, String value) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   922
        checkKey(key);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   923
        SecurityManager sm = getSecurityManager();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   924
        if (sm != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   925
            sm.checkPermission(new PropertyPermission(key,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   926
                SecurityConstants.PROPERTY_WRITE_ACTION));
90ce3da70b43 Initial load
duke
parents:
diff changeset
   927
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   928
90ce3da70b43 Initial load
duke
parents:
diff changeset
   929
        return (String) props.setProperty(key, value);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   930
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   931
90ce3da70b43 Initial load
duke
parents:
diff changeset
   932
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   933
     * Removes the system property indicated by the specified key.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   934
     *
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   935
     * First, if a security manager exists, its
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   936
     * {@code SecurityManager.checkPermission} method
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   937
     * is called with a {@code PropertyPermission(key, "write")}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   938
     * permission. This may result in a SecurityException being thrown.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   939
     * If no exception is thrown, the specified property is removed.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   940
     *
50817
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   941
     * @apiNote
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   942
     * <strong>Changing a standard system property may have unpredictable results
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   943
     * unless otherwise specified</strong>.
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   944
     * See {@linkplain #getProperties getProperties} method for details.
fa1e04811ff6 8066709: Make some JDK system properties read only
rriggs
parents: 50552
diff changeset
   945
     *
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   946
     * @param      key   the name of the system property to be removed.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   947
     * @return     the previous string value of the system property,
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   948
     *             or {@code null} if there was no property with that key.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   949
     *
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   950
     * @throws     SecurityException  if a security manager exists and its
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   951
     *             {@code checkPropertyAccess} method doesn't allow
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   952
     *              access to the specified system property.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   953
     * @throws     NullPointerException if {@code key} is {@code null}.
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   954
     * @throws     IllegalArgumentException if {@code key} is empty.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   955
     * @see        #getProperty
90ce3da70b43 Initial load
duke
parents:
diff changeset
   956
     * @see        #setProperty
90ce3da70b43 Initial load
duke
parents:
diff changeset
   957
     * @see        java.util.Properties
90ce3da70b43 Initial load
duke
parents:
diff changeset
   958
     * @see        java.lang.SecurityException
90ce3da70b43 Initial load
duke
parents:
diff changeset
   959
     * @see        java.lang.SecurityManager#checkPropertiesAccess()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   960
     * @since 1.5
90ce3da70b43 Initial load
duke
parents:
diff changeset
   961
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   962
    public static String clearProperty(String key) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   963
        checkKey(key);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   964
        SecurityManager sm = getSecurityManager();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   965
        if (sm != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   966
            sm.checkPermission(new PropertyPermission(key, "write"));
90ce3da70b43 Initial load
duke
parents:
diff changeset
   967
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   968
90ce3da70b43 Initial load
duke
parents:
diff changeset
   969
        return (String) props.remove(key);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   970
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   971
90ce3da70b43 Initial load
duke
parents:
diff changeset
   972
    private static void checkKey(String key) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   973
        if (key == null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   974
            throw new NullPointerException("key can't be null");
90ce3da70b43 Initial load
duke
parents:
diff changeset
   975
        }
52902
e3398b2e1ab0 8214971: Replace use of string.equals("") with isEmpty()
rriggs
parents: 52724
diff changeset
   976
        if (key.isEmpty()) {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   977
            throw new IllegalArgumentException("key can't be empty");
90ce3da70b43 Initial load
duke
parents:
diff changeset
   978
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   979
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   980
90ce3da70b43 Initial load
duke
parents:
diff changeset
   981
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   982
     * Gets the value of the specified environment variable. An
90ce3da70b43 Initial load
duke
parents:
diff changeset
   983
     * environment variable is a system-dependent external named
90ce3da70b43 Initial load
duke
parents:
diff changeset
   984
     * value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   985
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   986
     * <p>If a security manager exists, its
90ce3da70b43 Initial load
duke
parents:
diff changeset
   987
     * {@link SecurityManager#checkPermission checkPermission}
90ce3da70b43 Initial load
duke
parents:
diff changeset
   988
     * method is called with a
53160
7d1efad039a3 8216205: Java API documentation formatting error in System.getEnv
rriggs
parents: 52978
diff changeset
   989
     * {@link RuntimePermission RuntimePermission("getenv."+name)}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   990
     * permission.  This may result in a {@link SecurityException}
90ce3da70b43 Initial load
duke
parents:
diff changeset
   991
     * being thrown.  If no exception is thrown the value of the
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
   992
     * variable {@code name} is returned.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   993
     *
44844
b2b4d98404ba 8179364: update "<a name=" in java.base module to use id attribute
jjg
parents: 44667
diff changeset
   994
     * <p><a id="EnvironmentVSSystemProperties"><i>System
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   995
     * properties</i> and <i>environment variables</i></a> are both
90ce3da70b43 Initial load
duke
parents:
diff changeset
   996
     * conceptually mappings between names and values.  Both
90ce3da70b43 Initial load
duke
parents:
diff changeset
   997
     * mechanisms can be used to pass user-defined information to a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   998
     * Java process.  Environment variables have a more global effect,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   999
     * because they are visible to all descendants of the process
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1000
     * which defines them, not just the immediate Java subprocess.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1001
     * They can have subtly different semantics, such as case
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1002
     * insensitivity, on different operating systems.  For these
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1003
     * reasons, environment variables are more likely to have
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1004
     * unintended side effects.  It is best to use system properties
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1005
     * where possible.  Environment variables should be used when a
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1006
     * global effect is desired, or when an external system interface
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1007
     * requires an environment variable (such as {@code PATH}).
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1008
     *
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1009
     * <p>On UNIX systems the alphabetic case of {@code name} is
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1010
     * typically significant, while on Microsoft Windows systems it is
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1011
     * typically not.  For example, the expression
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1012
     * {@code System.getenv("FOO").equals(System.getenv("foo"))}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1013
     * is likely to be true on Microsoft Windows.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1014
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1015
     * @param  name the name of the environment variable
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1016
     * @return the string value of the variable, or {@code null}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1017
     *         if the variable is not defined in the system environment
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1018
     * @throws NullPointerException if {@code name} is {@code null}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1019
     * @throws SecurityException
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1020
     *         if a security manager exists and its
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1021
     *         {@link SecurityManager#checkPermission checkPermission}
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1022
     *         method doesn't allow access to the environment variable
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1023
     *         {@code name}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1024
     * @see    #getenv()
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1025
     * @see    ProcessBuilder#environment()
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1026
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1027
    public static String getenv(String name) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1028
        SecurityManager sm = getSecurityManager();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1029
        if (sm != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1030
            sm.checkPermission(new RuntimePermission("getenv."+name));
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1031
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1032
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1033
        return ProcessEnvironment.getenv(name);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1034
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1035
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1036
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1037
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1038
     * Returns an unmodifiable string map view of the current system environment.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1039
     * The environment is a system-dependent mapping from names to
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1040
     * values which is passed from parent to child processes.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1041
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1042
     * <p>If the system does not support environment variables, an
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1043
     * empty map is returned.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1044
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1045
     * <p>The returned map will never contain null keys or values.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1046
     * Attempting to query the presence of a null key or value will
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1047
     * throw a {@link NullPointerException}.  Attempting to query
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1048
     * the presence of a key or value which is not of type
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1049
     * {@link String} will throw a {@link ClassCastException}.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1050
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1051
     * <p>The returned map and its collection views may not obey the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1052
     * general contract of the {@link Object#equals} and
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1053
     * {@link Object#hashCode} methods.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1054
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1055
     * <p>The returned map is typically case-sensitive on all platforms.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1056
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1057
     * <p>If a security manager exists, its
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1058
     * {@link SecurityManager#checkPermission checkPermission}
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1059
     * method is called with a
53160
7d1efad039a3 8216205: Java API documentation formatting error in System.getEnv
rriggs
parents: 52978
diff changeset
  1060
     * {@link RuntimePermission RuntimePermission("getenv.*")} permission.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1061
     * This may result in a {@link SecurityException} being thrown.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1062
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1063
     * <p>When passing information to a Java subprocess,
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1064
     * <a href=#EnvironmentVSSystemProperties>system properties</a>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1065
     * are generally preferred over environment variables.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1066
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1067
     * @return the environment as a map of variable names to values
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1068
     * @throws SecurityException
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1069
     *         if a security manager exists and its
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1070
     *         {@link SecurityManager#checkPermission checkPermission}
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1071
     *         method doesn't allow access to the process environment
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1072
     * @see    #getenv(String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1073
     * @see    ProcessBuilder#environment()
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1074
     * @since  1.5
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1075
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1076
    public static java.util.Map<String,String> getenv() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1077
        SecurityManager sm = getSecurityManager();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1078
        if (sm != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1079
            sm.checkPermission(new RuntimePermission("getenv.*"));
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1080
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1081
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1082
        return ProcessEnvironment.getenv();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1083
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1084
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1085
    /**
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1086
     * {@code System.Logger} instances log messages that will be
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1087
     * routed to the underlying logging framework the {@link System.LoggerFinder
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1088
     * LoggerFinder} uses.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1089
     *
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1090
     * {@code System.Logger} instances are typically obtained from
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1091
     * the {@link java.lang.System System} class, by calling
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1092
     * {@link java.lang.System#getLogger(java.lang.String) System.getLogger(loggerName)}
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1093
     * or {@link java.lang.System#getLogger(java.lang.String, java.util.ResourceBundle)
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1094
     * System.getLogger(loggerName, bundle)}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1095
     *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1096
     * @see java.lang.System#getLogger(java.lang.String)
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1097
     * @see java.lang.System#getLogger(java.lang.String, java.util.ResourceBundle)
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1098
     * @see java.lang.System.LoggerFinder
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1099
     *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1100
     * @since 9
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1101
     */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1102
    public interface Logger {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1103
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1104
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1105
         * System {@linkplain Logger loggers} levels.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1106
         *
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1107
         * A level has a {@linkplain #getName() name} and {@linkplain
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1108
         * #getSeverity() severity}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1109
         * Level values are {@link #ALL}, {@link #TRACE}, {@link #DEBUG},
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1110
         * {@link #INFO}, {@link #WARNING}, {@link #ERROR}, {@link #OFF},
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1111
         * by order of increasing severity.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1112
         * <br>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1113
         * {@link #ALL} and {@link #OFF}
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1114
         * are simple markers with severities mapped respectively to
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1115
         * {@link java.lang.Integer#MIN_VALUE Integer.MIN_VALUE} and
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1116
         * {@link java.lang.Integer#MAX_VALUE Integer.MAX_VALUE}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1117
         * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1118
         * <b>Severity values and Mapping to {@code java.util.logging.Level}.</b>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1119
         * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1120
         * {@linkplain System.Logger.Level System logger levels} are mapped to
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1121
         * {@linkplain java.util.logging.Level  java.util.logging levels}
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1122
         * of corresponding severity.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1123
         * <br>The mapping is as follows:
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1124
         * <br><br>
46148
6d8e27cd2f1e 8186052: Fix a11y and HTML issues in the java.base/java.lang[.*] packages
jjg
parents: 46096
diff changeset
  1125
         * <table class="striped">
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1126
         * <caption>System.Logger Severity Level Mapping</caption>
46148
6d8e27cd2f1e 8186052: Fix a11y and HTML issues in the java.base/java.lang[.*] packages
jjg
parents: 46096
diff changeset
  1127
         * <thead>
6d8e27cd2f1e 8186052: Fix a11y and HTML issues in the java.base/java.lang[.*] packages
jjg
parents: 46096
diff changeset
  1128
         * <tr><th scope="col">System.Logger Levels</th>
6d8e27cd2f1e 8186052: Fix a11y and HTML issues in the java.base/java.lang[.*] packages
jjg
parents: 46096
diff changeset
  1129
         *     <th scope="col">java.util.logging Levels</th>
6d8e27cd2f1e 8186052: Fix a11y and HTML issues in the java.base/java.lang[.*] packages
jjg
parents: 46096
diff changeset
  1130
         * </thead>
6d8e27cd2f1e 8186052: Fix a11y and HTML issues in the java.base/java.lang[.*] packages
jjg
parents: 46096
diff changeset
  1131
         * <tbody>
6d8e27cd2f1e 8186052: Fix a11y and HTML issues in the java.base/java.lang[.*] packages
jjg
parents: 46096
diff changeset
  1132
         * <tr><th scope="row">{@link Logger.Level#ALL ALL}</th>
6d8e27cd2f1e 8186052: Fix a11y and HTML issues in the java.base/java.lang[.*] packages
jjg
parents: 46096
diff changeset
  1133
         *     <td>{@link java.util.logging.Level#ALL ALL}</td>
6d8e27cd2f1e 8186052: Fix a11y and HTML issues in the java.base/java.lang[.*] packages
jjg
parents: 46096
diff changeset
  1134
         * <tr><th scope="row">{@link Logger.Level#TRACE TRACE}</th>
6d8e27cd2f1e 8186052: Fix a11y and HTML issues in the java.base/java.lang[.*] packages
jjg
parents: 46096
diff changeset
  1135
         *     <td>{@link java.util.logging.Level#FINER FINER}</td>
6d8e27cd2f1e 8186052: Fix a11y and HTML issues in the java.base/java.lang[.*] packages
jjg
parents: 46096
diff changeset
  1136
         * <tr><th scope="row">{@link Logger.Level#DEBUG DEBUG}</th>
6d8e27cd2f1e 8186052: Fix a11y and HTML issues in the java.base/java.lang[.*] packages
jjg
parents: 46096
diff changeset
  1137
         *     <td>{@link java.util.logging.Level#FINE FINE}</td>
6d8e27cd2f1e 8186052: Fix a11y and HTML issues in the java.base/java.lang[.*] packages
jjg
parents: 46096
diff changeset
  1138
         * <tr><th scope="row">{@link Logger.Level#INFO INFO}</th>
6d8e27cd2f1e 8186052: Fix a11y and HTML issues in the java.base/java.lang[.*] packages
jjg
parents: 46096
diff changeset
  1139
         *     <td>{@link java.util.logging.Level#INFO INFO}</td>
6d8e27cd2f1e 8186052: Fix a11y and HTML issues in the java.base/java.lang[.*] packages
jjg
parents: 46096
diff changeset
  1140
         * <tr><th scope="row">{@link Logger.Level#WARNING WARNING}</th>
6d8e27cd2f1e 8186052: Fix a11y and HTML issues in the java.base/java.lang[.*] packages
jjg
parents: 46096
diff changeset
  1141
         *     <td>{@link java.util.logging.Level#WARNING WARNING}</td>
6d8e27cd2f1e 8186052: Fix a11y and HTML issues in the java.base/java.lang[.*] packages
jjg
parents: 46096
diff changeset
  1142
         * <tr><th scope="row">{@link Logger.Level#ERROR ERROR}</th>
6d8e27cd2f1e 8186052: Fix a11y and HTML issues in the java.base/java.lang[.*] packages
jjg
parents: 46096
diff changeset
  1143
         *     <td>{@link java.util.logging.Level#SEVERE SEVERE}</td>
6d8e27cd2f1e 8186052: Fix a11y and HTML issues in the java.base/java.lang[.*] packages
jjg
parents: 46096
diff changeset
  1144
         * <tr><th scope="row">{@link Logger.Level#OFF OFF}</th>
6d8e27cd2f1e 8186052: Fix a11y and HTML issues in the java.base/java.lang[.*] packages
jjg
parents: 46096
diff changeset
  1145
         *     <td>{@link java.util.logging.Level#OFF OFF}</td>
6d8e27cd2f1e 8186052: Fix a11y and HTML issues in the java.base/java.lang[.*] packages
jjg
parents: 46096
diff changeset
  1146
         * </tbody>
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1147
         * </table>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1148
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1149
         * @since 9
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1150
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1151
         * @see java.lang.System.LoggerFinder
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1152
         * @see java.lang.System.Logger
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1153
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1154
        public enum Level {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1155
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1156
            // for convenience, we're reusing java.util.logging.Level int values
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1157
            // the mapping logic in sun.util.logging.PlatformLogger depends
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1158
            // on this.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1159
            /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1160
             * A marker to indicate that all levels are enabled.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1161
             * This level {@linkplain #getSeverity() severity} is
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1162
             * {@link Integer#MIN_VALUE}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1163
             */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1164
            ALL(Integer.MIN_VALUE),  // typically mapped to/from j.u.l.Level.ALL
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1165
            /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1166
             * {@code TRACE} level: usually used to log diagnostic information.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1167
             * This level {@linkplain #getSeverity() severity} is
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1168
             * {@code 400}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1169
             */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1170
            TRACE(400),   // typically mapped to/from j.u.l.Level.FINER
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1171
            /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1172
             * {@code DEBUG} level: usually used to log debug information traces.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1173
             * This level {@linkplain #getSeverity() severity} is
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1174
             * {@code 500}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1175
             */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1176
            DEBUG(500),   // typically mapped to/from j.u.l.Level.FINEST/FINE/CONFIG
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1177
            /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1178
             * {@code INFO} level: usually used to log information messages.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1179
             * This level {@linkplain #getSeverity() severity} is
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1180
             * {@code 800}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1181
             */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1182
            INFO(800),    // typically mapped to/from j.u.l.Level.INFO
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1183
            /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1184
             * {@code WARNING} level: usually used to log warning messages.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1185
             * This level {@linkplain #getSeverity() severity} is
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1186
             * {@code 900}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1187
             */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1188
            WARNING(900), // typically mapped to/from j.u.l.Level.WARNING
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1189
            /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1190
             * {@code ERROR} level: usually used to log error messages.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1191
             * This level {@linkplain #getSeverity() severity} is
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1192
             * {@code 1000}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1193
             */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1194
            ERROR(1000),  // typically mapped to/from j.u.l.Level.SEVERE
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1195
            /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1196
             * A marker to indicate that all levels are disabled.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1197
             * This level {@linkplain #getSeverity() severity} is
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1198
             * {@link Integer#MAX_VALUE}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1199
             */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1200
            OFF(Integer.MAX_VALUE);  // typically mapped to/from j.u.l.Level.OFF
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1201
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1202
            private final int severity;
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1203
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1204
            private Level(int severity) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1205
                this.severity = severity;
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1206
            }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1207
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1208
            /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1209
             * Returns the name of this level.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1210
             * @return this level {@linkplain #name()}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1211
             */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1212
            public final String getName() {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1213
                return name();
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1214
            }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1215
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1216
            /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1217
             * Returns the severity of this level.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1218
             * A higher severity means a more severe condition.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1219
             * @return this level severity.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1220
             */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1221
            public final int getSeverity() {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1222
                return severity;
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1223
            }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1224
        }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1225
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1226
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1227
         * Returns the name of this logger.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1228
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1229
         * @return the logger name.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1230
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1231
        public String getName();
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1232
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1233
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1234
         * Checks if a message of the given level would be logged by
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1235
         * this logger.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1236
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1237
         * @param level the log message level.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1238
         * @return {@code true} if the given log message level is currently
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1239
         *         being logged.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1240
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1241
         * @throws NullPointerException if {@code level} is {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1242
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1243
        public boolean isLoggable(Level level);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1244
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1245
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1246
         * Logs a message.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1247
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1248
         * @implSpec The default implementation for this method calls
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1249
         * {@code this.log(level, (ResourceBundle)null, msg, (Object[])null);}
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1250
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1251
         * @param level the log message level.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1252
         * @param msg the string message (or a key in the message catalog, if
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1253
         * this logger is a {@link
37672
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1254
         * LoggerFinder#getLocalizedLogger(java.lang.String,
44545
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  1255
         * java.util.ResourceBundle, java.lang.Module) localized logger});
37672
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1256
         * can be {@code null}.
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1257
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1258
         * @throws NullPointerException if {@code level} is {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1259
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1260
        public default void log(Level level, String msg) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1261
            log(level, (ResourceBundle) null, msg, (Object[]) null);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1262
        }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1263
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1264
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1265
         * Logs a lazily supplied message.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1266
         *
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1267
         * If the logger is currently enabled for the given log message level
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1268
         * then a message is logged that is the result produced by the
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1269
         * given supplier function.  Otherwise, the supplier is not operated on.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1270
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1271
         * @implSpec When logging is enabled for the given level, the default
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1272
         * implementation for this method calls
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1273
         * {@code this.log(level, (ResourceBundle)null, msgSupplier.get(), (Object[])null);}
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1274
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1275
         * @param level the log message level.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1276
         * @param msgSupplier a supplier function that produces a message.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1277
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1278
         * @throws NullPointerException if {@code level} is {@code null},
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1279
         *         or {@code msgSupplier} is {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1280
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1281
        public default void log(Level level, Supplier<String> msgSupplier) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1282
            Objects.requireNonNull(msgSupplier);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1283
            if (isLoggable(Objects.requireNonNull(level))) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1284
                log(level, (ResourceBundle) null, msgSupplier.get(), (Object[]) null);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1285
            }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1286
        }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1287
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1288
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1289
         * Logs a message produced from the given object.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1290
         *
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1291
         * If the logger is currently enabled for the given log message level then
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1292
         * a message is logged that, by default, is the result produced from
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1293
         * calling  toString on the given object.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1294
         * Otherwise, the object is not operated on.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1295
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1296
         * @implSpec When logging is enabled for the given level, the default
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1297
         * implementation for this method calls
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1298
         * {@code this.log(level, (ResourceBundle)null, obj.toString(), (Object[])null);}
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1299
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1300
         * @param level the log message level.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1301
         * @param obj the object to log.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1302
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1303
         * @throws NullPointerException if {@code level} is {@code null}, or
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1304
         *         {@code obj} is {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1305
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1306
        public default void log(Level level, Object obj) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1307
            Objects.requireNonNull(obj);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1308
            if (isLoggable(Objects.requireNonNull(level))) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1309
                this.log(level, (ResourceBundle) null, obj.toString(), (Object[]) null);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1310
            }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1311
        }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1312
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1313
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1314
         * Logs a message associated with a given throwable.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1315
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1316
         * @implSpec The default implementation for this method calls
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1317
         * {@code this.log(level, (ResourceBundle)null, msg, thrown);}
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1318
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1319
         * @param level the log message level.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1320
         * @param msg the string message (or a key in the message catalog, if
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1321
         * this logger is a {@link
37672
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1322
         * LoggerFinder#getLocalizedLogger(java.lang.String,
44545
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  1323
         * java.util.ResourceBundle, java.lang.Module) localized logger});
37672
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1324
         * can be {@code null}.
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1325
         * @param thrown a {@code Throwable} associated with the log message;
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1326
         *        can be {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1327
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1328
         * @throws NullPointerException if {@code level} is {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1329
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1330
        public default void log(Level level, String msg, Throwable thrown) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1331
            this.log(level, null, msg, thrown);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1332
        }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1333
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1334
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1335
         * Logs a lazily supplied message associated with a given throwable.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1336
         *
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1337
         * If the logger is currently enabled for the given log message level
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1338
         * then a message is logged that is the result produced by the
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1339
         * given supplier function.  Otherwise, the supplier is not operated on.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1340
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1341
         * @implSpec When logging is enabled for the given level, the default
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1342
         * implementation for this method calls
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1343
         * {@code this.log(level, (ResourceBundle)null, msgSupplier.get(), thrown);}
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1344
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1345
         * @param level one of the log message level identifiers.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1346
         * @param msgSupplier a supplier function that produces a message.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1347
         * @param thrown a {@code Throwable} associated with log message;
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1348
         *               can be {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1349
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1350
         * @throws NullPointerException if {@code level} is {@code null}, or
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1351
         *                               {@code msgSupplier} is {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1352
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1353
        public default void log(Level level, Supplier<String> msgSupplier,
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1354
                Throwable thrown) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1355
            Objects.requireNonNull(msgSupplier);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1356
            if (isLoggable(Objects.requireNonNull(level))) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1357
                this.log(level, null, msgSupplier.get(), thrown);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1358
            }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1359
        }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1360
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1361
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1362
         * Logs a message with an optional list of parameters.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1363
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1364
         * @implSpec The default implementation for this method calls
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1365
         * {@code this.log(level, (ResourceBundle)null, format, params);}
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1366
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1367
         * @param level one of the log message level identifiers.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1368
         * @param format the string message format in {@link
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1369
         * java.text.MessageFormat} format, (or a key in the message
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1370
         * catalog, if this logger is a {@link
37672
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1371
         * LoggerFinder#getLocalizedLogger(java.lang.String,
44545
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  1372
         * java.util.ResourceBundle, java.lang.Module) localized logger});
37672
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1373
         * can be {@code null}.
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1374
         * @param params an optional list of parameters to the message (may be
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1375
         * none).
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1376
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1377
         * @throws NullPointerException if {@code level} is {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1378
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1379
        public default void log(Level level, String format, Object... params) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1380
            this.log(level, null, format, params);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1381
        }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1382
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1383
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1384
         * Logs a localized message associated with a given throwable.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1385
         *
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1386
         * If the given resource bundle is non-{@code null},  the {@code msg}
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1387
         * string is localized using the given resource bundle.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1388
         * Otherwise the {@code msg} string is not localized.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1389
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1390
         * @param level the log message level.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1391
         * @param bundle a resource bundle to localize {@code msg}; can be
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1392
         * {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1393
         * @param msg the string message (or a key in the message catalog,
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1394
         *            if {@code bundle} is not {@code null}); can be {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1395
         * @param thrown a {@code Throwable} associated with the log message;
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1396
         *        can be {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1397
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1398
         * @throws NullPointerException if {@code level} is {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1399
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1400
        public void log(Level level, ResourceBundle bundle, String msg,
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1401
                Throwable thrown);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1402
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1403
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1404
         * Logs a message with resource bundle and an optional list of
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1405
         * parameters.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1406
         *
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1407
         * If the given resource bundle is non-{@code null},  the {@code format}
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1408
         * string is localized using the given resource bundle.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1409
         * Otherwise the {@code format} string is not localized.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1410
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1411
         * @param level the log message level.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1412
         * @param bundle a resource bundle to localize {@code format}; can be
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1413
         * {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1414
         * @param format the string message format in {@link
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1415
         * java.text.MessageFormat} format, (or a key in the message
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1416
         * catalog if {@code bundle} is not {@code null}); can be {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1417
         * @param params an optional list of parameters to the message (may be
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1418
         * none).
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1419
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1420
         * @throws NullPointerException if {@code level} is {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1421
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1422
        public void log(Level level, ResourceBundle bundle, String format,
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1423
                Object... params);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1424
    }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1425
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1426
    /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1427
     * The {@code LoggerFinder} service is responsible for creating, managing,
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1428
     * and configuring loggers to the underlying framework it uses.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1429
     *
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1430
     * A logger finder is a concrete implementation of this class that has a
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1431
     * zero-argument constructor and implements the abstract methods defined
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1432
     * by this class.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1433
     * The loggers returned from a logger finder are capable of routing log
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1434
     * messages to the logging backend this provider supports.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1435
     * A given invocation of the Java Runtime maintains a single
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1436
     * system-wide LoggerFinder instance that is loaded as follows:
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1437
     * <ul>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1438
     *    <li>First it finds any custom {@code LoggerFinder} provider
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1439
     *        using the {@link java.util.ServiceLoader} facility with the
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1440
     *        {@linkplain ClassLoader#getSystemClassLoader() system class
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1441
     *        loader}.</li>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1442
     *    <li>If no {@code LoggerFinder} provider is found, the system default
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1443
     *        {@code LoggerFinder} implementation will be used.</li>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1444
     * </ul>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1445
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1446
     * An application can replace the logging backend
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1447
     * <i>even when the java.logging module is present</i>, by simply providing
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1448
     * and declaring an implementation of the {@link LoggerFinder} service.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1449
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1450
     * <b>Default Implementation</b>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1451
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1452
     * The system default {@code LoggerFinder} implementation uses
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1453
     * {@code java.util.logging} as the backend framework when the
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1454
     * {@code java.logging} module is present.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1455
     * It returns a {@linkplain System.Logger logger} instance
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1456
     * that will route log messages to a {@link java.util.logging.Logger
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1457
     * java.util.logging.Logger}. Otherwise, if {@code java.logging} is not
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1458
     * present, the default implementation will return a simple logger
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1459
     * instance that will route log messages of {@code INFO} level and above to
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1460
     * the console ({@code System.err}).
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1461
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1462
     * <b>Logging Configuration</b>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1463
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1464
     * {@linkplain Logger Logger} instances obtained from the
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1465
     * {@code LoggerFinder} factory methods are not directly configurable by
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1466
     * the application. Configuration is the responsibility of the underlying
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1467
     * logging backend, and usually requires using APIs specific to that backend.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1468
     * <p>For the default {@code LoggerFinder} implementation
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1469
     * using {@code java.util.logging} as its backend, refer to
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1470
     * {@link java.util.logging java.util.logging} for logging configuration.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1471
     * For the default {@code LoggerFinder} implementation returning simple loggers
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1472
     * when the {@code java.logging} module is absent, the configuration
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1473
     * is implementation dependent.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1474
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1475
     * Usually an application that uses a logging framework will log messages
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1476
     * through a logger facade defined (or supported) by that framework.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1477
     * Applications that wish to use an external framework should log
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1478
     * through the facade associated with that framework.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1479
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1480
     * A system class that needs to log messages will typically obtain
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1481
     * a {@link System.Logger} instance to route messages to the logging
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1482
     * framework selected by the application.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1483
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1484
     * Libraries and classes that only need loggers to produce log messages
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1485
     * should not attempt to configure loggers by themselves, as that
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1486
     * would make them dependent from a specific implementation of the
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1487
     * {@code LoggerFinder} service.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1488
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1489
     * In addition, when a security manager is present, loggers provided to
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1490
     * system classes should not be directly configurable through the logging
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1491
     * backend without requiring permissions.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1492
     * <br>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1493
     * It is the responsibility of the provider of
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1494
     * the concrete {@code LoggerFinder} implementation to ensure that
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1495
     * these loggers are not configured by untrusted code without proper
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1496
     * permission checks, as configuration performed on such loggers usually
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1497
     * affects all applications in the same Java Runtime.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1498
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1499
     * <b>Message Levels and Mapping to backend levels</b>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1500
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1501
     * A logger finder is responsible for mapping from a {@code
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1502
     * System.Logger.Level} to a level supported by the logging backend it uses.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1503
     * <br>The default LoggerFinder using {@code java.util.logging} as the backend
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1504
     * maps {@code System.Logger} levels to
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1505
     * {@linkplain java.util.logging.Level java.util.logging} levels
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1506
     * of corresponding severity - as described in {@link Logger.Level
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1507
     * Logger.Level}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1508
     *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1509
     * @see java.lang.System
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1510
     * @see java.lang.System.Logger
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1511
     *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1512
     * @since 9
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1513
     */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1514
    public static abstract class LoggerFinder {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1515
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1516
         * The {@code RuntimePermission("loggerFinder")} is
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1517
         * necessary to subclass and instantiate the {@code LoggerFinder} class,
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1518
         * as well as to obtain loggers from an instance of that class.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1519
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1520
        static final RuntimePermission LOGGERFINDER_PERMISSION =
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1521
                new RuntimePermission("loggerFinder");
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1522
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1523
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1524
         * Creates a new instance of {@code LoggerFinder}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1525
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1526
         * @implNote It is recommended that a {@code LoggerFinder} service
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1527
         *   implementation does not perform any heavy initialization in its
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1528
         *   constructor, in order to avoid possible risks of deadlock or class
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1529
         *   loading cycles during the instantiation of the service provider.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1530
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1531
         * @throws SecurityException if a security manager is present and its
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1532
         *         {@code checkPermission} method doesn't allow the
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1533
         *         {@code RuntimePermission("loggerFinder")}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1534
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1535
        protected LoggerFinder() {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1536
            this(checkPermission());
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1537
        }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1538
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1539
        private LoggerFinder(Void unused) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1540
            // nothing to do.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1541
        }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1542
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1543
        private static Void checkPermission() {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1544
            final SecurityManager sm = System.getSecurityManager();
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1545
            if (sm != null) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1546
                sm.checkPermission(LOGGERFINDER_PERMISSION);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1547
            }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1548
            return null;
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1549
        }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1550
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1551
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1552
         * Returns an instance of {@link Logger Logger}
37672
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1553
         * for the given {@code module}.
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1554
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1555
         * @param name the name of the logger.
37672
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1556
         * @param module the module for which the logger is being requested.
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1557
         *
37672
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1558
         * @return a {@link Logger logger} suitable for use within the given
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1559
         *         module.
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1560
         * @throws NullPointerException if {@code name} is {@code null} or
37672
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1561
         *        {@code module} is {@code null}.
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1562
         * @throws SecurityException if a security manager is present and its
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1563
         *         {@code checkPermission} method doesn't allow the
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1564
         *         {@code RuntimePermission("loggerFinder")}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1565
         */
37672
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1566
        public abstract Logger getLogger(String name, Module module);
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1567
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1568
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1569
         * Returns a localizable instance of {@link Logger Logger}
37672
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1570
         * for the given {@code module}.
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1571
         * The returned logger will use the provided resource bundle for
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1572
         * message localization.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1573
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1574
         * @implSpec By default, this method calls {@link
44545
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  1575
         * #getLogger(java.lang.String, java.lang.Module)
37672
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1576
         * this.getLogger(name, module)} to obtain a logger, then wraps that
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1577
         * logger in a {@link Logger} instance where all methods that do not
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1578
         * take a {@link ResourceBundle} as parameter are redirected to one
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1579
         * which does - passing the given {@code bundle} for
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1580
         * localization. So for instance, a call to {@link
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1581
         * Logger#log(Logger.Level, String) Logger.log(Level.INFO, msg)}
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1582
         * will end up as a call to {@link
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1583
         * Logger#log(Logger.Level, ResourceBundle, String, Object...)
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1584
         * Logger.log(Level.INFO, bundle, msg, (Object[])null)} on the wrapped
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1585
         * logger instance.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1586
         * Note however that by default, string messages returned by {@link
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1587
         * java.util.function.Supplier Supplier&lt;String&gt;} will not be
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1588
         * localized, as it is assumed that such strings are messages which are
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1589
         * already constructed, rather than keys in a resource bundle.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1590
         * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1591
         * An implementation of {@code LoggerFinder} may override this method,
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1592
         * for example, when the underlying logging backend provides its own
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1593
         * mechanism for localizing log messages, then such a
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1594
         * {@code LoggerFinder} would be free to return a logger
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1595
         * that makes direct use of the mechanism provided by the backend.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1596
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1597
         * @param name    the name of the logger.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1598
         * @param bundle  a resource bundle; can be {@code null}.
37672
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1599
         * @param module  the module for which the logger is being requested.
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1600
         * @return an instance of {@link Logger Logger}  which will use the
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1601
         * provided resource bundle for message localization.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1602
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1603
         * @throws NullPointerException if {@code name} is {@code null} or
37672
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1604
         *         {@code module} is {@code null}.
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1605
         * @throws SecurityException if a security manager is present and its
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1606
         *         {@code checkPermission} method doesn't allow the
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1607
         *         {@code RuntimePermission("loggerFinder")}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1608
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1609
        public Logger getLocalizedLogger(String name, ResourceBundle bundle,
37672
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1610
                                         Module module) {
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1611
            return new LocalizedLoggerWrapper<>(getLogger(name, module), bundle);
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1612
        }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1613
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1614
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1615
         * Returns the {@code LoggerFinder} instance. There is one
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1616
         * single system-wide {@code LoggerFinder} instance in
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1617
         * the Java Runtime.  See the class specification of how the
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1618
         * {@link LoggerFinder LoggerFinder} implementation is located and
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1619
         * loaded.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1620
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1621
         * @return the {@link LoggerFinder LoggerFinder} instance.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1622
         * @throws SecurityException if a security manager is present and its
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1623
         *         {@code checkPermission} method doesn't allow the
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1624
         *         {@code RuntimePermission("loggerFinder")}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1625
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1626
        public static LoggerFinder getLoggerFinder() {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1627
            final SecurityManager sm = System.getSecurityManager();
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1628
            if (sm != null) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1629
                sm.checkPermission(LOGGERFINDER_PERMISSION);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1630
            }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1631
            return accessProvider();
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1632
        }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1633
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1634
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1635
        private static volatile LoggerFinder service;
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1636
        static LoggerFinder accessProvider() {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1637
            // We do not need to synchronize: LoggerFinderLoader will
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1638
            // always return the same instance, so if we don't have it,
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1639
            // just fetch it again.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1640
            if (service == null) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1641
                PrivilegedAction<LoggerFinder> pa =
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1642
                        () -> LoggerFinderLoader.getLoggerFinder();
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1643
                service = AccessController.doPrivileged(pa, null,
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1644
                        LOGGERFINDER_PERMISSION);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1645
            }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1646
            return service;
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1647
        }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1648
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1649
    }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1650
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1651
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1652
    /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1653
     * Returns an instance of {@link Logger Logger} for the caller's
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1654
     * use.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1655
     *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1656
     * @implSpec
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1657
     * Instances returned by this method route messages to loggers
37672
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1658
     * obtained by calling {@link LoggerFinder#getLogger(java.lang.String,
44545
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  1659
     * java.lang.Module) LoggerFinder.getLogger(name, module)}, where
37672
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1660
     * {@code module} is the caller's module.
44416
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1661
     * In cases where {@code System.getLogger} is called from a context where
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1662
     * there is no caller frame on the stack (e.g when called directly
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1663
     * from a JNI attached thread), {@code IllegalCallerException} is thrown.
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1664
     * To obtain a logger in such a context, use an auxiliary class that will
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1665
     * implicitly be identified as the caller, or use the system {@link
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1666
     * LoggerFinder#getLoggerFinder() LoggerFinder} to obtain a logger instead.
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1667
     * Note that doing the latter may eagerly initialize the underlying
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1668
     * logging system.
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1669
     *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1670
     * @apiNote
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1671
     * This method may defer calling the {@link
44545
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  1672
     * LoggerFinder#getLogger(java.lang.String, java.lang.Module)
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1673
     * LoggerFinder.getLogger} method to create an actual logger supplied by
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1674
     * the logging backend, for instance, to allow loggers to be obtained during
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1675
     * the system initialization time.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1676
     *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1677
     * @param name the name of the logger.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1678
     * @return an instance of {@link Logger} that can be used by the calling
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1679
     *         class.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1680
     * @throws NullPointerException if {@code name} is {@code null}.
44416
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1681
     * @throws IllegalCallerException if there is no Java caller frame on the
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1682
     *         stack.
34933
09a3dab8e1f9 8146691: @since 9 tag missing for System.getLogger
dfuchs
parents: 34882
diff changeset
  1683
     *
09a3dab8e1f9 8146691: @since 9 tag missing for System.getLogger
dfuchs
parents: 34882
diff changeset
  1684
     * @since 9
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1685
     */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1686
    @CallerSensitive
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1687
    public static Logger getLogger(String name) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1688
        Objects.requireNonNull(name);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1689
        final Class<?> caller = Reflection.getCallerClass();
44416
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1690
        if (caller == null) {
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1691
            throw new IllegalCallerException("no caller frame");
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1692
        }
37672
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1693
        return LazyLoggers.getLogger(name, caller.getModule());
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1694
    }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1695
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1696
    /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1697
     * Returns a localizable instance of {@link Logger
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1698
     * Logger} for the caller's use.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1699
     * The returned logger will use the provided resource bundle for message
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1700
     * localization.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1701
     *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1702
     * @implSpec
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1703
     * The returned logger will perform message localization as specified
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1704
     * by {@link LoggerFinder#getLocalizedLogger(java.lang.String,
44545
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  1705
     * java.util.ResourceBundle, java.lang.Module)
44416
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1706
     * LoggerFinder.getLocalizedLogger(name, bundle, module)}, where
37672
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1707
     * {@code module} is the caller's module.
44416
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1708
     * In cases where {@code System.getLogger} is called from a context where
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1709
     * there is no caller frame on the stack (e.g when called directly
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1710
     * from a JNI attached thread), {@code IllegalCallerException} is thrown.
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1711
     * To obtain a logger in such a context, use an auxiliary class that
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1712
     * will implicitly be identified as the caller, or use the system {@link
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1713
     * LoggerFinder#getLoggerFinder() LoggerFinder} to obtain a logger instead.
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1714
     * Note that doing the latter may eagerly initialize the underlying
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1715
     * logging system.
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1716
     *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1717
     * @apiNote
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1718
     * This method is intended to be used after the system is fully initialized.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1719
     * This method may trigger the immediate loading and initialization
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1720
     * of the {@link LoggerFinder} service, which may cause issues if the
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1721
     * Java Runtime is not ready to initialize the concrete service
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1722
     * implementation yet.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1723
     * System classes which may be loaded early in the boot sequence and
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1724
     * need to log localized messages should create a logger using
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1725
     * {@link #getLogger(java.lang.String)} and then use the log methods that
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1726
     * take a resource bundle as parameter.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1727
     *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1728
     * @param name    the name of the logger.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1729
     * @param bundle  a resource bundle.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1730
     * @return an instance of {@link Logger} which will use the provided
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1731
     * resource bundle for message localization.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1732
     * @throws NullPointerException if {@code name} is {@code null} or
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1733
     *         {@code bundle} is {@code null}.
44416
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1734
     * @throws IllegalCallerException if there is no Java caller frame on the
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1735
     *         stack.
34933
09a3dab8e1f9 8146691: @since 9 tag missing for System.getLogger
dfuchs
parents: 34882
diff changeset
  1736
     *
09a3dab8e1f9 8146691: @since 9 tag missing for System.getLogger
dfuchs
parents: 34882
diff changeset
  1737
     * @since 9
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1738
     */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1739
    @CallerSensitive
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1740
    public static Logger getLogger(String name, ResourceBundle bundle) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1741
        final ResourceBundle rb = Objects.requireNonNull(bundle);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1742
        Objects.requireNonNull(name);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1743
        final Class<?> caller = Reflection.getCallerClass();
44416
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1744
        if (caller == null) {
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1745
            throw new IllegalCallerException("no caller frame");
2b02517c73a2 8177136: Caller sensitive method System::getLogger should specify what happens if there is no caller on the stack.
dfuchs
parents: 44359
diff changeset
  1746
        }
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1747
        final SecurityManager sm = System.getSecurityManager();
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1748
        // We don't use LazyLoggers if a resource bundle is specified.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1749
        // Bootstrap sensitive classes in the JDK do not use resource bundles
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1750
        // when logging. This could be revisited later, if it needs to.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1751
        if (sm != null) {
37672
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1752
            final PrivilegedAction<Logger> pa =
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1753
                    () -> LoggerFinder.accessProvider()
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1754
                            .getLocalizedLogger(name, rb, caller.getModule());
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1755
            return AccessController.doPrivileged(pa, null,
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1756
                                         LoggerFinder.LOGGERFINDER_PERMISSION);
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1757
        }
37672
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1758
        return LoggerFinder.accessProvider()
03684934dc09 8148568: LoggerFinder.getLogger and LoggerFinder.getLocalizedLogger should take a Module argument instead of a Class.
dfuchs
parents: 37521
diff changeset
  1759
                .getLocalizedLogger(name, rb, caller.getModule());
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1760
    }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1761
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1762
    /**
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1763
     * Terminates the currently running Java Virtual Machine. The
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1764
     * argument serves as a status code; by convention, a nonzero status
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1765
     * code indicates abnormal termination.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1766
     * <p>
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1767
     * This method calls the {@code exit} method in class
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1768
     * {@code Runtime}. This method never returns normally.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1769
     * <p>
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1770
     * The call {@code System.exit(n)} is effectively equivalent to
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1771
     * the call:
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1772
     * <blockquote><pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1773
     * Runtime.getRuntime().exit(n)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1774
     * </pre></blockquote>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1775
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1776
     * @param      status   exit status.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1777
     * @throws  SecurityException
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1778
     *        if a security manager exists and its {@code checkExit}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1779
     *        method doesn't allow exit with the specified status.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1780
     * @see        java.lang.Runtime#exit(int)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1781
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1782
    public static void exit(int status) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1783
        Runtime.getRuntime().exit(status);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1784
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1785
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1786
    /**
55231
02db50f278f9 8220238: Enhancing j.l.Runtime/System::gc specification with an explicit 'no guarantee' statement
rriggs
parents: 53160
diff changeset
  1787
     * Runs the garbage collector in the Java Virtual Machine.
02db50f278f9 8220238: Enhancing j.l.Runtime/System::gc specification with an explicit 'no guarantee' statement
rriggs
parents: 53160
diff changeset
  1788
     * <p>
02db50f278f9 8220238: Enhancing j.l.Runtime/System::gc specification with an explicit 'no guarantee' statement
rriggs
parents: 53160
diff changeset
  1789
     * Calling the {@code gc} method suggests that the Java Virtual Machine
02db50f278f9 8220238: Enhancing j.l.Runtime/System::gc specification with an explicit 'no guarantee' statement
rriggs
parents: 53160
diff changeset
  1790
     * expend effort toward recycling unused objects in order to
02db50f278f9 8220238: Enhancing j.l.Runtime/System::gc specification with an explicit 'no guarantee' statement
rriggs
parents: 53160
diff changeset
  1791
     * make the memory they currently occupy available for reuse
02db50f278f9 8220238: Enhancing j.l.Runtime/System::gc specification with an explicit 'no guarantee' statement
rriggs
parents: 53160
diff changeset
  1792
     * by the Java Virtual Machine.
02db50f278f9 8220238: Enhancing j.l.Runtime/System::gc specification with an explicit 'no guarantee' statement
rriggs
parents: 53160
diff changeset
  1793
     * When control returns from the method call, the Java Virtual Machine
02db50f278f9 8220238: Enhancing j.l.Runtime/System::gc specification with an explicit 'no guarantee' statement
rriggs
parents: 53160
diff changeset
  1794
     * has made a best effort to reclaim space from all unused objects.
02db50f278f9 8220238: Enhancing j.l.Runtime/System::gc specification with an explicit 'no guarantee' statement
rriggs
parents: 53160
diff changeset
  1795
     * There is no guarantee that this effort will recycle any particular
02db50f278f9 8220238: Enhancing j.l.Runtime/System::gc specification with an explicit 'no guarantee' statement
rriggs
parents: 53160
diff changeset
  1796
     * number of unused objects, reclaim any particular amount of space, or
02db50f278f9 8220238: Enhancing j.l.Runtime/System::gc specification with an explicit 'no guarantee' statement
rriggs
parents: 53160
diff changeset
  1797
     * complete at any particular time, if at all, before the method returns or ever.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1798
     * <p>
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1799
     * The call {@code System.gc()} is effectively equivalent to the
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1800
     * call:
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1801
     * <blockquote><pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1802
     * Runtime.getRuntime().gc()
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1803
     * </pre></blockquote>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1804
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1805
     * @see     java.lang.Runtime#gc()
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1806
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1807
    public static void gc() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1808
        Runtime.getRuntime().gc();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1809
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1810
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1811
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1812
     * Runs the finalization methods of any objects pending finalization.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1813
     *
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1814
     * Calling this method suggests that the Java Virtual Machine expend
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1815
     * effort toward running the {@code finalize} methods of objects
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1816
     * that have been found to be discarded but whose {@code finalize}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1817
     * methods have not yet been run. When control returns from the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1818
     * method call, the Java Virtual Machine has made a best effort to
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1819
     * complete all outstanding finalizations.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1820
     * <p>
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1821
     * The call {@code System.runFinalization()} is effectively
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1822
     * equivalent to the call:
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1823
     * <blockquote><pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1824
     * Runtime.getRuntime().runFinalization()
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1825
     * </pre></blockquote>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1826
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1827
     * @see     java.lang.Runtime#runFinalization()
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1828
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1829
    public static void runFinalization() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1830
        Runtime.getRuntime().runFinalization();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1831
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1832
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1833
    /**
16479
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1834
     * Loads the native library specified by the filename argument.  The filename
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1835
     * argument must be an absolute path name.
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1836
     *
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1837
     * If the filename argument, when stripped of any platform-specific library
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1838
     * prefix, path, and file extension, indicates a library whose name is,
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1839
     * for example, L, and a native library called L is statically linked
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1840
     * with the VM, then the JNI_OnLoad_L function exported by the library
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1841
     * is invoked rather than attempting to load a dynamic library.
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1842
     * A filename matching the argument does not have to exist in the
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1843
     * file system.
47707
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents: 47476
diff changeset
  1844
     * See the <a href="{@docRoot}/../specs/jni/index.html"> JNI Specification</a>
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents: 47476
diff changeset
  1845
     * for more details.
16479
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1846
     *
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1847
     * Otherwise, the filename argument is mapped to a native library image in
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1848
     * an implementation-dependent manner.
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1849
     *
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1850
     * <p>
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1851
     * The call {@code System.load(name)} is effectively equivalent
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1852
     * to the call:
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1853
     * <blockquote><pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1854
     * Runtime.getRuntime().load(name)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1855
     * </pre></blockquote>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1856
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1857
     * @param      filename   the file to load.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1858
     * @throws     SecurityException  if a security manager exists and its
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1859
     *             {@code checkLink} method doesn't allow
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1860
     *             loading of the specified dynamic library
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1861
     * @throws     UnsatisfiedLinkError  if either the filename is not an
16479
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1862
     *             absolute path name, the native library is not statically
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1863
     *             linked with the VM, or the library cannot be mapped to
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1864
     *             a native library image by the host system.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1865
     * @throws     NullPointerException if {@code filename} is {@code null}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1866
     * @see        java.lang.Runtime#load(java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1867
     * @see        java.lang.SecurityManager#checkLink(java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1868
     */
16906
44dfee24cb71 8010117: Annotate jdk caller sensitive methods with @sun.reflect.CallerSensitive
mchung
parents: 16479
diff changeset
  1869
    @CallerSensitive
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1870
    public static void load(String filename) {
16906
44dfee24cb71 8010117: Annotate jdk caller sensitive methods with @sun.reflect.CallerSensitive
mchung
parents: 16479
diff changeset
  1871
        Runtime.getRuntime().load0(Reflection.getCallerClass(), filename);
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1872
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1873
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1874
    /**
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1875
     * Loads the native library specified by the {@code libname}
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1876
     * argument.  The {@code libname} argument must not contain any platform
16479
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1877
     * specific prefix, file extension or path. If a native library
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1878
     * called {@code libname} is statically linked with the VM, then the
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1879
     * JNI_OnLoad_{@code libname} function exported by the library is invoked.
47707
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents: 47476
diff changeset
  1880
     * See the <a href="{@docRoot}/../specs/jni/index.html"> JNI Specification</a>
67aa34b019e1 8164512: Replace ClassLoader use of finalizer with phantom reference to unload native library
mchung
parents: 47476
diff changeset
  1881
     * for more details.
16479
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1882
     *
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1883
     * Otherwise, the libname argument is loaded from a system library
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1884
     * location and mapped to a native library image in an implementation-
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1885
     * dependent manner.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1886
     * <p>
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1887
     * The call {@code System.loadLibrary(name)} is effectively
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1888
     * equivalent to the call
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1889
     * <blockquote><pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1890
     * Runtime.getRuntime().loadLibrary(name)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1891
     * </pre></blockquote>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1892
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1893
     * @param      libname   the name of the library.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1894
     * @throws     SecurityException  if a security manager exists and its
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1895
     *             {@code checkLink} method doesn't allow
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1896
     *             loading of the specified dynamic library
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1897
     * @throws     UnsatisfiedLinkError if either the libname argument
16479
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1898
     *             contains a file path, the native library is not statically
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1899
     *             linked with the VM,  or the library cannot be mapped to a
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1900
     *             native library image by the host system.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1901
     * @throws     NullPointerException if {@code libname} is {@code null}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1902
     * @see        java.lang.Runtime#loadLibrary(java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1903
     * @see        java.lang.SecurityManager#checkLink(java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1904
     */
16906
44dfee24cb71 8010117: Annotate jdk caller sensitive methods with @sun.reflect.CallerSensitive
mchung
parents: 16479
diff changeset
  1905
    @CallerSensitive
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1906
    public static void loadLibrary(String libname) {
16906
44dfee24cb71 8010117: Annotate jdk caller sensitive methods with @sun.reflect.CallerSensitive
mchung
parents: 16479
diff changeset
  1907
        Runtime.getRuntime().loadLibrary0(Reflection.getCallerClass(), libname);
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1908
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1909
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1910
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1911
     * Maps a library name into a platform-specific string representing
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1912
     * a native library.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1913
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1914
     * @param      libname the name of the library.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1915
     * @return     a platform-dependent native library name.
49203
3a225d9cabe1 8199420: Update javadoc tags in java.lang.System and related
rriggs
parents: 49001
diff changeset
  1916
     * @throws     NullPointerException if {@code libname} is {@code null}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1917
     * @see        java.lang.System#loadLibrary(java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1918
     * @see        java.lang.ClassLoader#findLibrary(java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1919
     * @since      1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1920
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1921
    public static native String mapLibraryName(String libname);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1922
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1923
    /**
11906
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1924
     * Create PrintStream for stdout/err based on encoding.
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1925
     */
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1926
    private static PrintStream newPrintStream(FileOutputStream fos, String enc) {
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1927
       if (enc != null) {
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1928
            try {
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1929
                return new PrintStream(new BufferedOutputStream(fos, 128), true, enc);
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1930
            } catch (UnsupportedEncodingException uee) {}
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1931
        }
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1932
        return new PrintStream(new BufferedOutputStream(fos, 128), true);
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1933
    }
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1934
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1935
    /**
44359
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1936
     * Logs an exception/error at initialization time to stdout or stderr.
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1937
     *
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1938
     * @param printToStderr to print to stderr rather than stdout
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1939
     * @param printStackTrace to print the stack trace
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1940
     * @param msg the message to print before the exception, can be {@code null}
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1941
     * @param e the exception or error
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1942
     */
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1943
    private static void logInitException(boolean printToStderr,
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1944
                                         boolean printStackTrace,
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1945
                                         String msg,
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1946
                                         Throwable e) {
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1947
        if (VM.initLevel() < 1) {
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1948
            throw new InternalError("system classes not initialized");
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1949
        }
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1950
        PrintStream log = (printToStderr) ? err : out;
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1951
        if (msg != null) {
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1952
            log.println(msg);
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1953
        }
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1954
        if (printStackTrace) {
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1955
            e.printStackTrace(log);
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1956
        } else {
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1957
            log.println(e);
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1958
            for (Throwable suppressed : e.getSuppressed()) {
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1959
                log.println("Suppressed: " + suppressed);
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1960
            }
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1961
            Throwable cause = e.getCause();
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1962
            if (cause != null) {
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1963
                log.println("Caused by: " + cause);
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1964
            }
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1965
        }
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1966
    }
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1967
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  1968
    /**
52978
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1969
     * Create the Properties object from a map - masking out system properties
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1970
     * that are not intended for public access.
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1971
     */
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1972
    private static Properties createProperties(Map<String, String> initialProps) {
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1973
        Properties properties = new Properties(initialProps.size());
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1974
        for (var entry : initialProps.entrySet()) {
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1975
            String prop = entry.getKey();
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1976
            switch (prop) {
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1977
                // Do not add private system properties to the Properties
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1978
                case "sun.nio.MaxDirectMemorySize":
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1979
                case "sun.nio.PageAlignDirectMemory":
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1980
                    // used by java.lang.Integer.IntegerCache
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1981
                case "java.lang.Integer.IntegerCache.high":
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1982
                    // used by sun.launcher.LauncherHelper
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1983
                case "sun.java.launcher.diag":
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1984
                    // used by jdk.internal.loader.ClassLoaders
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1985
                case "jdk.boot.class.path.append":
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1986
                    break;
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1987
                default:
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1988
                    properties.put(prop, entry.getValue());
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1989
            }
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1990
        }
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1991
        return properties;
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1992
    }
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1993
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  1994
    /**
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1995
     * Initialize the system class.  Called after thread initialization.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1996
     */
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  1997
    private static void initPhase1() {
8399
0a7dab5d5922 6999337: java.exe fails to start if some directory names in path to java binaries contain Russian characters
sherman
parents: 7668
diff changeset
  1998
        // VM might invoke JNU_NewStringPlatform() to set those encoding
0a7dab5d5922 6999337: java.exe fails to start if some directory names in path to java binaries contain Russian characters
sherman
parents: 7668
diff changeset
  1999
        // sensitive properties (user.home, user.name, boot.class.path, etc.)
52724
0bdbf854472f 4947890: Minimize JNI upcalls in system-properties initialization
rriggs
parents: 52615
diff changeset
  2000
        // during "props" initialization.
0bdbf854472f 4947890: Minimize JNI upcalls in system-properties initialization
rriggs
parents: 52615
diff changeset
  2001
        // The charset is initialized in System.c and does not depend on the Properties.
52978
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  2002
        Map<String, String> tempProps = SystemProps.initProperties();
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  2003
        VersionProps.init(tempProps);
8399
0a7dab5d5922 6999337: java.exe fails to start if some directory names in path to java binaries contain Russian characters
sherman
parents: 7668
diff changeset
  2004
6882
637546039be3 6977738: Deadlock between java.lang.ClassLoader and java.util.Properties
mchung
parents: 6668
diff changeset
  2005
        // There are certain system configurations that may be controlled by
637546039be3 6977738: Deadlock between java.lang.ClassLoader and java.util.Properties
mchung
parents: 6668
diff changeset
  2006
        // VM options such as the maximum amount of direct memory and
637546039be3 6977738: Deadlock between java.lang.ClassLoader and java.util.Properties
mchung
parents: 6668
diff changeset
  2007
        // Integer cache size used to support the object identity semantics
637546039be3 6977738: Deadlock between java.lang.ClassLoader and java.util.Properties
mchung
parents: 6668
diff changeset
  2008
        // of autoboxing.  Typically, the library will obtain these values
637546039be3 6977738: Deadlock between java.lang.ClassLoader and java.util.Properties
mchung
parents: 6668
diff changeset
  2009
        // from the properties set by the VM.  If the properties are for
637546039be3 6977738: Deadlock between java.lang.ClassLoader and java.util.Properties
mchung
parents: 6668
diff changeset
  2010
        // internal implementation use only, these properties should be
52978
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  2011
        // masked from the system properties.
8399
0a7dab5d5922 6999337: java.exe fails to start if some directory names in path to java binaries contain Russian characters
sherman
parents: 7668
diff changeset
  2012
        //
0a7dab5d5922 6999337: java.exe fails to start if some directory names in path to java binaries contain Russian characters
sherman
parents: 7668
diff changeset
  2013
        // Save a private copy of the system properties object that
52978
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  2014
        // can only be accessed by the internal implementation.
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  2015
        VM.saveProperties(tempProps);
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  2016
        props = createProperties(tempProps);
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  2017
95efb32d390b 8215159: Improve initial setup of system Properties
redestad
parents: 52902
diff changeset
  2018
        StaticProperty.javaHome();          // Load StaticProperty to cache the property values
8399
0a7dab5d5922 6999337: java.exe fails to start if some directory names in path to java binaries contain Russian characters
sherman
parents: 7668
diff changeset
  2019
4355
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
  2020
        lineSeparator = props.getProperty("line.separator");
2425
99a19a90813e 6807702: Integer.valueOf cache should be configurable
alanb
parents: 2288
diff changeset
  2021
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2022
        FileInputStream fdIn = new FileInputStream(FileDescriptor.in);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2023
        FileOutputStream fdOut = new FileOutputStream(FileDescriptor.out);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2024
        FileOutputStream fdErr = new FileOutputStream(FileDescriptor.err);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2025
        setIn0(new BufferedInputStream(fdIn));
11906
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  2026
        setOut0(newPrintStream(fdOut, props.getProperty("sun.stdout.encoding")));
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  2027
        setErr0(newPrintStream(fdErr, props.getProperty("sun.stderr.encoding")));
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  2028
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2029
        // Setup Java signal handlers for HUP, TERM, and INT (where available).
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2030
        Terminator.setup();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2031
25979
42e5d9f8087e 8054857: Fix typos in java.lang.** packages
prappo
parents: 25660
diff changeset
  2032
        // Initialize any miscellaneous operating system settings that need to be
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2033
        // set for the class libraries. Currently this is no-op everywhere except
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2034
        // for Windows where the process-wide error mode is set before the java.io
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2035
        // classes are used.
34882
ce2a8ec851c1 8145544: Move sun.misc.VM to jdk.internal.misc
chegar
parents: 34774
diff changeset
  2036
        VM.initializeOSEnvironment();
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2037
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2038
        // The main thread is not added to its thread group in the same
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2039
        // way as other threads; we must do it ourselves here.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2040
        Thread current = Thread.currentThread();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2041
        current.getThreadGroup().add(current);
6668
bf6309ced0b6 6888546: restore System.initializeSystemClasses
mchung
parents: 6001
diff changeset
  2042
bf6309ced0b6 6888546: restore System.initializeSystemClasses
mchung
parents: 6001
diff changeset
  2043
        // register shared secrets
bf6309ced0b6 6888546: restore System.initializeSystemClasses
mchung
parents: 6001
diff changeset
  2044
        setJavaLangAccess();
12038
ba8cfc6c5118 7149320: Move sun.misc.VM.booted() to the end of System.initializeSystemClass()
mduigou
parents: 11906
diff changeset
  2045
58574
dcc760954243 8231584: Deadlock with ClassLoader.findLibrary and System.loadLibrary call
akozlov
parents: 57792
diff changeset
  2046
        ClassLoader.initLibraryPaths();
dcc760954243 8231584: Deadlock with ClassLoader.findLibrary and System.loadLibrary call
akozlov
parents: 57792
diff changeset
  2047
12038
ba8cfc6c5118 7149320: Move sun.misc.VM.booted() to the end of System.initializeSystemClass()
mduigou
parents: 11906
diff changeset
  2048
        // Subsystems that are invoked during initialization can invoke
34882
ce2a8ec851c1 8145544: Move sun.misc.VM to jdk.internal.misc
chegar
parents: 34774
diff changeset
  2049
        // VM.isBooted() in order to avoid doing things that should
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2050
        // wait until the VM is fully initialized. The initialization level
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2051
        // is incremented from 0 to 1 here to indicate the first phase of
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2052
        // initialization has completed.
12038
ba8cfc6c5118 7149320: Move sun.misc.VM.booted() to the end of System.initializeSystemClass()
mduigou
parents: 11906
diff changeset
  2053
        // IMPORTANT: Ensure that this remains the last initialization action!
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2054
        VM.initLevel(1);
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2055
    }
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2056
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2057
    // @see #initPhase2()
44545
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2058
    static ModuleLayer bootLayer;
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2059
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2060
    /*
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2061
     * Invoked by VM.  Phase 2 module system initialization.
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2062
     * Only classes in java.base can be loaded in this phase.
44359
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  2063
     *
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  2064
     * @param printToStderr print exceptions to stderr rather than stdout
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  2065
     * @param printStackTrace print stack trace when exception occurs
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  2066
     *
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  2067
     * @return JNI_OK for success, JNI_ERR for failure
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2068
     */
44359
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  2069
    private static int initPhase2(boolean printToStderr, boolean printStackTrace) {
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  2070
        try {
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  2071
            bootLayer = ModuleBootstrap.boot();
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  2072
        } catch (Exception | Error e) {
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  2073
            logInitException(printToStderr, printStackTrace,
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  2074
                             "Error occurred during initialization of boot layer", e);
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  2075
            return -1; // JNI_ERR
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  2076
        }
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2077
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2078
        // module system initialized
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2079
        VM.initLevel(2);
44359
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  2080
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  2081
        return 0; // JNI_OK
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2082
    }
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2083
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2084
    /*
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2085
     * Invoked by VM.  Phase 3 is the final system initialization:
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2086
     * 1. set security manager
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2087
     * 2. set system class loader
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2088
     * 3. set TCCL
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2089
     *
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2090
     * This method must be called after the module system initialization.
52084
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2091
     * The security manager and system class loader may be a custom class from
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2092
     * the application classpath or modulepath.
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2093
     */
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2094
    private static void initPhase3() {
52084
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2095
        String smProp = System.getProperty("java.security.manager");
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2096
        if (smProp != null) {
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2097
            switch (smProp) {
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2098
                case "disallow":
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2099
                    allowSecurityManager = NEVER;
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2100
                    break;
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2101
                case "allow":
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2102
                    allowSecurityManager = MAYBE;
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2103
                    break;
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2104
                case "":
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2105
                case "default":
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2106
                    setSecurityManager(new SecurityManager());
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2107
                    allowSecurityManager = MAYBE;
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2108
                    break;
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2109
                default:
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2110
                    try {
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2111
                        ClassLoader cl = ClassLoader.getBuiltinAppClassLoader();
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2112
                        Class<?> c = Class.forName(smProp, false, cl);
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2113
                        Constructor<?> ctor = c.getConstructor();
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2114
                        // Must be a public subclass of SecurityManager with
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2115
                        // a public no-arg constructor
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2116
                        if (!SecurityManager.class.isAssignableFrom(c) ||
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2117
                            !Modifier.isPublic(c.getModifiers()) ||
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2118
                            !Modifier.isPublic(ctor.getModifiers())) {
52084
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2119
                            throw new Error("Could not create SecurityManager: "
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2120
                                             + ctor.toString());
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2121
                        }
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2122
                        // custom security manager may be in non-exported package
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2123
                        ctor.setAccessible(true);
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2124
                        SecurityManager sm = (SecurityManager) ctor.newInstance();
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2125
                        setSecurityManager(sm);
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2126
                    } catch (Exception e) {
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2127
                        throw new InternalError("Could not create SecurityManager", e);
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2128
                    }
52084
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2129
                    allowSecurityManager = MAYBE;
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2130
            }
52084
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2131
        } else {
ec4f2762b234 8191053: Provide a mechanism to make system's security manager immutable
mullan
parents: 51772
diff changeset
  2132
            allowSecurityManager = MAYBE;
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2133
        }
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2134
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2135
        // initializing the system class loader
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2136
        VM.initLevel(3);
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2137
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2138
        // system class loader initialized
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2139
        ClassLoader scl = ClassLoader.initSystemClassLoader();
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2140
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2141
        // set TCCL
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2142
        Thread.currentThread().setContextClassLoader(scl);
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2143
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2144
        // system is fully initialized
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2145
        VM.initLevel(4);
3111
fefdeafb7ab9 6797688: Umbrella: Merge all JDK 6u4 - 6u12 deployment code into JDK7
herrick
parents: 2703
diff changeset
  2146
    }
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2147
3111
fefdeafb7ab9 6797688: Umbrella: Merge all JDK 6u4 - 6u12 deployment code into JDK7
herrick
parents: 2703
diff changeset
  2148
    private static void setJavaLangAccess() {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2149
        // Allow privileged classes outside of java.lang
42338
a60f280f803c 8169069: Module system implementation refresh (11/2016)
alanb
parents: 40261
diff changeset
  2150
        SharedSecrets.setJavaLangAccess(new JavaLangAccess() {
45652
33342314ce89 8181087: Module system implementation refresh (6/2017)
alanb
parents: 45124
diff changeset
  2151
            public List<Method> getDeclaredPublicMethods(Class<?> klass, String name, Class<?>... parameterTypes) {
33342314ce89 8181087: Module system implementation refresh (6/2017)
alanb
parents: 45124
diff changeset
  2152
                return klass.getDeclaredPublicMethods(name, parameterTypes);
42338
a60f280f803c 8169069: Module system implementation refresh (11/2016)
alanb
parents: 40261
diff changeset
  2153
            }
37363
329dba26ffd2 8137058: Clear out all non-Critical APIs from sun.reflect
chegar
parents: 36972
diff changeset
  2154
            public jdk.internal.reflect.ConstantPool getConstantPool(Class<?> klass) {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2155
                return klass.getConstantPool();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2156
            }
18827
ecbd9c8bef12 7122142: (ann) Race condition between isAnnotationPresent and getAnnotations
plevart
parents: 18546
diff changeset
  2157
            public boolean casAnnotationType(Class<?> klass, AnnotationType oldType, AnnotationType newType) {
ecbd9c8bef12 7122142: (ann) Race condition between isAnnotationPresent and getAnnotations
plevart
parents: 18546
diff changeset
  2158
                return klass.casAnnotationType(oldType, newType);
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2159
            }
11117
b6e68b1344d4 7116404: Miscellaneous warnings (java.rmi.**, serialization, some core classes)
alanb
parents: 10360
diff changeset
  2160
            public AnnotationType getAnnotationType(Class<?> klass) {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2161
                return klass.getAnnotationType();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2162
            }
21358
d41ff832d4f6 8027170: Annotations declared on super-super-class should be overridden by super-class.
alundblad
parents: 20831
diff changeset
  2163
            public Map<Class<? extends Annotation>, Annotation> getDeclaredAnnotationMap(Class<?> klass) {
d41ff832d4f6 8027170: Annotations declared on super-super-class should be overridden by super-class.
alundblad
parents: 20831
diff changeset
  2164
                return klass.getDeclaredAnnotationMap();
d41ff832d4f6 8027170: Annotations declared on super-super-class should be overridden by super-class.
alundblad
parents: 20831
diff changeset
  2165
            }
18827
ecbd9c8bef12 7122142: (ann) Race condition between isAnnotationPresent and getAnnotations
plevart
parents: 18546
diff changeset
  2166
            public byte[] getRawClassAnnotations(Class<?> klass) {
ecbd9c8bef12 7122142: (ann) Race condition between isAnnotationPresent and getAnnotations
plevart
parents: 18546
diff changeset
  2167
                return klass.getRawAnnotations();
ecbd9c8bef12 7122142: (ann) Race condition between isAnnotationPresent and getAnnotations
plevart
parents: 18546
diff changeset
  2168
            }
15510
898d924a7efd 8004698: Implement Core Reflection for Type Annotations
jfranck
parents: 14676
diff changeset
  2169
            public byte[] getRawClassTypeAnnotations(Class<?> klass) {
898d924a7efd 8004698: Implement Core Reflection for Type Annotations
jfranck
parents: 14676
diff changeset
  2170
                return klass.getRawTypeAnnotations();
898d924a7efd 8004698: Implement Core Reflection for Type Annotations
jfranck
parents: 14676
diff changeset
  2171
            }
898d924a7efd 8004698: Implement Core Reflection for Type Annotations
jfranck
parents: 14676
diff changeset
  2172
            public byte[] getRawExecutableTypeAnnotations(Executable executable) {
898d924a7efd 8004698: Implement Core Reflection for Type Annotations
jfranck
parents: 14676
diff changeset
  2173
                return Class.getExecutableTypeAnnotationBytes(executable);
898d924a7efd 8004698: Implement Core Reflection for Type Annotations
jfranck
parents: 14676
diff changeset
  2174
            }
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2175
            public <E extends Enum<E>>
45652
33342314ce89 8181087: Module system implementation refresh (6/2017)
alanb
parents: 45124
diff changeset
  2176
            E[] getEnumConstantsShared(Class<E> klass) {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2177
                return klass.getEnumConstantsShared();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2178
            }
49001
ce06058197a4 8198562: (ch) Separate blocking and non-blocking code paths (part 1)
alanb
parents: 48942
diff changeset
  2179
            public void blockedOn(Interruptible b) {
ce06058197a4 8198562: (ch) Separate blocking and non-blocking code paths (part 1)
alanb
parents: 48942
diff changeset
  2180
                Thread.blockedOn(b);
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2181
            }
2703
acd4d6a53e3e 6829503: addShutdownHook fails if called after shutdown has commenced.
mchung
parents: 2425
diff changeset
  2182
            public void registerShutdownHook(int slot, boolean registerShutdownInProgress, Runnable hook) {
acd4d6a53e3e 6829503: addShutdownHook fails if called after shutdown has commenced.
mchung
parents: 2425
diff changeset
  2183
                Shutdown.add(slot, registerShutdownInProgress, hook);
2277
445a331b4a8b 6810254: Lazily instantiate the shared secret access objects
mchung
parents: 2
diff changeset
  2184
            }
20805
ae41216325dd 8013739: Better LDAP resource management
weijun
parents: 18546
diff changeset
  2185
            public Thread newThreadWithAcc(Runnable target, AccessControlContext acc) {
ae41216325dd 8013739: Better LDAP resource management
weijun
parents: 18546
diff changeset
  2186
                return new Thread(target, acc);
ae41216325dd 8013739: Better LDAP resource management
weijun
parents: 18546
diff changeset
  2187
            }
44534
a076dffbc2c1 8165641: Deprecate Object.finalize
rriggs
parents: 44416
diff changeset
  2188
            @SuppressWarnings("deprecation")
21628
50fd58446d64 8027351: (ref) Private finalize method invoked in preference to protected superclass method
mchung
parents: 21358
diff changeset
  2189
            public void invokeFinalize(Object o) throws Throwable {
50fd58446d64 8027351: (ref) Private finalize method invoked in preference to protected superclass method
mchung
parents: 21358
diff changeset
  2190
                o.finalize();
50fd58446d64 8027351: (ref) Private finalize method invoked in preference to protected superclass method
mchung
parents: 21358
diff changeset
  2191
            }
36972
27147cde3256 8152115: (proxy) Examine performance of dynamic proxy creation
plevart
parents: 36511
diff changeset
  2192
            public ConcurrentHashMap<?, ?> createOrGetClassLoaderValueMap(ClassLoader cl) {
27147cde3256 8152115: (proxy) Examine performance of dynamic proxy creation
plevart
parents: 36511
diff changeset
  2193
                return cl.createOrGetClassLoaderValueMap();
27147cde3256 8152115: (proxy) Examine performance of dynamic proxy creation
plevart
parents: 36511
diff changeset
  2194
            }
44359
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  2195
            public Class<?> defineClass(ClassLoader loader, String name, byte[] b, ProtectionDomain pd, String source) {
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  2196
                return ClassLoader.defineClass1(loader, name, b, 0, b.length, pd, source);
c6761862ca0b 8174823: Module system implementation refresh (3/2017)
alanb
parents: 43813
diff changeset
  2197
            }
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2198
            public Class<?> findBootstrapClassOrNull(ClassLoader cl, String name) {
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2199
                return cl.findBootstrapClassOrNull(name);
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2200
            }
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2201
            public Package definePackage(ClassLoader cl, String name, Module module) {
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2202
                return cl.definePackage(name, module);
9d0388c6b336 8142968: Module System implementation
alanb
parents: 36225
diff changeset
  2203
            }
35707
66cdb7e01a3e 8148936: Adapt UUID.toString() to Compact Strings
shade
parents: 34933
diff changeset
  2204
            public String fastUUID(long lsb, long msb) {
66cdb7e01a3e 8148936: Adapt UUID.toString() to Compact Strings
shade
parents: 34933
diff changeset
  2205
                return Long.fastUUID(lsb, msb);
25660
01fa3ccedf50 8050114: Expose Integer/Long formatUnsigned methods internally
redestad
parents: 24865
diff changeset
  2206
            }
45004
ea3137042a61 8178380: Module system implementation refresh (5/2017)
alanb
parents: 44667
diff changeset
  2207
            public void addNonExportedPackages(ModuleLayer layer) {
ea3137042a61 8178380: Module system implementation refresh (5/2017)
alanb
parents: 44667
diff changeset
  2208
                SecurityManager.addNonExportedPackages(layer);
ea3137042a61 8178380: Module system implementation refresh (5/2017)
alanb
parents: 44667
diff changeset
  2209
            }
43712
5dfd0950317c 8173393: Module system implementation refresh (2/2017)
alanb
parents: 43221
diff changeset
  2210
            public void invalidatePackageAccessCache() {
5dfd0950317c 8173393: Module system implementation refresh (2/2017)
alanb
parents: 43221
diff changeset
  2211
                SecurityManager.invalidatePackageAccessCache();
5dfd0950317c 8173393: Module system implementation refresh (2/2017)
alanb
parents: 43221
diff changeset
  2212
            }
44545
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2213
            public Module defineModule(ClassLoader loader,
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2214
                                       ModuleDescriptor descriptor,
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2215
                                       URI uri) {
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2216
                return new Module(null, loader, descriptor, uri);
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2217
            }
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2218
            public Module defineUnnamedModule(ClassLoader loader) {
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2219
                return new Module(loader);
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2220
            }
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2221
            public void addReads(Module m1, Module m2) {
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2222
                m1.implAddReads(m2);
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2223
            }
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2224
            public void addReadsAllUnnamed(Module m) {
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2225
                m.implAddReadsAllUnnamed();
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2226
            }
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2227
            public void addExports(Module m, String pn, Module other) {
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2228
                m.implAddExports(pn, other);
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2229
            }
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2230
            public void addExportsToAllUnnamed(Module m, String pn) {
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2231
                m.implAddExportsToAllUnnamed(pn);
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2232
            }
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2233
            public void addOpens(Module m, String pn, Module other) {
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2234
                m.implAddOpens(pn, other);
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2235
            }
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2236
            public void addOpensToAllUnnamed(Module m, String pn) {
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2237
                m.implAddOpensToAllUnnamed(pn);
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2238
            }
45652
33342314ce89 8181087: Module system implementation refresh (6/2017)
alanb
parents: 45124
diff changeset
  2239
            public void addOpensToAllUnnamed(Module m, Iterator<String> packages) {
33342314ce89 8181087: Module system implementation refresh (6/2017)
alanb
parents: 45124
diff changeset
  2240
                m.implAddOpensToAllUnnamed(packages);
33342314ce89 8181087: Module system implementation refresh (6/2017)
alanb
parents: 45124
diff changeset
  2241
            }
44545
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2242
            public void addUses(Module m, Class<?> service) {
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2243
                m.implAddUses(service);
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2244
            }
45652
33342314ce89 8181087: Module system implementation refresh (6/2017)
alanb
parents: 45124
diff changeset
  2245
            public boolean isReflectivelyExported(Module m, String pn, Module other) {
33342314ce89 8181087: Module system implementation refresh (6/2017)
alanb
parents: 45124
diff changeset
  2246
                return m.isReflectivelyExported(pn, other);
33342314ce89 8181087: Module system implementation refresh (6/2017)
alanb
parents: 45124
diff changeset
  2247
            }
33342314ce89 8181087: Module system implementation refresh (6/2017)
alanb
parents: 45124
diff changeset
  2248
            public boolean isReflectivelyOpened(Module m, String pn, Module other) {
33342314ce89 8181087: Module system implementation refresh (6/2017)
alanb
parents: 45124
diff changeset
  2249
                return m.isReflectivelyOpened(pn, other);
33342314ce89 8181087: Module system implementation refresh (6/2017)
alanb
parents: 45124
diff changeset
  2250
            }
44545
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2251
            public ServicesCatalog getServicesCatalog(ModuleLayer layer) {
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2252
                return layer.getServicesCatalog();
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2253
            }
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2254
            public Stream<ModuleLayer> layers(ModuleLayer layer) {
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2255
                return layer.layers();
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2256
            }
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2257
            public Stream<ModuleLayer> layers(ClassLoader loader) {
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2258
                return ModuleLayer.layers(loader);
83b611b88ac8 8177530: Module system implementation refresh (4/2017)
alanb
parents: 44416
diff changeset
  2259
            }
48262
daf3b49f4839 8184947: ZipCoder performance improvements
sherman
parents: 48065
diff changeset
  2260
50820
35f52a3cd6bd 8205058: (fs) Files read/writeString should throw CharacterCodingException instead of IOException with an IllegalArgumentException as cause
joehw
parents: 50817
diff changeset
  2261
            public String newStringNoRepl(byte[] bytes, Charset cs) throws CharacterCodingException  {
50552
7439ceaae8e4 8201276: (fs) Add methods to Files for reading/writing a string from/to a file
joehw
parents: 50531
diff changeset
  2262
                return StringCoding.newStringNoRepl(bytes, cs);
7439ceaae8e4 8201276: (fs) Add methods to Files for reading/writing a string from/to a file
joehw
parents: 50531
diff changeset
  2263
            }
7439ceaae8e4 8201276: (fs) Add methods to Files for reading/writing a string from/to a file
joehw
parents: 50531
diff changeset
  2264
50820
35f52a3cd6bd 8205058: (fs) Files read/writeString should throw CharacterCodingException instead of IOException with an IllegalArgumentException as cause
joehw
parents: 50817
diff changeset
  2265
            public byte[] getBytesNoRepl(String s, Charset cs) throws CharacterCodingException {
50552
7439ceaae8e4 8201276: (fs) Add methods to Files for reading/writing a string from/to a file
joehw
parents: 50531
diff changeset
  2266
                return StringCoding.getBytesNoRepl(s, cs);
7439ceaae8e4 8201276: (fs) Add methods to Files for reading/writing a string from/to a file
joehw
parents: 50531
diff changeset
  2267
            }
7439ceaae8e4 8201276: (fs) Add methods to Files for reading/writing a string from/to a file
joehw
parents: 50531
diff changeset
  2268
48262
daf3b49f4839 8184947: ZipCoder performance improvements
sherman
parents: 48065
diff changeset
  2269
            public String newStringUTF8NoRepl(byte[] bytes, int off, int len) {
daf3b49f4839 8184947: ZipCoder performance improvements
sherman
parents: 48065
diff changeset
  2270
                return StringCoding.newStringUTF8NoRepl(bytes, off, len);
daf3b49f4839 8184947: ZipCoder performance improvements
sherman
parents: 48065
diff changeset
  2271
            }
daf3b49f4839 8184947: ZipCoder performance improvements
sherman
parents: 48065
diff changeset
  2272
daf3b49f4839 8184947: ZipCoder performance improvements
sherman
parents: 48065
diff changeset
  2273
            public byte[] getBytesUTF8NoRepl(String s) {
daf3b49f4839 8184947: ZipCoder performance improvements
sherman
parents: 48065
diff changeset
  2274
                return StringCoding.getBytesUTF8NoRepl(s);
daf3b49f4839 8184947: ZipCoder performance improvements
sherman
parents: 48065
diff changeset
  2275
            }
daf3b49f4839 8184947: ZipCoder performance improvements
sherman
parents: 48065
diff changeset
  2276
51772
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 50820
diff changeset
  2277
            public void setCause(Throwable t, Throwable cause) {
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 50820
diff changeset
  2278
                t.setCause(cause);
5432cebf6627 8210721: Replace legacy serial exception field with Throwable::cause
mchung
parents: 50820
diff changeset
  2279
            }
55693
9a97b1393e72 8227587: Add internal privileged System.loadLibrary
redestad
parents: 55265
diff changeset
  2280
9a97b1393e72 8227587: Add internal privileged System.loadLibrary
redestad
parents: 55265
diff changeset
  2281
            public void loadLibrary(Class<?> caller, String library) {
9a97b1393e72 8227587: Add internal privileged System.loadLibrary
redestad
parents: 55265
diff changeset
  2282
                assert library.indexOf(java.io.File.separatorChar) < 0;
9a97b1393e72 8227587: Add internal privileged System.loadLibrary
redestad
parents: 55265
diff changeset
  2283
                ClassLoader.loadLibrary(caller, library, false);
9a97b1393e72 8227587: Add internal privileged System.loadLibrary
redestad
parents: 55265
diff changeset
  2284
            }
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2285
        });
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2286
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  2287
}