jdk/src/java.base/share/classes/java/lang/System.java
author dfuchs
Fri, 20 Nov 2015 19:26:16 +0100
changeset 33875 c1c71107d45f
parent 32834 e1dca5fe4de3
child 34362 3396ae214e7d
permissions -rw-r--r--
8140364: JEP 264 Platform Logger API and Service Implementation Summary: Initial implementation for JEP 264 Platform Logger API and Service Reviewed-by: mchung, psandoz, rriggs
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
24367
705490680527 8030709: Tidy warnings cleanup for java.lang package; minor cleanup in java.math, javax.script
yan
parents: 21628
diff changeset
     2
 * Copyright (c) 1994, 2014, 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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
import java.io.*;
15510
898d924a7efd 8004698: Implement Core Reflection for Type Annotations
jfranck
parents: 14676
diff changeset
    28
import java.lang.reflect.Executable;
21358
d41ff832d4f6 8027170: Annotations declared on super-super-class should be overridden by super-class.
alundblad
parents: 20831
diff changeset
    29
import java.lang.annotation.Annotation;
20805
ae41216325dd 8013739: Better LDAP resource management
weijun
parents: 18546
diff changeset
    30
import java.security.AccessControlContext;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
import java.util.Properties;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
import java.util.PropertyPermission;
21358
d41ff832d4f6 8027170: Annotations declared on super-super-class should be overridden by super-class.
alundblad
parents: 20831
diff changeset
    33
import java.util.Map;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
import java.security.AccessController;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
import java.security.PrivilegedAction;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
import java.nio.channels.Channel;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
import java.nio.channels.spi.SelectorProvider;
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
    38
import java.util.Objects;
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
    39
import java.util.ResourceBundle;
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
    40
import java.util.function.Supplier;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
import sun.nio.ch.Interruptible;
16906
44dfee24cb71 8010117: Annotate jdk caller sensitive methods with @sun.reflect.CallerSensitive
mchung
parents: 16479
diff changeset
    42
import sun.reflect.CallerSensitive;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
import sun.reflect.Reflection;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
import sun.security.util.SecurityConstants;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
import sun.reflect.annotation.AnnotationType;
31671
362e0c0acece 8076112: Add @HotSpotIntrinsicCandidate annotation to indicate methods for which Java Runtime has intrinsics
zmajo
parents: 29986
diff changeset
    46
import jdk.internal.HotSpotIntrinsicCandidate;
32834
e1dca5fe4de3 8137056: Move SharedSecrets and interface friends out of sun.misc
chegar
parents: 32649
diff changeset
    47
import jdk.internal.misc.JavaLangAccess;;
e1dca5fe4de3 8137056: Move SharedSecrets and interface friends out of sun.misc
chegar
parents: 32649
diff changeset
    48
import jdk.internal.misc.SharedSecrets;;
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
    49
import jdk.internal.logger.LoggerFinderLoader;
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
    50
import jdk.internal.logger.LazyLoggers;
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
    51
import jdk.internal.logger.LocalizedLoggerWrapper;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
 * The <code>System</code> class contains several useful class fields
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
 * and methods. It cannot be instantiated.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
 * <p>Among the facilities provided by the <code>System</code> class
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
 * are standard input, standard output, and error output streams;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
 * access to externally defined properties and environment
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
 * variables; a means of loading files and libraries; and a utility
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
 * method for quickly copying a portion of an array.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
 * @author  unascribed
24865
09b1d992ca72 8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents: 24367
diff changeset
    64
 * @since   1.0
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
public final class System {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
6882
637546039be3 6977738: Deadlock between java.lang.ClassLoader and java.util.Properties
mchung
parents: 6668
diff changeset
    68
    /* register the natives via the static initializer.
637546039be3 6977738: Deadlock between java.lang.ClassLoader and java.util.Properties
mchung
parents: 6668
diff changeset
    69
     *
637546039be3 6977738: Deadlock between java.lang.ClassLoader and java.util.Properties
mchung
parents: 6668
diff changeset
    70
     * VM will invoke the initializeSystemClass method to complete
637546039be3 6977738: Deadlock between java.lang.ClassLoader and java.util.Properties
mchung
parents: 6668
diff changeset
    71
     * the initialization for this class separated from clinit.
637546039be3 6977738: Deadlock between java.lang.ClassLoader and java.util.Properties
mchung
parents: 6668
diff changeset
    72
     * Note that to use properties set by the VM, see the constraints
637546039be3 6977738: Deadlock between java.lang.ClassLoader and java.util.Properties
mchung
parents: 6668
diff changeset
    73
     * described in the initializeSystemClass method.
637546039be3 6977738: Deadlock between java.lang.ClassLoader and java.util.Properties
mchung
parents: 6668
diff changeset
    74
     */
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
    private static native void registerNatives();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
    static {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
        registerNatives();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
    /** Don't let anyone instantiate this class */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
    private System() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
     * The "standard" input stream. This stream is already
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
     * open and ready to supply input data. Typically this stream
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
     * corresponds to keyboard input or another input source specified by
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
     * the host environment or user.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
     */
32649
2ee9017c7597 8136583: Core libraries should use blessed modifier order
martin
parents: 32033
diff changeset
    90
    public static final InputStream in = null;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
     * The "standard" output stream. This stream is already
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
     * open and ready to accept output data. Typically this stream
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
     * corresponds to display output or another output destination
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
     * specified by the host environment or user.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
     * For simple stand-alone Java applications, a typical way to write
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
     * a line of output data is:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
     * <blockquote><pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
     *     System.out.println(data)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
     * </pre></blockquote>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
     * See the <code>println</code> methods in class <code>PrintStream</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
     * @see     java.io.PrintStream#println()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
     * @see     java.io.PrintStream#println(boolean)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
     * @see     java.io.PrintStream#println(char)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
     * @see     java.io.PrintStream#println(char[])
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
     * @see     java.io.PrintStream#println(double)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
     * @see     java.io.PrintStream#println(float)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
     * @see     java.io.PrintStream#println(int)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
     * @see     java.io.PrintStream#println(long)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
     * @see     java.io.PrintStream#println(java.lang.Object)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
     * @see     java.io.PrintStream#println(java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
     */
32649
2ee9017c7597 8136583: Core libraries should use blessed modifier order
martin
parents: 32033
diff changeset
   117
    public static final PrintStream out = null;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
     * The "standard" error output stream. This stream is already
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
     * open and ready to accept output data.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
     * Typically this stream corresponds to display output or another
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
     * output destination specified by the host environment or user. By
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
     * convention, this output stream is used to display error messages
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
     * or other information that should come to the immediate attention
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127
     * of a user even if the principal output stream, the value of the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
     * variable <code>out</code>, has been redirected to a file or other
90ce3da70b43 Initial load
duke
parents:
diff changeset
   129
     * destination that is typically not continuously monitored.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   130
     */
32649
2ee9017c7597 8136583: Core libraries should use blessed modifier order
martin
parents: 32033
diff changeset
   131
    public static final PrintStream err = null;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   132
90ce3da70b43 Initial load
duke
parents:
diff changeset
   133
    /* The security manager for the system.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   134
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   135
    private static volatile SecurityManager security = null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   136
90ce3da70b43 Initial load
duke
parents:
diff changeset
   137
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   138
     * Reassigns the "standard" input stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   139
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   140
     * <p>First, if there is a security manager, its <code>checkPermission</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   141
     * method is called with a <code>RuntimePermission("setIO")</code> permission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   142
     *  to see if it's ok to reassign the "standard" input stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   143
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   144
     * @param in the new standard input stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   145
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   146
     * @throws SecurityException
90ce3da70b43 Initial load
duke
parents:
diff changeset
   147
     *        if a security manager exists and its
90ce3da70b43 Initial load
duke
parents:
diff changeset
   148
     *        <code>checkPermission</code> method doesn't allow
90ce3da70b43 Initial load
duke
parents:
diff changeset
   149
     *        reassigning of the standard input stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   150
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   151
     * @see SecurityManager#checkPermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   152
     * @see java.lang.RuntimePermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   153
     *
24865
09b1d992ca72 8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents: 24367
diff changeset
   154
     * @since   1.1
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   155
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   156
    public static void setIn(InputStream in) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   157
        checkIO();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   158
        setIn0(in);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   159
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   160
90ce3da70b43 Initial load
duke
parents:
diff changeset
   161
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   162
     * Reassigns the "standard" output stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   163
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   164
     * <p>First, if there is a security manager, its <code>checkPermission</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   165
     * method is called with a <code>RuntimePermission("setIO")</code> permission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   166
     *  to see if it's ok to reassign the "standard" output stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   167
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   168
     * @param out the new standard output stream
90ce3da70b43 Initial load
duke
parents:
diff changeset
   169
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   170
     * @throws SecurityException
90ce3da70b43 Initial load
duke
parents:
diff changeset
   171
     *        if a security manager exists and its
90ce3da70b43 Initial load
duke
parents:
diff changeset
   172
     *        <code>checkPermission</code> method doesn't allow
90ce3da70b43 Initial load
duke
parents:
diff changeset
   173
     *        reassigning of the standard output stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   174
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   175
     * @see SecurityManager#checkPermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   176
     * @see java.lang.RuntimePermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   177
     *
24865
09b1d992ca72 8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents: 24367
diff changeset
   178
     * @since   1.1
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   179
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   180
    public static void setOut(PrintStream out) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   181
        checkIO();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   182
        setOut0(out);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   183
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   184
90ce3da70b43 Initial load
duke
parents:
diff changeset
   185
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   186
     * Reassigns the "standard" error output stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   187
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   188
     * <p>First, if there is a security manager, its <code>checkPermission</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   189
     * method is called with a <code>RuntimePermission("setIO")</code> permission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   190
     *  to see if it's ok to reassign the "standard" error output stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   191
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   192
     * @param err the new standard error output stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   193
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   194
     * @throws SecurityException
90ce3da70b43 Initial load
duke
parents:
diff changeset
   195
     *        if a security manager exists and its
90ce3da70b43 Initial load
duke
parents:
diff changeset
   196
     *        <code>checkPermission</code> method doesn't allow
90ce3da70b43 Initial load
duke
parents:
diff changeset
   197
     *        reassigning of the standard error output stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   198
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   199
     * @see SecurityManager#checkPermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   200
     * @see java.lang.RuntimePermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   201
     *
24865
09b1d992ca72 8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents: 24367
diff changeset
   202
     * @since   1.1
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   203
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   204
    public static void setErr(PrintStream err) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   205
        checkIO();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   206
        setErr0(err);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   207
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   208
90ce3da70b43 Initial load
duke
parents:
diff changeset
   209
    private static volatile Console cons = null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   210
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   211
     * Returns the unique {@link java.io.Console Console} object associated
90ce3da70b43 Initial load
duke
parents:
diff changeset
   212
     * with the current Java virtual machine, if any.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   213
     *
32033
bf24e33c7919 8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents: 31671
diff changeset
   214
     * @return  The system console, if any, otherwise {@code null}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   215
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   216
     * @since   1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   217
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   218
     public static Console console() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   219
         if (cons == null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   220
             synchronized (System.class) {
32834
e1dca5fe4de3 8137056: Move SharedSecrets and interface friends out of sun.misc
chegar
parents: 32649
diff changeset
   221
                 cons = SharedSecrets.getJavaIOAccess().console();
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   222
             }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   223
         }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   224
         return cons;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   225
     }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   226
90ce3da70b43 Initial load
duke
parents:
diff changeset
   227
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   228
     * Returns the channel inherited from the entity that created this
90ce3da70b43 Initial load
duke
parents:
diff changeset
   229
     * Java virtual machine.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   230
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   231
     * <p> This method returns the channel obtained by invoking the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   232
     * {@link java.nio.channels.spi.SelectorProvider#inheritedChannel
90ce3da70b43 Initial load
duke
parents:
diff changeset
   233
     * inheritedChannel} method of the system-wide default
90ce3da70b43 Initial load
duke
parents:
diff changeset
   234
     * {@link java.nio.channels.spi.SelectorProvider} object. </p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   235
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   236
     * <p> In addition to the network-oriented channels described in
90ce3da70b43 Initial load
duke
parents:
diff changeset
   237
     * {@link java.nio.channels.spi.SelectorProvider#inheritedChannel
90ce3da70b43 Initial load
duke
parents:
diff changeset
   238
     * inheritedChannel}, this method may return other kinds of
90ce3da70b43 Initial load
duke
parents:
diff changeset
   239
     * channels in the future.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   240
     *
32033
bf24e33c7919 8132468: docs: replace <tt> tags (obsolete in html5) for java.io, java.lang, java.math
avstepan
parents: 31671
diff changeset
   241
     * @return  The inherited channel, if any, otherwise {@code null}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   242
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   243
     * @throws  IOException
90ce3da70b43 Initial load
duke
parents:
diff changeset
   244
     *          If an I/O error occurs
90ce3da70b43 Initial load
duke
parents:
diff changeset
   245
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   246
     * @throws  SecurityException
90ce3da70b43 Initial load
duke
parents:
diff changeset
   247
     *          If a security manager is present and it does not
90ce3da70b43 Initial load
duke
parents:
diff changeset
   248
     *          permit access to the channel.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   249
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   250
     * @since 1.5
90ce3da70b43 Initial load
duke
parents:
diff changeset
   251
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   252
    public static Channel inheritedChannel() throws IOException {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   253
        return SelectorProvider.provider().inheritedChannel();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   254
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   255
90ce3da70b43 Initial load
duke
parents:
diff changeset
   256
    private static void checkIO() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   257
        SecurityManager sm = getSecurityManager();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   258
        if (sm != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   259
            sm.checkPermission(new RuntimePermission("setIO"));
90ce3da70b43 Initial load
duke
parents:
diff changeset
   260
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   261
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   262
90ce3da70b43 Initial load
duke
parents:
diff changeset
   263
    private static native void setIn0(InputStream in);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   264
    private static native void setOut0(PrintStream out);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   265
    private static native void setErr0(PrintStream err);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   266
90ce3da70b43 Initial load
duke
parents:
diff changeset
   267
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   268
     * Sets the System security.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   269
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   270
     * <p> If there is a security manager already installed, this method first
90ce3da70b43 Initial load
duke
parents:
diff changeset
   271
     * calls the security manager's <code>checkPermission</code> method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   272
     * with a <code>RuntimePermission("setSecurityManager")</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   273
     * permission to ensure it's ok to replace the existing
90ce3da70b43 Initial load
duke
parents:
diff changeset
   274
     * security manager.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   275
     * This may result in throwing a <code>SecurityException</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   276
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   277
     * <p> Otherwise, the argument is established as the current
90ce3da70b43 Initial load
duke
parents:
diff changeset
   278
     * security manager. If the argument is <code>null</code> and no
90ce3da70b43 Initial load
duke
parents:
diff changeset
   279
     * security manager has been established, then no action is taken and
90ce3da70b43 Initial load
duke
parents:
diff changeset
   280
     * the method simply returns.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   281
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   282
     * @param      s   the security manager.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   283
     * @exception  SecurityException  if the security manager has already
90ce3da70b43 Initial load
duke
parents:
diff changeset
   284
     *             been set and its <code>checkPermission</code> method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   285
     *             doesn't allow it to be replaced.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   286
     * @see #getSecurityManager
90ce3da70b43 Initial load
duke
parents:
diff changeset
   287
     * @see SecurityManager#checkPermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   288
     * @see java.lang.RuntimePermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   289
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   290
    public static
90ce3da70b43 Initial load
duke
parents:
diff changeset
   291
    void setSecurityManager(final SecurityManager s) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   292
        try {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   293
            s.checkPackageAccess("java.lang");
90ce3da70b43 Initial load
duke
parents:
diff changeset
   294
        } catch (Exception e) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   295
            // no-op
90ce3da70b43 Initial load
duke
parents:
diff changeset
   296
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   297
        setSecurityManager0(s);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   298
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   299
90ce3da70b43 Initial load
duke
parents:
diff changeset
   300
    private static synchronized
90ce3da70b43 Initial load
duke
parents:
diff changeset
   301
    void setSecurityManager0(final SecurityManager s) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   302
        SecurityManager sm = getSecurityManager();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   303
        if (sm != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   304
            // ask the currently installed security manager if we
90ce3da70b43 Initial load
duke
parents:
diff changeset
   305
            // can replace it.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   306
            sm.checkPermission(new RuntimePermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   307
                                     ("setSecurityManager"));
90ce3da70b43 Initial load
duke
parents:
diff changeset
   308
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   309
90ce3da70b43 Initial load
duke
parents:
diff changeset
   310
        if ((s != null) && (s.getClass().getClassLoader() != null)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   311
            // New security manager class is not on bootstrap classpath.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   312
            // Cause policy to get initialized before we install the new
90ce3da70b43 Initial load
duke
parents:
diff changeset
   313
            // security manager, in order to prevent infinite loops when
90ce3da70b43 Initial load
duke
parents:
diff changeset
   314
            // trying to initialize the policy (which usually involves
90ce3da70b43 Initial load
duke
parents:
diff changeset
   315
            // accessing some security and/or system properties, which in turn
90ce3da70b43 Initial load
duke
parents:
diff changeset
   316
            // calls the installed security manager's checkPermission method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   317
            // which will loop infinitely if there is a non-system class
90ce3da70b43 Initial load
duke
parents:
diff changeset
   318
            // (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
   319
            AccessController.doPrivileged(new PrivilegedAction<>() {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   320
                public Object run() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   321
                    s.getClass().getProtectionDomain().implies
90ce3da70b43 Initial load
duke
parents:
diff changeset
   322
                        (SecurityConstants.ALL_PERMISSION);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   323
                    return null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   324
                }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   325
            });
90ce3da70b43 Initial load
duke
parents:
diff changeset
   326
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   327
90ce3da70b43 Initial load
duke
parents:
diff changeset
   328
        security = s;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   329
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   330
90ce3da70b43 Initial load
duke
parents:
diff changeset
   331
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   332
     * Gets the system security interface.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   333
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   334
     * @return  if a security manager has already been established for the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   335
     *          current application, then that security manager is returned;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   336
     *          otherwise, <code>null</code> is returned.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   337
     * @see     #setSecurityManager
90ce3da70b43 Initial load
duke
parents:
diff changeset
   338
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   339
    public static SecurityManager getSecurityManager() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   340
        return security;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   341
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   342
90ce3da70b43 Initial load
duke
parents:
diff changeset
   343
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   344
     * Returns the current time in milliseconds.  Note that
90ce3da70b43 Initial load
duke
parents:
diff changeset
   345
     * while the unit of time of the return value is a millisecond,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   346
     * the granularity of the value depends on the underlying
90ce3da70b43 Initial load
duke
parents:
diff changeset
   347
     * operating system and may be larger.  For example, many
90ce3da70b43 Initial load
duke
parents:
diff changeset
   348
     * operating systems measure time in units of tens of
90ce3da70b43 Initial load
duke
parents:
diff changeset
   349
     * milliseconds.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   350
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   351
     * <p> See the description of the class <code>Date</code> for
90ce3da70b43 Initial load
duke
parents:
diff changeset
   352
     * a discussion of slight discrepancies that may arise between
90ce3da70b43 Initial load
duke
parents:
diff changeset
   353
     * "computer time" and coordinated universal time (UTC).
90ce3da70b43 Initial load
duke
parents:
diff changeset
   354
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   355
     * @return  the difference, measured in milliseconds, between
90ce3da70b43 Initial load
duke
parents:
diff changeset
   356
     *          the current time and midnight, January 1, 1970 UTC.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   357
     * @see     java.util.Date
90ce3da70b43 Initial load
duke
parents:
diff changeset
   358
     */
31671
362e0c0acece 8076112: Add @HotSpotIntrinsicCandidate annotation to indicate methods for which Java Runtime has intrinsics
zmajo
parents: 29986
diff changeset
   359
    @HotSpotIntrinsicCandidate
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   360
    public static native long currentTimeMillis();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   361
90ce3da70b43 Initial load
duke
parents:
diff changeset
   362
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   363
     * Returns the current value of the running Java Virtual Machine's
90ce3da70b43 Initial load
duke
parents:
diff changeset
   364
     * high-resolution time source, in nanoseconds.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   365
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   366
     * <p>This method can only be used to measure elapsed time and is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   367
     * not related to any other notion of system or wall-clock time.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   368
     * The value returned represents nanoseconds since some fixed but
90ce3da70b43 Initial load
duke
parents:
diff changeset
   369
     * arbitrary <i>origin</i> time (perhaps in the future, so values
90ce3da70b43 Initial load
duke
parents:
diff changeset
   370
     * may be negative).  The same origin is used by all invocations of
90ce3da70b43 Initial load
duke
parents:
diff changeset
   371
     * this method in an instance of a Java virtual machine; other
90ce3da70b43 Initial load
duke
parents:
diff changeset
   372
     * virtual machine instances are likely to use a different origin.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   373
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   374
     * <p>This method provides nanosecond precision, but not necessarily
90ce3da70b43 Initial load
duke
parents:
diff changeset
   375
     * nanosecond resolution (that is, how frequently the value changes)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   376
     * - no guarantees are made except that the resolution is at least as
90ce3da70b43 Initial load
duke
parents:
diff changeset
   377
     * good as that of {@link #currentTimeMillis()}.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   378
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   379
     * <p>Differences in successive calls that span greater than
90ce3da70b43 Initial load
duke
parents:
diff changeset
   380
     * approximately 292 years (2<sup>63</sup> nanoseconds) will not
90ce3da70b43 Initial load
duke
parents:
diff changeset
   381
     * correctly compute elapsed time due to numerical overflow.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   382
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   383
     * <p>The values returned by this method become meaningful only when
90ce3da70b43 Initial load
duke
parents:
diff changeset
   384
     * the difference between two such values, obtained within the same
90ce3da70b43 Initial load
duke
parents:
diff changeset
   385
     * instance of a Java virtual machine, is computed.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   386
     *
28668
a5b9168af1bb 8069269: (spec) Defect in the System.nanoTime spec
bpb
parents: 27565
diff changeset
   387
     * <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
   388
     * <pre> {@code
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   389
     * long startTime = System.nanoTime();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   390
     * // ... the code being measured ...
28668
a5b9168af1bb 8069269: (spec) Defect in the System.nanoTime spec
bpb
parents: 27565
diff changeset
   391
     * long elapsedNanos = System.nanoTime() - startTime;}</pre>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   392
     *
28668
a5b9168af1bb 8069269: (spec) Defect in the System.nanoTime spec
bpb
parents: 27565
diff changeset
   393
     * <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
   394
     * if (System.nanoTime() - startTime >= timeoutNanos) ...}</pre>
a5b9168af1bb 8069269: (spec) Defect in the System.nanoTime spec
bpb
parents: 27565
diff changeset
   395
     * instead of <pre> {@code
a5b9168af1bb 8069269: (spec) Defect in the System.nanoTime spec
bpb
parents: 27565
diff changeset
   396
     * if (System.nanoTime() >= startTime + timeoutNanos) ...}</pre>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   397
     * because of the possibility of numerical overflow.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   398
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   399
     * @return the current value of the running Java Virtual Machine's
90ce3da70b43 Initial load
duke
parents:
diff changeset
   400
     *         high-resolution time source, in nanoseconds
90ce3da70b43 Initial load
duke
parents:
diff changeset
   401
     * @since 1.5
90ce3da70b43 Initial load
duke
parents:
diff changeset
   402
     */
31671
362e0c0acece 8076112: Add @HotSpotIntrinsicCandidate annotation to indicate methods for which Java Runtime has intrinsics
zmajo
parents: 29986
diff changeset
   403
    @HotSpotIntrinsicCandidate
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   404
    public static native long nanoTime();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   405
90ce3da70b43 Initial load
duke
parents:
diff changeset
   406
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   407
     * Copies an array from the specified source array, beginning at the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   408
     * specified position, to the specified position of the destination array.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   409
     * A subsequence of array components are copied from the source
90ce3da70b43 Initial load
duke
parents:
diff changeset
   410
     * array referenced by <code>src</code> to the destination array
90ce3da70b43 Initial load
duke
parents:
diff changeset
   411
     * referenced by <code>dest</code>. The number of components copied is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   412
     * equal to the <code>length</code> argument. The components at
90ce3da70b43 Initial load
duke
parents:
diff changeset
   413
     * positions <code>srcPos</code> through
90ce3da70b43 Initial load
duke
parents:
diff changeset
   414
     * <code>srcPos+length-1</code> in the source array are copied into
90ce3da70b43 Initial load
duke
parents:
diff changeset
   415
     * positions <code>destPos</code> through
90ce3da70b43 Initial load
duke
parents:
diff changeset
   416
     * <code>destPos+length-1</code>, respectively, of the destination
90ce3da70b43 Initial load
duke
parents:
diff changeset
   417
     * array.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   418
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   419
     * If the <code>src</code> and <code>dest</code> arguments refer to the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   420
     * same array object, then the copying is performed as if the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   421
     * components at positions <code>srcPos</code> through
90ce3da70b43 Initial load
duke
parents:
diff changeset
   422
     * <code>srcPos+length-1</code> were first copied to a temporary
90ce3da70b43 Initial load
duke
parents:
diff changeset
   423
     * array with <code>length</code> components and then the contents of
90ce3da70b43 Initial load
duke
parents:
diff changeset
   424
     * the temporary array were copied into positions
90ce3da70b43 Initial load
duke
parents:
diff changeset
   425
     * <code>destPos</code> through <code>destPos+length-1</code> of the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   426
     * destination array.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   427
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   428
     * If <code>dest</code> is <code>null</code>, then a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   429
     * <code>NullPointerException</code> is thrown.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   430
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   431
     * If <code>src</code> is <code>null</code>, then a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   432
     * <code>NullPointerException</code> is thrown and the destination
90ce3da70b43 Initial load
duke
parents:
diff changeset
   433
     * array is not modified.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   434
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   435
     * Otherwise, if any of the following is true, an
90ce3da70b43 Initial load
duke
parents:
diff changeset
   436
     * <code>ArrayStoreException</code> is thrown and the destination is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   437
     * not modified:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   438
     * <ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   439
     * <li>The <code>src</code> argument refers to an object that is not an
90ce3da70b43 Initial load
duke
parents:
diff changeset
   440
     *     array.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   441
     * <li>The <code>dest</code> argument refers to an object that is not an
90ce3da70b43 Initial load
duke
parents:
diff changeset
   442
     *     array.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   443
     * <li>The <code>src</code> argument and <code>dest</code> argument refer
90ce3da70b43 Initial load
duke
parents:
diff changeset
   444
     *     to arrays whose component types are different primitive types.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   445
     * <li>The <code>src</code> argument refers to an array with a primitive
90ce3da70b43 Initial load
duke
parents:
diff changeset
   446
     *    component type and the <code>dest</code> argument refers to an array
90ce3da70b43 Initial load
duke
parents:
diff changeset
   447
     *     with a reference component type.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   448
     * <li>The <code>src</code> argument refers to an array with a reference
90ce3da70b43 Initial load
duke
parents:
diff changeset
   449
     *    component type and the <code>dest</code> argument refers to an array
90ce3da70b43 Initial load
duke
parents:
diff changeset
   450
     *     with a primitive component type.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   451
     * </ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   452
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   453
     * Otherwise, if any of the following is true, an
90ce3da70b43 Initial load
duke
parents:
diff changeset
   454
     * <code>IndexOutOfBoundsException</code> is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   455
     * thrown and the destination is not modified:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   456
     * <ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   457
     * <li>The <code>srcPos</code> argument is negative.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   458
     * <li>The <code>destPos</code> argument is negative.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   459
     * <li>The <code>length</code> argument is negative.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   460
     * <li><code>srcPos+length</code> is greater than
90ce3da70b43 Initial load
duke
parents:
diff changeset
   461
     *     <code>src.length</code>, the length of the source array.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   462
     * <li><code>destPos+length</code> is greater than
90ce3da70b43 Initial load
duke
parents:
diff changeset
   463
     *     <code>dest.length</code>, the length of the destination array.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   464
     * </ul>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   465
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   466
     * Otherwise, if any actual component of the source array from
90ce3da70b43 Initial load
duke
parents:
diff changeset
   467
     * position <code>srcPos</code> through
90ce3da70b43 Initial load
duke
parents:
diff changeset
   468
     * <code>srcPos+length-1</code> cannot be converted to the component
90ce3da70b43 Initial load
duke
parents:
diff changeset
   469
     * type of the destination array by assignment conversion, an
90ce3da70b43 Initial load
duke
parents:
diff changeset
   470
     * <code>ArrayStoreException</code> is thrown. In this case, let
90ce3da70b43 Initial load
duke
parents:
diff changeset
   471
     * <b><i>k</i></b> be the smallest nonnegative integer less than
90ce3da70b43 Initial load
duke
parents:
diff changeset
   472
     * length such that <code>src[srcPos+</code><i>k</i><code>]</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   473
     * cannot be converted to the component type of the destination
90ce3da70b43 Initial load
duke
parents:
diff changeset
   474
     * array; when the exception is thrown, source array components from
90ce3da70b43 Initial load
duke
parents:
diff changeset
   475
     * positions <code>srcPos</code> through
90ce3da70b43 Initial load
duke
parents:
diff changeset
   476
     * <code>srcPos+</code><i>k</i><code>-1</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   477
     * will already have been copied to destination array positions
90ce3da70b43 Initial load
duke
parents:
diff changeset
   478
     * <code>destPos</code> through
90ce3da70b43 Initial load
duke
parents:
diff changeset
   479
     * <code>destPos+</code><i>k</I><code>-1</code> and no other
90ce3da70b43 Initial load
duke
parents:
diff changeset
   480
     * positions of the destination array will have been modified.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   481
     * (Because of the restrictions already itemized, this
90ce3da70b43 Initial load
duke
parents:
diff changeset
   482
     * paragraph effectively applies only to the situation where both
90ce3da70b43 Initial load
duke
parents:
diff changeset
   483
     * arrays have component types that are reference types.)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   484
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   485
     * @param      src      the source array.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   486
     * @param      srcPos   starting position in the source array.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   487
     * @param      dest     the destination array.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   488
     * @param      destPos  starting position in the destination data.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   489
     * @param      length   the number of array elements to be copied.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   490
     * @exception  IndexOutOfBoundsException  if copying would cause
90ce3da70b43 Initial load
duke
parents:
diff changeset
   491
     *               access of data outside array bounds.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   492
     * @exception  ArrayStoreException  if an element in the <code>src</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   493
     *               array could not be stored into the <code>dest</code> array
90ce3da70b43 Initial load
duke
parents:
diff changeset
   494
     *               because of a type mismatch.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   495
     * @exception  NullPointerException if either <code>src</code> or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   496
     *               <code>dest</code> is <code>null</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   497
     */
31671
362e0c0acece 8076112: Add @HotSpotIntrinsicCandidate annotation to indicate methods for which Java Runtime has intrinsics
zmajo
parents: 29986
diff changeset
   498
    @HotSpotIntrinsicCandidate
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   499
    public static native void arraycopy(Object src,  int  srcPos,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   500
                                        Object dest, int destPos,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   501
                                        int length);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   502
90ce3da70b43 Initial load
duke
parents:
diff changeset
   503
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   504
     * Returns the same hash code for the given object as
90ce3da70b43 Initial load
duke
parents:
diff changeset
   505
     * would be returned by the default method hashCode(),
90ce3da70b43 Initial load
duke
parents:
diff changeset
   506
     * whether or not the given object's class overrides
90ce3da70b43 Initial load
duke
parents:
diff changeset
   507
     * hashCode().
90ce3da70b43 Initial load
duke
parents:
diff changeset
   508
     * The hash code for the null reference is zero.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   509
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   510
     * @param x object for which the hashCode is to be calculated
90ce3da70b43 Initial load
duke
parents:
diff changeset
   511
     * @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
   512
     * @since   1.1
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   513
     */
31671
362e0c0acece 8076112: Add @HotSpotIntrinsicCandidate annotation to indicate methods for which Java Runtime has intrinsics
zmajo
parents: 29986
diff changeset
   514
    @HotSpotIntrinsicCandidate
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   515
    public static native int identityHashCode(Object x);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   516
90ce3da70b43 Initial load
duke
parents:
diff changeset
   517
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   518
     * System properties. The following properties are guaranteed to be defined:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   519
     * <dl>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   520
     * <dt>java.version         <dd>Java version number
90ce3da70b43 Initial load
duke
parents:
diff changeset
   521
     * <dt>java.vendor          <dd>Java vendor specific string
90ce3da70b43 Initial load
duke
parents:
diff changeset
   522
     * <dt>java.vendor.url      <dd>Java vendor URL
90ce3da70b43 Initial load
duke
parents:
diff changeset
   523
     * <dt>java.home            <dd>Java installation directory
90ce3da70b43 Initial load
duke
parents:
diff changeset
   524
     * <dt>java.class.version   <dd>Java class version number
90ce3da70b43 Initial load
duke
parents:
diff changeset
   525
     * <dt>java.class.path      <dd>Java classpath
90ce3da70b43 Initial load
duke
parents:
diff changeset
   526
     * <dt>os.name              <dd>Operating System Name
90ce3da70b43 Initial load
duke
parents:
diff changeset
   527
     * <dt>os.arch              <dd>Operating System Architecture
90ce3da70b43 Initial load
duke
parents:
diff changeset
   528
     * <dt>os.version           <dd>Operating System Version
90ce3da70b43 Initial load
duke
parents:
diff changeset
   529
     * <dt>file.separator       <dd>File separator ("/" on Unix)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   530
     * <dt>path.separator       <dd>Path separator (":" on Unix)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   531
     * <dt>line.separator       <dd>Line separator ("\n" on Unix)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   532
     * <dt>user.name            <dd>User account name
90ce3da70b43 Initial load
duke
parents:
diff changeset
   533
     * <dt>user.home            <dd>User home directory
90ce3da70b43 Initial load
duke
parents:
diff changeset
   534
     * <dt>user.dir             <dd>User's current working directory
90ce3da70b43 Initial load
duke
parents:
diff changeset
   535
     * </dl>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   536
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   537
90ce3da70b43 Initial load
duke
parents:
diff changeset
   538
    private static Properties props;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   539
    private static native Properties initProperties(Properties props);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   540
90ce3da70b43 Initial load
duke
parents:
diff changeset
   541
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   542
     * Determines the current system properties.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   543
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   544
     * First, if there is a security manager, its
90ce3da70b43 Initial load
duke
parents:
diff changeset
   545
     * <code>checkPropertiesAccess</code> method is called with no
90ce3da70b43 Initial load
duke
parents:
diff changeset
   546
     * arguments. This may result in a security exception.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   547
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   548
     * The current set of system properties for use by the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   549
     * {@link #getProperty(String)} method is returned as a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   550
     * <code>Properties</code> object. If there is no current set of
90ce3da70b43 Initial load
duke
parents:
diff changeset
   551
     * system properties, a set of system properties is first created and
90ce3da70b43 Initial load
duke
parents:
diff changeset
   552
     * initialized. This set of system properties always includes values
90ce3da70b43 Initial load
duke
parents:
diff changeset
   553
     * for the following keys:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   554
     * <table summary="Shows property keys and associated values">
90ce3da70b43 Initial load
duke
parents:
diff changeset
   555
     * <tr><th>Key</th>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   556
     *     <th>Description of Associated Value</th></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   557
     * <tr><td><code>java.version</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   558
     *     <td>Java Runtime Environment version</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   559
     * <tr><td><code>java.vendor</code></td>
14014
da3648e13e67 8000269: Cleanup javadoc warnings
alanb
parents: 12038
diff changeset
   560
     *     <td>Java Runtime Environment vendor</td></tr>
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   561
     * <tr><td><code>java.vendor.url</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   562
     *     <td>Java vendor URL</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   563
     * <tr><td><code>java.home</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   564
     *     <td>Java installation directory</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   565
     * <tr><td><code>java.vm.specification.version</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   566
     *     <td>Java Virtual Machine specification version</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   567
     * <tr><td><code>java.vm.specification.vendor</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   568
     *     <td>Java Virtual Machine specification vendor</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   569
     * <tr><td><code>java.vm.specification.name</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   570
     *     <td>Java Virtual Machine specification name</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   571
     * <tr><td><code>java.vm.version</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   572
     *     <td>Java Virtual Machine implementation version</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   573
     * <tr><td><code>java.vm.vendor</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   574
     *     <td>Java Virtual Machine implementation vendor</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   575
     * <tr><td><code>java.vm.name</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   576
     *     <td>Java Virtual Machine implementation name</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   577
     * <tr><td><code>java.specification.version</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   578
     *     <td>Java Runtime Environment specification  version</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   579
     * <tr><td><code>java.specification.vendor</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   580
     *     <td>Java Runtime Environment specification  vendor</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   581
     * <tr><td><code>java.specification.name</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   582
     *     <td>Java Runtime Environment specification  name</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   583
     * <tr><td><code>java.class.version</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   584
     *     <td>Java class format version number</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   585
     * <tr><td><code>java.class.path</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   586
     *     <td>Java class path</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   587
     * <tr><td><code>java.library.path</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   588
     *     <td>List of paths to search when loading libraries</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   589
     * <tr><td><code>java.io.tmpdir</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   590
     *     <td>Default temp file path</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   591
     * <tr><td><code>java.compiler</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   592
     *     <td>Name of JIT compiler to use</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   593
     * <tr><td><code>os.name</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   594
     *     <td>Operating system name</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   595
     * <tr><td><code>os.arch</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   596
     *     <td>Operating system architecture</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   597
     * <tr><td><code>os.version</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   598
     *     <td>Operating system version</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   599
     * <tr><td><code>file.separator</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   600
     *     <td>File separator ("/" on UNIX)</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   601
     * <tr><td><code>path.separator</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   602
     *     <td>Path separator (":" on UNIX)</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   603
     * <tr><td><code>line.separator</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   604
     *     <td>Line separator ("\n" on UNIX)</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   605
     * <tr><td><code>user.name</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   606
     *     <td>User's account name</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   607
     * <tr><td><code>user.home</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   608
     *     <td>User's home directory</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   609
     * <tr><td><code>user.dir</code></td>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   610
     *     <td>User's current working directory</td></tr>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   611
     * </table>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   612
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   613
     * Multiple paths in a system property value are separated by the path
90ce3da70b43 Initial load
duke
parents:
diff changeset
   614
     * separator character of the platform.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   615
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   616
     * Note that even if the security manager does not permit the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   617
     * <code>getProperties</code> operation, it may choose to permit the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   618
     * {@link #getProperty(String)} operation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   619
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   620
     * @return     the system properties
90ce3da70b43 Initial load
duke
parents:
diff changeset
   621
     * @exception  SecurityException  if a security manager exists and its
90ce3da70b43 Initial load
duke
parents:
diff changeset
   622
     *             <code>checkPropertiesAccess</code> method doesn't allow access
90ce3da70b43 Initial load
duke
parents:
diff changeset
   623
     *              to the system properties.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   624
     * @see        #setProperties
90ce3da70b43 Initial load
duke
parents:
diff changeset
   625
     * @see        java.lang.SecurityException
90ce3da70b43 Initial load
duke
parents:
diff changeset
   626
     * @see        java.lang.SecurityManager#checkPropertiesAccess()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   627
     * @see        java.util.Properties
90ce3da70b43 Initial load
duke
parents:
diff changeset
   628
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   629
    public static Properties getProperties() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   630
        SecurityManager sm = getSecurityManager();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   631
        if (sm != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   632
            sm.checkPropertiesAccess();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   633
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   634
90ce3da70b43 Initial load
duke
parents:
diff changeset
   635
        return props;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   636
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   637
90ce3da70b43 Initial load
duke
parents:
diff changeset
   638
    /**
4355
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   639
     * Returns the system-dependent line separator string.  It always
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   640
     * returns the same value - the initial value of the {@linkplain
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   641
     * #getProperty(String) system property} {@code line.separator}.
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   642
     *
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   643
     * <p>On UNIX systems, it returns {@code "\n"}; on Microsoft
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   644
     * Windows systems it returns {@code "\r\n"}.
18546
862067c6481c 8017550: Fix doclint issues in java.lang and subpackages
darcy
parents: 17426
diff changeset
   645
     *
862067c6481c 8017550: Fix doclint issues in java.lang and subpackages
darcy
parents: 17426
diff changeset
   646
     * @return the system-dependent line separator string
10360
d1a6fafde2fa 7082231: Put a @since 1.7 on System.lineSeparator
darcy
parents: 9035
diff changeset
   647
     * @since 1.7
4355
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   648
     */
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   649
    public static String lineSeparator() {
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   650
        return lineSeparator;
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   651
    }
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   652
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   653
    private static String lineSeparator;
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   654
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
   655
    /**
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   656
     * Sets the system properties to the <code>Properties</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   657
     * argument.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   658
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   659
     * First, if there is a security manager, its
90ce3da70b43 Initial load
duke
parents:
diff changeset
   660
     * <code>checkPropertiesAccess</code> method is called with no
90ce3da70b43 Initial load
duke
parents:
diff changeset
   661
     * arguments. This may result in a security exception.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   662
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   663
     * The argument becomes the current set of system properties for use
90ce3da70b43 Initial load
duke
parents:
diff changeset
   664
     * by the {@link #getProperty(String)} method. If the argument is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   665
     * <code>null</code>, then the current set of system properties is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   666
     * forgotten.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   667
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   668
     * @param      props   the new system properties.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   669
     * @exception  SecurityException  if a security manager exists and its
90ce3da70b43 Initial load
duke
parents:
diff changeset
   670
     *             <code>checkPropertiesAccess</code> method doesn't allow access
90ce3da70b43 Initial load
duke
parents:
diff changeset
   671
     *              to the system properties.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   672
     * @see        #getProperties
90ce3da70b43 Initial load
duke
parents:
diff changeset
   673
     * @see        java.util.Properties
90ce3da70b43 Initial load
duke
parents:
diff changeset
   674
     * @see        java.lang.SecurityException
90ce3da70b43 Initial load
duke
parents:
diff changeset
   675
     * @see        java.lang.SecurityManager#checkPropertiesAccess()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   676
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   677
    public static void setProperties(Properties props) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   678
        SecurityManager sm = getSecurityManager();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   679
        if (sm != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   680
            sm.checkPropertiesAccess();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   681
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   682
        if (props == null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   683
            props = new Properties();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   684
            initProperties(props);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   685
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   686
        System.props = props;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   687
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   688
90ce3da70b43 Initial load
duke
parents:
diff changeset
   689
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   690
     * Gets the system property indicated by the specified key.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   691
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   692
     * First, if there is a security manager, its
90ce3da70b43 Initial load
duke
parents:
diff changeset
   693
     * <code>checkPropertyAccess</code> method is called with the key as
90ce3da70b43 Initial load
duke
parents:
diff changeset
   694
     * its argument. This may result in a SecurityException.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   695
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   696
     * If there is no current set of system properties, a set of system
90ce3da70b43 Initial load
duke
parents:
diff changeset
   697
     * properties is first created and initialized in the same manner as
90ce3da70b43 Initial load
duke
parents:
diff changeset
   698
     * for the <code>getProperties</code> method.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   699
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   700
     * @param      key   the name of the system property.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   701
     * @return     the string value of the system property,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   702
     *             or <code>null</code> if there is no property with that key.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   703
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   704
     * @exception  SecurityException  if a security manager exists and its
90ce3da70b43 Initial load
duke
parents:
diff changeset
   705
     *             <code>checkPropertyAccess</code> method doesn't allow
90ce3da70b43 Initial load
duke
parents:
diff changeset
   706
     *              access to the specified system property.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   707
     * @exception  NullPointerException if <code>key</code> is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   708
     *             <code>null</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   709
     * @exception  IllegalArgumentException if <code>key</code> is empty.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   710
     * @see        #setProperty
90ce3da70b43 Initial load
duke
parents:
diff changeset
   711
     * @see        java.lang.SecurityException
90ce3da70b43 Initial load
duke
parents:
diff changeset
   712
     * @see        java.lang.SecurityManager#checkPropertyAccess(java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   713
     * @see        java.lang.System#getProperties()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   714
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   715
    public static String getProperty(String key) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   716
        checkKey(key);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   717
        SecurityManager sm = getSecurityManager();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   718
        if (sm != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   719
            sm.checkPropertyAccess(key);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   720
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   721
90ce3da70b43 Initial load
duke
parents:
diff changeset
   722
        return props.getProperty(key);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   723
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   724
90ce3da70b43 Initial load
duke
parents:
diff changeset
   725
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   726
     * Gets the system property indicated by the specified key.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   727
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   728
     * First, if there is a security manager, its
90ce3da70b43 Initial load
duke
parents:
diff changeset
   729
     * <code>checkPropertyAccess</code> method is called with the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   730
     * <code>key</code> as its argument.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   731
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   732
     * If there is no current set of system properties, a set of system
90ce3da70b43 Initial load
duke
parents:
diff changeset
   733
     * properties is first created and initialized in the same manner as
90ce3da70b43 Initial load
duke
parents:
diff changeset
   734
     * for the <code>getProperties</code> method.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   735
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   736
     * @param      key   the name of the system property.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   737
     * @param      def   a default value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   738
     * @return     the string value of the system property,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   739
     *             or the default value if there is no property with that key.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   740
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   741
     * @exception  SecurityException  if a security manager exists and its
90ce3da70b43 Initial load
duke
parents:
diff changeset
   742
     *             <code>checkPropertyAccess</code> method doesn't allow
90ce3da70b43 Initial load
duke
parents:
diff changeset
   743
     *             access to the specified system property.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   744
     * @exception  NullPointerException if <code>key</code> is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   745
     *             <code>null</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   746
     * @exception  IllegalArgumentException if <code>key</code> is empty.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   747
     * @see        #setProperty
90ce3da70b43 Initial load
duke
parents:
diff changeset
   748
     * @see        java.lang.SecurityManager#checkPropertyAccess(java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   749
     * @see        java.lang.System#getProperties()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   750
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   751
    public static String getProperty(String key, String def) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   752
        checkKey(key);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   753
        SecurityManager sm = getSecurityManager();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   754
        if (sm != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   755
            sm.checkPropertyAccess(key);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   756
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   757
90ce3da70b43 Initial load
duke
parents:
diff changeset
   758
        return props.getProperty(key, def);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   759
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   760
90ce3da70b43 Initial load
duke
parents:
diff changeset
   761
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   762
     * Sets the system property indicated by the specified key.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   763
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   764
     * First, if a security manager exists, its
90ce3da70b43 Initial load
duke
parents:
diff changeset
   765
     * <code>SecurityManager.checkPermission</code> method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   766
     * is called with a <code>PropertyPermission(key, "write")</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   767
     * permission. This may result in a SecurityException being thrown.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   768
     * If no exception is thrown, the specified property is set to the given
90ce3da70b43 Initial load
duke
parents:
diff changeset
   769
     * value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   770
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   771
     * @param      key   the name of the system property.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   772
     * @param      value the value of the system property.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   773
     * @return     the previous value of the system property,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   774
     *             or <code>null</code> if it did not have one.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   775
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   776
     * @exception  SecurityException  if a security manager exists and its
90ce3da70b43 Initial load
duke
parents:
diff changeset
   777
     *             <code>checkPermission</code> method doesn't allow
90ce3da70b43 Initial load
duke
parents:
diff changeset
   778
     *             setting of the specified property.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   779
     * @exception  NullPointerException if <code>key</code> or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   780
     *             <code>value</code> is <code>null</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   781
     * @exception  IllegalArgumentException if <code>key</code> is empty.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   782
     * @see        #getProperty
90ce3da70b43 Initial load
duke
parents:
diff changeset
   783
     * @see        java.lang.System#getProperty(java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   784
     * @see        java.lang.System#getProperty(java.lang.String, java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   785
     * @see        java.util.PropertyPermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   786
     * @see        SecurityManager#checkPermission
90ce3da70b43 Initial load
duke
parents:
diff changeset
   787
     * @since      1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   788
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   789
    public static String setProperty(String key, String value) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   790
        checkKey(key);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   791
        SecurityManager sm = getSecurityManager();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   792
        if (sm != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   793
            sm.checkPermission(new PropertyPermission(key,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   794
                SecurityConstants.PROPERTY_WRITE_ACTION));
90ce3da70b43 Initial load
duke
parents:
diff changeset
   795
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   796
90ce3da70b43 Initial load
duke
parents:
diff changeset
   797
        return (String) props.setProperty(key, value);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   798
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   799
90ce3da70b43 Initial load
duke
parents:
diff changeset
   800
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   801
     * Removes the system property indicated by the specified key.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   802
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   803
     * First, if a security manager exists, its
90ce3da70b43 Initial load
duke
parents:
diff changeset
   804
     * <code>SecurityManager.checkPermission</code> method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   805
     * is called with a <code>PropertyPermission(key, "write")</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   806
     * permission. This may result in a SecurityException being thrown.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   807
     * If no exception is thrown, the specified property is removed.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   808
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   809
     * @param      key   the name of the system property to be removed.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   810
     * @return     the previous string value of the system property,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   811
     *             or <code>null</code> if there was no property with that key.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   812
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   813
     * @exception  SecurityException  if a security manager exists and its
90ce3da70b43 Initial load
duke
parents:
diff changeset
   814
     *             <code>checkPropertyAccess</code> method doesn't allow
90ce3da70b43 Initial load
duke
parents:
diff changeset
   815
     *              access to the specified system property.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   816
     * @exception  NullPointerException if <code>key</code> is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   817
     *             <code>null</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   818
     * @exception  IllegalArgumentException if <code>key</code> is empty.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   819
     * @see        #getProperty
90ce3da70b43 Initial load
duke
parents:
diff changeset
   820
     * @see        #setProperty
90ce3da70b43 Initial load
duke
parents:
diff changeset
   821
     * @see        java.util.Properties
90ce3da70b43 Initial load
duke
parents:
diff changeset
   822
     * @see        java.lang.SecurityException
90ce3da70b43 Initial load
duke
parents:
diff changeset
   823
     * @see        java.lang.SecurityManager#checkPropertiesAccess()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   824
     * @since 1.5
90ce3da70b43 Initial load
duke
parents:
diff changeset
   825
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   826
    public static String clearProperty(String key) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   827
        checkKey(key);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   828
        SecurityManager sm = getSecurityManager();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   829
        if (sm != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   830
            sm.checkPermission(new PropertyPermission(key, "write"));
90ce3da70b43 Initial load
duke
parents:
diff changeset
   831
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   832
90ce3da70b43 Initial load
duke
parents:
diff changeset
   833
        return (String) props.remove(key);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   834
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   835
90ce3da70b43 Initial load
duke
parents:
diff changeset
   836
    private static void checkKey(String key) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   837
        if (key == null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   838
            throw new NullPointerException("key can't be null");
90ce3da70b43 Initial load
duke
parents:
diff changeset
   839
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   840
        if (key.equals("")) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   841
            throw new IllegalArgumentException("key can't be empty");
90ce3da70b43 Initial load
duke
parents:
diff changeset
   842
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   843
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   844
90ce3da70b43 Initial load
duke
parents:
diff changeset
   845
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   846
     * Gets the value of the specified environment variable. An
90ce3da70b43 Initial load
duke
parents:
diff changeset
   847
     * environment variable is a system-dependent external named
90ce3da70b43 Initial load
duke
parents:
diff changeset
   848
     * value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   849
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   850
     * <p>If a security manager exists, its
90ce3da70b43 Initial load
duke
parents:
diff changeset
   851
     * {@link SecurityManager#checkPermission checkPermission}
90ce3da70b43 Initial load
duke
parents:
diff changeset
   852
     * method is called with a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   853
     * <code>{@link RuntimePermission}("getenv."+name)</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   854
     * permission.  This may result in a {@link SecurityException}
90ce3da70b43 Initial load
duke
parents:
diff changeset
   855
     * being thrown.  If no exception is thrown the value of the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   856
     * variable <code>name</code> is returned.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   857
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   858
     * <p><a name="EnvironmentVSSystemProperties"><i>System
90ce3da70b43 Initial load
duke
parents:
diff changeset
   859
     * properties</i> and <i>environment variables</i></a> are both
90ce3da70b43 Initial load
duke
parents:
diff changeset
   860
     * conceptually mappings between names and values.  Both
90ce3da70b43 Initial load
duke
parents:
diff changeset
   861
     * mechanisms can be used to pass user-defined information to a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   862
     * Java process.  Environment variables have a more global effect,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   863
     * because they are visible to all descendants of the process
90ce3da70b43 Initial load
duke
parents:
diff changeset
   864
     * which defines them, not just the immediate Java subprocess.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   865
     * They can have subtly different semantics, such as case
90ce3da70b43 Initial load
duke
parents:
diff changeset
   866
     * insensitivity, on different operating systems.  For these
90ce3da70b43 Initial load
duke
parents:
diff changeset
   867
     * reasons, environment variables are more likely to have
90ce3da70b43 Initial load
duke
parents:
diff changeset
   868
     * unintended side effects.  It is best to use system properties
90ce3da70b43 Initial load
duke
parents:
diff changeset
   869
     * where possible.  Environment variables should be used when a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   870
     * global effect is desired, or when an external system interface
90ce3da70b43 Initial load
duke
parents:
diff changeset
   871
     * requires an environment variable (such as <code>PATH</code>).
90ce3da70b43 Initial load
duke
parents:
diff changeset
   872
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   873
     * <p>On UNIX systems the alphabetic case of <code>name</code> is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   874
     * typically significant, while on Microsoft Windows systems it is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   875
     * typically not.  For example, the expression
90ce3da70b43 Initial load
duke
parents:
diff changeset
   876
     * <code>System.getenv("FOO").equals(System.getenv("foo"))</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   877
     * is likely to be true on Microsoft Windows.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   878
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   879
     * @param  name the name of the environment variable
90ce3da70b43 Initial load
duke
parents:
diff changeset
   880
     * @return the string value of the variable, or <code>null</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   881
     *         if the variable is not defined in the system environment
90ce3da70b43 Initial load
duke
parents:
diff changeset
   882
     * @throws NullPointerException if <code>name</code> is <code>null</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   883
     * @throws SecurityException
90ce3da70b43 Initial load
duke
parents:
diff changeset
   884
     *         if a security manager exists and its
90ce3da70b43 Initial load
duke
parents:
diff changeset
   885
     *         {@link SecurityManager#checkPermission checkPermission}
90ce3da70b43 Initial load
duke
parents:
diff changeset
   886
     *         method doesn't allow access to the environment variable
90ce3da70b43 Initial load
duke
parents:
diff changeset
   887
     *         <code>name</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   888
     * @see    #getenv()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   889
     * @see    ProcessBuilder#environment()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   890
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   891
    public static String getenv(String name) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   892
        SecurityManager sm = getSecurityManager();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   893
        if (sm != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   894
            sm.checkPermission(new RuntimePermission("getenv."+name));
90ce3da70b43 Initial load
duke
parents:
diff changeset
   895
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   896
90ce3da70b43 Initial load
duke
parents:
diff changeset
   897
        return ProcessEnvironment.getenv(name);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   898
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   899
90ce3da70b43 Initial load
duke
parents:
diff changeset
   900
90ce3da70b43 Initial load
duke
parents:
diff changeset
   901
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   902
     * Returns an unmodifiable string map view of the current system environment.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   903
     * The environment is a system-dependent mapping from names to
90ce3da70b43 Initial load
duke
parents:
diff changeset
   904
     * values which is passed from parent to child processes.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   905
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   906
     * <p>If the system does not support environment variables, an
90ce3da70b43 Initial load
duke
parents:
diff changeset
   907
     * empty map is returned.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   908
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   909
     * <p>The returned map will never contain null keys or values.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   910
     * Attempting to query the presence of a null key or value will
90ce3da70b43 Initial load
duke
parents:
diff changeset
   911
     * throw a {@link NullPointerException}.  Attempting to query
90ce3da70b43 Initial load
duke
parents:
diff changeset
   912
     * the presence of a key or value which is not of type
90ce3da70b43 Initial load
duke
parents:
diff changeset
   913
     * {@link String} will throw a {@link ClassCastException}.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   914
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   915
     * <p>The returned map and its collection views may not obey the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   916
     * general contract of the {@link Object#equals} and
90ce3da70b43 Initial load
duke
parents:
diff changeset
   917
     * {@link Object#hashCode} methods.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   918
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   919
     * <p>The returned map is typically case-sensitive on all platforms.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   920
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   921
     * <p>If a security manager exists, its
90ce3da70b43 Initial load
duke
parents:
diff changeset
   922
     * {@link SecurityManager#checkPermission checkPermission}
90ce3da70b43 Initial load
duke
parents:
diff changeset
   923
     * method is called with a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   924
     * <code>{@link RuntimePermission}("getenv.*")</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   925
     * permission.  This may result in a {@link SecurityException} being
90ce3da70b43 Initial load
duke
parents:
diff changeset
   926
     * thrown.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   927
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   928
     * <p>When passing information to a Java subprocess,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   929
     * <a href=#EnvironmentVSSystemProperties>system properties</a>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   930
     * are generally preferred over environment variables.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   931
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   932
     * @return the environment as a map of variable names to values
90ce3da70b43 Initial load
duke
parents:
diff changeset
   933
     * @throws SecurityException
90ce3da70b43 Initial load
duke
parents:
diff changeset
   934
     *         if a security manager exists and its
90ce3da70b43 Initial load
duke
parents:
diff changeset
   935
     *         {@link SecurityManager#checkPermission checkPermission}
90ce3da70b43 Initial load
duke
parents:
diff changeset
   936
     *         method doesn't allow access to the process environment
90ce3da70b43 Initial load
duke
parents:
diff changeset
   937
     * @see    #getenv(String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   938
     * @see    ProcessBuilder#environment()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   939
     * @since  1.5
90ce3da70b43 Initial load
duke
parents:
diff changeset
   940
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   941
    public static java.util.Map<String,String> getenv() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   942
        SecurityManager sm = getSecurityManager();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   943
        if (sm != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   944
            sm.checkPermission(new RuntimePermission("getenv.*"));
90ce3da70b43 Initial load
duke
parents:
diff changeset
   945
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   946
90ce3da70b43 Initial load
duke
parents:
diff changeset
   947
        return ProcessEnvironment.getenv();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   948
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   949
90ce3da70b43 Initial load
duke
parents:
diff changeset
   950
    /**
33875
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   951
     * {@code System.Logger} instances log messages that will be
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   952
     * 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
   953
     * LoggerFinder} uses.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   954
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   955
     * {@code System.Logger} instances are typically obtained from
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   956
     * the {@link java.lang.System System} class, by calling
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   957
     * {@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
   958
     * 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
   959
     * System.getLogger(loggerName, bundle)}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   960
     *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   961
     * @see java.lang.System#getLogger(java.lang.String)
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   962
     * @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
   963
     * @see java.lang.System.LoggerFinder
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   964
     *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   965
     * @since 9
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   966
     *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   967
     */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   968
    public interface Logger {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   969
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   970
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   971
         * System {@linkplain Logger loggers} levels.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   972
         * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   973
         * A level has a {@linkplain #getName() name} and {@linkplain
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   974
         * #getSeverity() severity}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   975
         * Level values are {@link #ALL}, {@link #TRACE}, {@link #DEBUG},
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   976
         * {@link #INFO}, {@link #WARNING}, {@link #ERROR}, {@link #OFF},
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   977
         * by order of increasing severity.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   978
         * <br>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   979
         * {@link #ALL} and {@link #OFF}
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   980
         * are simple markers with severities mapped respectively to
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   981
         * {@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
   982
         * {@link java.lang.Integer#MAX_VALUE Integer.MAX_VALUE}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   983
         * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   984
         * <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
   985
         * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   986
         * {@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
   987
         * {@linkplain java.util.logging.Level  java.util.logging levels}
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   988
         * of corresponding severity.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   989
         * <br>The mapping is as follows:
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   990
         * <br><br>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   991
         * <table border="1">
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   992
         * <caption>System.Logger Severity Level Mapping</caption>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   993
         * <tr><td><b>System.Logger Levels</b></td>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   994
         * <td>{@link Logger.Level#ALL ALL}</td>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   995
         * <td>{@link Logger.Level#TRACE TRACE}</td>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   996
         * <td>{@link Logger.Level#DEBUG DEBUG}</td>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   997
         * <td>{@link Logger.Level#INFO INFO}</td>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   998
         * <td>{@link Logger.Level#WARNING WARNING}</td>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
   999
         * <td>{@link Logger.Level#ERROR ERROR}</td>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1000
         * <td>{@link Logger.Level#OFF OFF}</td>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1001
         * </tr>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1002
         * <tr><td><b>java.util.logging Levels</b></td>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1003
         * <td>{@link java.util.logging.Level#ALL ALL}</td>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1004
         * <td>{@link java.util.logging.Level#FINER FINER}</td>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1005
         * <td>{@link java.util.logging.Level#FINE FINE}</td>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1006
         * <td>{@link java.util.logging.Level#INFO INFO}</td>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1007
         * <td>{@link java.util.logging.Level#WARNING WARNING}</td>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1008
         * <td>{@link java.util.logging.Level#SEVERE SEVERE}</td>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1009
         * <td>{@link java.util.logging.Level#OFF OFF}</td>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1010
         * </tr>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1011
         * </table>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1012
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1013
         * @since 9
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1014
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1015
         * @see java.lang.System.LoggerFinder
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1016
         * @see java.lang.System.Logger
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1017
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1018
        public enum Level {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1019
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1020
            // 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
  1021
            // the mapping logic in sun.util.logging.PlatformLogger depends
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1022
            // on this.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1023
            /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1024
             * A marker to indicate that all levels are enabled.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1025
             * This level {@linkplain #getSeverity() severity} is
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1026
             * {@link Integer#MIN_VALUE}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1027
             */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1028
            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
  1029
            /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1030
             * {@code TRACE} level: usually used to log diagnostic information.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1031
             * This level {@linkplain #getSeverity() severity} is
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1032
             * {@code 400}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1033
             */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1034
            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
  1035
            /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1036
             * {@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
  1037
             * This level {@linkplain #getSeverity() severity} is
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1038
             * {@code 500}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1039
             */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1040
            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
  1041
            /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1042
             * {@code INFO} level: usually used to log information messages.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1043
             * This level {@linkplain #getSeverity() severity} is
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1044
             * {@code 800}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1045
             */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1046
            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
  1047
            /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1048
             * {@code WARNING} level: usually used to log warning messages.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1049
             * This level {@linkplain #getSeverity() severity} is
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1050
             * {@code 900}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1051
             */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1052
            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
  1053
            /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1054
             * {@code ERROR} level: usually used to log error messages.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1055
             * This level {@linkplain #getSeverity() severity} is
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1056
             * {@code 1000}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1057
             */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1058
            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
  1059
            /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1060
             * A marker to indicate that all levels are disabled.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1061
             * This level {@linkplain #getSeverity() severity} is
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1062
             * {@link Integer#MAX_VALUE}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1063
             */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1064
            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
  1065
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1066
            private final int severity;
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1067
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1068
            private Level(int severity) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1069
                this.severity = severity;
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1070
            }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1071
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1072
            /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1073
             * Returns the name of this level.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1074
             * @return this level {@linkplain #name()}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1075
             */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1076
            public final String getName() {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1077
                return name();
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1078
            }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1079
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1080
            /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1081
             * Returns the severity of this level.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1082
             * A higher severity means a more severe condition.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1083
             * @return this level severity.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1084
             */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1085
            public final int getSeverity() {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1086
                return severity;
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1087
            }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1088
        }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1089
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1090
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1091
         * Returns the name of this logger.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1092
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1093
         * @return the logger name.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1094
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1095
        public String getName();
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1096
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1097
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1098
         * 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
  1099
         * this logger.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1100
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1101
         * @param level the log message level.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1102
         * @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
  1103
         *         being logged.
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
         * @throws NullPointerException if {@code level} is {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1106
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1107
        public boolean isLoggable(Level level);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1108
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1109
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1110
         * Logs a message.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1111
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1112
         * @implSpec The default implementation for this method calls
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1113
         * {@code this.log(level, (ResourceBundle)null, msg, (Object[])null);}
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1114
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1115
         * @param level the log message level.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1116
         * @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
  1117
         * this logger is a {@link
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1118
         * LoggerFinder#getLocalizedLogger(java.lang.String, java.util.ResourceBundle, java.lang.Class)
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1119
         * localized logger}); can be {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1120
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1121
         * @throws NullPointerException if {@code level} is {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1122
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1123
        public default void log(Level level, String msg) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1124
            log(level, (ResourceBundle) null, msg, (Object[]) null);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1125
        }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1126
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1127
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1128
         * Logs a lazily supplied message.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1129
         * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1130
         * 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
  1131
         * 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
  1132
         * 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
  1133
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1134
         * @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
  1135
         * implementation for this method calls
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1136
         * {@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
  1137
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1138
         * @param level the log message level.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1139
         * @param msgSupplier a supplier function that produces a message.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1140
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1141
         * @throws NullPointerException if {@code level} is {@code null},
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1142
         *         or {@code msgSupplier} is {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1143
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1144
        public default void log(Level level, Supplier<String> msgSupplier) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1145
            Objects.requireNonNull(msgSupplier);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1146
            if (isLoggable(Objects.requireNonNull(level))) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1147
                log(level, (ResourceBundle) null, msgSupplier.get(), (Object[]) null);
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
        }
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
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1152
         * Logs a message produced from the given object.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1153
         * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1154
         * 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
  1155
         * 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
  1156
         * calling  toString on the given object.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1157
         * Otherwise, the object is not operated on.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1158
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1159
         * @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
  1160
         * implementation for this method calls
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1161
         * {@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
  1162
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1163
         * @param level the log message level.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1164
         * @param obj the object to log.
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
         * @throws NullPointerException if {@code level} is {@code null}, or
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1167
         *         {@code obj} is {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1168
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1169
        public default void log(Level level, Object obj) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1170
            Objects.requireNonNull(obj);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1171
            if (isLoggable(Objects.requireNonNull(level))) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1172
                this.log(level, (ResourceBundle) null, obj.toString(), (Object[]) null);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1173
            }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1174
        }
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
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1177
         * Logs a message associated with a given throwable.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1178
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1179
         * @implSpec The default implementation for this method calls
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1180
         * {@code this.log(level, (ResourceBundle)null, msg, thrown);}
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
         * @param level the log message level.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1183
         * @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
  1184
         * this logger is a {@link
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1185
         * LoggerFinder#getLocalizedLogger(java.lang.String, java.util.ResourceBundle, java.lang.Class)
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1186
         * localized logger}); can be {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1187
         * @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
  1188
         *        can be {@code null}.
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
         * @throws NullPointerException if {@code level} is {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1191
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1192
        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
  1193
            this.log(level, null, msg, thrown);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1194
        }
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
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1197
         * Logs a lazily supplied message associated with a given throwable.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1198
         * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1199
         * 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
  1200
         * 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
  1201
         * 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
  1202
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1203
         * @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
  1204
         * implementation for this method calls
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1205
         * {@code this.log(level, (ResourceBundle)null, msgSupplier.get(), thrown);}
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
         * @param level one of the log message level identifiers.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1208
         * @param msgSupplier a supplier function that produces a message.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1209
         * @param thrown a {@code Throwable} associated with log message;
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1210
         *               can be {@code null}.
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
         * @throws NullPointerException if {@code level} is {@code null}, or
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1213
         *                               {@code msgSupplier} is {@code null}.
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
        public default void log(Level level, Supplier<String> msgSupplier,
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1216
                Throwable thrown) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1217
            Objects.requireNonNull(msgSupplier);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1218
            if (isLoggable(Objects.requireNonNull(level))) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1219
                this.log(level, null, msgSupplier.get(), thrown);
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
        }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1222
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
         * Logs a message with an optional list of parameters.
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
         * @implSpec The default implementation for this method calls
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1227
         * {@code this.log(level, (ResourceBundle)null, format, params);}
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
         * @param level one of the log message level identifiers.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1230
         * @param format the string message format in {@link
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1231
         * 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
  1232
         * catalog, if this logger is a {@link
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1233
         * LoggerFinder#getLocalizedLogger(java.lang.String, java.util.ResourceBundle, java.lang.Class)
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1234
         * localized logger}); can be {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1235
         * @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
  1236
         * none).
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1237
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1238
         * @throws NullPointerException if {@code level} is {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1239
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1240
        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
  1241
            this.log(level, null, format, params);
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
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
         * Logs a localized message associated with a given throwable.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1246
         * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1247
         * 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
  1248
         * string is localized using the given resource bundle.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1249
         * Otherwise the {@code msg} string is not localized.
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 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
  1253
         * {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1254
         * @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
  1255
         *            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
  1256
         * @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
  1257
         *        can be {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1258
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1259
         * @throws NullPointerException if {@code level} is {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1260
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1261
        public void log(Level level, ResourceBundle bundle, String msg,
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1262
                Throwable thrown);
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 message with resource bundle and an optional list of
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1266
         * parameters.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1267
         * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1268
         * 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
  1269
         * string is localized using the given resource bundle.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1270
         * Otherwise the {@code format} string is not localized.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1271
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1272
         * @param level the log message level.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1273
         * @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
  1274
         * {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1275
         * @param format the string message format in {@link
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1276
         * 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
  1277
         * 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
  1278
         * @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
  1279
         * none).
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
         * @throws NullPointerException if {@code level} is {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1282
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1283
        public void log(Level level, ResourceBundle bundle, String format,
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1284
                Object... params);
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
    /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1290
     * The {@code LoggerFinder} service is responsible for creating, managing,
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1291
     * and configuring loggers to the underlying framework it uses.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1292
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1293
     * 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
  1294
     * zero-argument constructor and implements the abstract methods defined
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1295
     * by this class.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1296
     * 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
  1297
     * messages to the logging backend this provider supports.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1298
     * 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
  1299
     * system-wide LoggerFinder instance that is loaded as follows:
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1300
     * <ul>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1301
     *    <li>First it finds any custom {@code LoggerFinder} provider
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1302
     *        using the {@link java.util.ServiceLoader} facility with the
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1303
     *        {@linkplain ClassLoader#getSystemClassLoader() system class
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1304
     *        loader}.</li>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1305
     *    <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
  1306
     *        {@code LoggerFinder} implementation will be used.</li>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1307
     * </ul>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1308
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1309
     * An application can replace the logging backend
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1310
     * <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
  1311
     * and declaring an implementation of the {@link LoggerFinder} service.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1312
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1313
     * <b>Default Implementation</b>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1314
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1315
     * The system default {@code LoggerFinder} implementation uses
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1316
     * {@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
  1317
     * {@code java.logging} module is present.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1318
     * It returns a {@linkplain System.Logger logger} instance
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1319
     * 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
  1320
     * 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
  1321
     * present, the default implementation will return a simple logger
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1322
     * 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
  1323
     * the console ({@code System.err}).
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1324
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1325
     * <b>Logging Configuration</b>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1326
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1327
     * {@linkplain Logger Logger} instances obtained from the
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1328
     * {@code LoggerFinder} factory methods are not directly configurable by
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1329
     * the application. Configuration is the responsibility of the underlying
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1330
     * 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
  1331
     * <p>For the default {@code LoggerFinder} implementation
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1332
     * 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
  1333
     * {@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
  1334
     * For the default {@code LoggerFinder} implementation returning simple loggers
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1335
     * 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
  1336
     * is implementation dependent.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1337
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1338
     * 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
  1339
     * 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
  1340
     * 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
  1341
     * through the facade associated with that framework.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1342
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1343
     * 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
  1344
     * 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
  1345
     * framework selected by the application.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1346
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1347
     * 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
  1348
     * 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
  1349
     * 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
  1350
     * {@code LoggerFinder} service.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1351
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1352
     * 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
  1353
     * 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
  1354
     * backend without requiring permissions.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1355
     * <br>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1356
     * It is the responsibility of the provider of
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1357
     * the concrete {@code LoggerFinder} implementation to ensure that
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1358
     * 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
  1359
     * permission checks, as configuration performed on such loggers usually
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1360
     * affects all applications in the same Java Runtime.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1361
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1362
     * <b>Message Levels and Mapping to backend levels</b>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1363
     * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1364
     * 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
  1365
     * 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
  1366
     * <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
  1367
     * maps {@code System.Logger} levels to
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1368
     * {@linkplain java.util.logging.Level java.util.logging} levels
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1369
     * of corresponding severity - as described in {@link Logger.Level
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1370
     * Logger.Level}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1371
     *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1372
     * @see java.lang.System
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1373
     * @see java.lang.System.Logger
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1374
     *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1375
     * @since 9
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
    public static abstract class LoggerFinder {
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
         * The {@code RuntimePermission("loggerFinder")} is
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1380
         * necessary to subclass and instantiate the {@code LoggerFinder} class,
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1381
         * 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
  1382
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1383
        static final RuntimePermission LOGGERFINDER_PERMISSION =
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1384
                new RuntimePermission("loggerFinder");
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1385
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1386
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1387
         * Creates a new instance of {@code LoggerFinder}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1388
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1389
         * @implNote It is recommended that a {@code LoggerFinder} service
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1390
         *   implementation does not perform any heavy initialization in its
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1391
         *   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
  1392
         *   loading cycles during the instantiation of the service provider.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1393
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1394
         * @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
  1395
         *         {@code checkPermission} method doesn't allow the
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1396
         *         {@code RuntimePermission("loggerFinder")}.
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
        protected LoggerFinder() {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1399
            this(checkPermission());
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1400
        }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1401
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1402
        private LoggerFinder(Void unused) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1403
            // nothing to do.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1404
        }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1405
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1406
        private static Void checkPermission() {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1407
            final SecurityManager sm = System.getSecurityManager();
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1408
            if (sm != null) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1409
                sm.checkPermission(LOGGERFINDER_PERMISSION);
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
            return null;
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1412
        }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1413
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1414
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1415
         * Returns an instance of {@link Logger Logger}
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1416
         * for the given {@code caller}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1417
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1418
         * @param name the name of the logger.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1419
         * @param caller the class for which the logger is being requested;
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1420
         *               can be {@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
         * @return a {@link Logger logger} suitable for the given caller's
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1423
         *         use.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1424
         * @throws NullPointerException if {@code name} is {@code null} or
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1425
         *        {@code caller} is {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1426
         * @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
  1427
         *         {@code checkPermission} method doesn't allow the
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1428
         *         {@code RuntimePermission("loggerFinder")}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1429
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1430
        public abstract Logger getLogger(String name, /* Module */ Class<?> caller);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1431
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1432
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1433
         * Returns a localizable instance of {@link Logger Logger}
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1434
         * for the given {@code caller}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1435
         * 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
  1436
         * message localization.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1437
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1438
         * @implSpec By default, this method calls {@link
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1439
         * #getLogger(java.lang.String, java.lang.Class)
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1440
         * this.getLogger(name, caller)} to obtain a logger, then wraps that
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1441
         * 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
  1442
         * 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
  1443
         * which does - passing the given {@code bundle} for
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1444
         * localization. So for instance, a call to {@link
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1445
         * Logger#log(Level, String) Logger.log(Level.INFO, msg)}
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1446
         * will end up as a call to {@link
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1447
         * Logger#log(Level, ResourceBundle, String, Object...)
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1448
         * 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
  1449
         * logger instance.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1450
         * 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
  1451
         * 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
  1452
         * 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
  1453
         * already constructed, rather than keys in a resource bundle.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1454
         * <p>
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1455
         * An implementation of {@code LoggerFinder} may override this method,
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1456
         * 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
  1457
         * mechanism for localizing log messages, then such a
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1458
         * {@code LoggerFinder} would be free to return a logger
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1459
         * 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
  1460
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1461
         * @param name    the name of the logger.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1462
         * @param bundle  a resource bundle; can be {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1463
         * @param caller the class for which the logger is being requested.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1464
         * @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
  1465
         * provided resource bundle for message localization.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1466
         *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1467
         * @throws NullPointerException if {@code name} is {@code null} or
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1468
         *         {@code caller} is {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1469
         * @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
  1470
         *         {@code checkPermission} method doesn't allow the
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1471
         *         {@code RuntimePermission("loggerFinder")}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1472
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1473
        public Logger getLocalizedLogger(String name, ResourceBundle bundle,
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1474
                                          /* Module */ Class<?> caller) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1475
            return new LocalizedLoggerWrapper<>(getLogger(name, caller), bundle);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1476
        }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1477
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1478
        /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1479
         * Returns the {@code LoggerFinder} instance. There is one
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1480
         * single system-wide {@code LoggerFinder} instance in
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1481
         * 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
  1482
         * {@link LoggerFinder LoggerFinder} implementation is located and
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1483
         * loaded.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1484
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1485
         * @return the {@link LoggerFinder LoggerFinder} instance.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1486
         * @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
  1487
         *         {@code checkPermission} method doesn't allow the
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1488
         *         {@code RuntimePermission("loggerFinder")}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1489
         */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1490
        public static LoggerFinder getLoggerFinder() {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1491
            final SecurityManager sm = System.getSecurityManager();
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1492
            if (sm != null) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1493
                sm.checkPermission(LOGGERFINDER_PERMISSION);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1494
            }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1495
            return accessProvider();
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1496
        }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1497
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1498
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1499
        private static volatile LoggerFinder service;
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1500
        static LoggerFinder accessProvider() {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1501
            // We do not need to synchronize: LoggerFinderLoader will
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1502
            // 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
  1503
            // just fetch it again.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1504
            if (service == null) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1505
                PrivilegedAction<LoggerFinder> pa =
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1506
                        () -> LoggerFinderLoader.getLoggerFinder();
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1507
                service = AccessController.doPrivileged(pa, null,
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1508
                        LOGGERFINDER_PERMISSION);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1509
            }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1510
            return service;
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
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
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
    /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1517
     * 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
  1518
     * use.
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
     * @implSpec
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1521
     * Instances returned by this method route messages to loggers
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1522
     * obtained by calling {@link LoggerFinder#getLogger(java.lang.String, java.lang.Class)
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1523
     * LoggerFinder.getLogger(name, caller)}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1524
     *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1525
     * @apiNote
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1526
     * This method may defer calling the {@link
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1527
     * LoggerFinder#getLogger(java.lang.String, java.lang.Class)
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1528
     * 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
  1529
     * 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
  1530
     * the system initialization time.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1531
     *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1532
     * @param name the name of the logger.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1533
     * @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
  1534
     *         class.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1535
     * @throws NullPointerException if {@code name} is {@code null}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1536
     */
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1537
    @CallerSensitive
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1538
    public static Logger getLogger(String name) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1539
        Objects.requireNonNull(name);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1540
        final Class<?> caller = Reflection.getCallerClass();
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1541
        return LazyLoggers.getLogger(name, caller);
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
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1544
    /**
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1545
     * Returns a localizable instance of {@link Logger
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1546
     * Logger} for the caller's use.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1547
     * 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
  1548
     * localization.
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
     * @implSpec
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1551
     * The returned logger will perform message localization as specified
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1552
     * by {@link LoggerFinder#getLocalizedLogger(java.lang.String,
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1553
     * java.util.ResourceBundle, java.lang.Class)
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1554
     * LoggerFinder.getLocalizedLogger(name, bundle, caller}.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1555
     *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1556
     * @apiNote
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1557
     * 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
  1558
     * This method may trigger the immediate loading and initialization
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1559
     * 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
  1560
     * 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
  1561
     * implementation yet.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1562
     * 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
  1563
     * 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
  1564
     * {@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
  1565
     * take a resource bundle as parameter.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1566
     *
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1567
     * @param name    the name of the logger.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1568
     * @param bundle  a resource bundle.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1569
     * @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
  1570
     * resource bundle for message localization.
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1571
     * @throws NullPointerException if {@code name} is {@code null} or
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1572
     *         {@code bundle} is {@code null}.
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
    @CallerSensitive
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1575
    public static Logger getLogger(String name, ResourceBundle bundle) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1576
        final ResourceBundle rb = Objects.requireNonNull(bundle);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1577
        Objects.requireNonNull(name);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1578
        final Class<?> caller = Reflection.getCallerClass();
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1579
        final SecurityManager sm = System.getSecurityManager();
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1580
        // 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
  1581
        // 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
  1582
        // 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
  1583
        if (sm != null) {
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1584
            return AccessController.doPrivileged((PrivilegedAction<Logger>)
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1585
                    () -> LoggerFinder.accessProvider().getLocalizedLogger(name, rb, caller),
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1586
                    null,
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1587
                    LoggerFinder.LOGGERFINDER_PERMISSION);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1588
        }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1589
        return LoggerFinder.accessProvider().getLocalizedLogger(name, rb, caller);
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1590
    }
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1591
c1c71107d45f 8140364: JEP 264 Platform Logger API and Service Implementation
dfuchs
parents: 32834
diff changeset
  1592
    /**
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1593
     * Terminates the currently running Java Virtual Machine. The
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1594
     * argument serves as a status code; by convention, a nonzero status
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1595
     * code indicates abnormal termination.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1596
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1597
     * This method calls the <code>exit</code> method in class
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1598
     * <code>Runtime</code>. This method never returns normally.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1599
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1600
     * The call <code>System.exit(n)</code> is effectively equivalent to
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1601
     * the call:
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1602
     * <blockquote><pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1603
     * Runtime.getRuntime().exit(n)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1604
     * </pre></blockquote>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1605
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1606
     * @param      status   exit status.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1607
     * @throws  SecurityException
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1608
     *        if a security manager exists and its <code>checkExit</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1609
     *        method doesn't allow exit with the specified status.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1610
     * @see        java.lang.Runtime#exit(int)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1611
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1612
    public static void exit(int status) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1613
        Runtime.getRuntime().exit(status);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1614
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1615
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1616
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1617
     * Runs the garbage collector.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1618
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1619
     * Calling the <code>gc</code> method suggests that the Java Virtual
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1620
     * Machine expend effort toward recycling unused objects in order to
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1621
     * make the memory they currently occupy available for quick reuse.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1622
     * When control returns from the method call, the Java Virtual
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1623
     * Machine has made a best effort to reclaim space from all discarded
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1624
     * objects.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1625
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1626
     * The call <code>System.gc()</code> is effectively equivalent to the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1627
     * call:
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1628
     * <blockquote><pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1629
     * Runtime.getRuntime().gc()
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1630
     * </pre></blockquote>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1631
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1632
     * @see     java.lang.Runtime#gc()
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1633
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1634
    public static void gc() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1635
        Runtime.getRuntime().gc();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1636
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1637
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1638
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1639
     * Runs the finalization methods of any objects pending finalization.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1640
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1641
     * Calling this method suggests that the Java Virtual Machine expend
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1642
     * effort toward running the <code>finalize</code> methods of objects
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1643
     * that have been found to be discarded but whose <code>finalize</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1644
     * methods have not yet been run. When control returns from the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1645
     * method call, the Java Virtual Machine has made a best effort to
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1646
     * complete all outstanding finalizations.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1647
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1648
     * The call <code>System.runFinalization()</code> is effectively
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1649
     * equivalent to the call:
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1650
     * <blockquote><pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1651
     * Runtime.getRuntime().runFinalization()
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1652
     * </pre></blockquote>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1653
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1654
     * @see     java.lang.Runtime#runFinalization()
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1655
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1656
    public static void runFinalization() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1657
        Runtime.getRuntime().runFinalization();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1658
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1659
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1660
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1661
     * Enable or disable finalization on exit; doing so specifies that the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1662
     * finalizers of all objects that have finalizers that have not yet been
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1663
     * automatically invoked are to be run before the Java runtime exits.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1664
     * By default, finalization on exit is disabled.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1665
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1666
     * <p>If there is a security manager,
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1667
     * its <code>checkExit</code> method is first called
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1668
     * with 0 as its argument to ensure the exit is allowed.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1669
     * This could result in a SecurityException.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1670
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1671
     * @deprecated  This method is inherently unsafe.  It may result in
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1672
     *      finalizers being called on live objects while other threads are
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1673
     *      concurrently manipulating those objects, resulting in erratic
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1674
     *      behavior or deadlock.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1675
     * @param value indicating enabling or disabling of finalization
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1676
     * @throws  SecurityException
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1677
     *        if a security manager exists and its <code>checkExit</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1678
     *        method doesn't allow the exit.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1679
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1680
     * @see     java.lang.Runtime#exit(int)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1681
     * @see     java.lang.Runtime#gc()
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1682
     * @see     java.lang.SecurityManager#checkExit(int)
24865
09b1d992ca72 8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents: 24367
diff changeset
  1683
     * @since   1.1
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1684
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1685
    @Deprecated
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1686
    public static void runFinalizersOnExit(boolean value) {
11275
7cb0861d512f 7117612: Miscellaneous warnings in java.lang
omajid
parents: 11117
diff changeset
  1687
        Runtime.runFinalizersOnExit(value);
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1688
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1689
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1690
    /**
16479
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1691
     * 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
  1692
     * 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
  1693
     *
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1694
     * 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
  1695
     * 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
  1696
     * 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
  1697
     * 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
  1698
     * 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
  1699
     * 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
  1700
     * file system.
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1701
     * See the JNI Specification for more details.
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1702
     *
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1703
     * 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
  1704
     * an implementation-dependent manner.
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1705
     *
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1706
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1707
     * The call <code>System.load(name)</code> is effectively equivalent
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1708
     * to the call:
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1709
     * <blockquote><pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1710
     * Runtime.getRuntime().load(name)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1711
     * </pre></blockquote>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1712
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1713
     * @param      filename   the file to load.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1714
     * @exception  SecurityException  if a security manager exists and its
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1715
     *             <code>checkLink</code> method doesn't allow
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1716
     *             loading of the specified dynamic library
16479
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1717
     * @exception  UnsatisfiedLinkError  if either the filename is not an
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1718
     *             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
  1719
     *             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
  1720
     *             a native library image by the host system.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1721
     * @exception  NullPointerException if <code>filename</code> is
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1722
     *             <code>null</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1723
     * @see        java.lang.Runtime#load(java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1724
     * @see        java.lang.SecurityManager#checkLink(java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1725
     */
16906
44dfee24cb71 8010117: Annotate jdk caller sensitive methods with @sun.reflect.CallerSensitive
mchung
parents: 16479
diff changeset
  1726
    @CallerSensitive
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1727
    public static void load(String filename) {
16906
44dfee24cb71 8010117: Annotate jdk caller sensitive methods with @sun.reflect.CallerSensitive
mchung
parents: 16479
diff changeset
  1728
        Runtime.getRuntime().load0(Reflection.getCallerClass(), filename);
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1729
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1730
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1731
    /**
16479
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1732
     * Loads the native library specified by the <code>libname</code>
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1733
     * argument.  The <code>libname</code> argument must not contain any platform
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1734
     * specific prefix, file extension or path. If a native library
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1735
     * called <code>libname</code> is statically linked with the VM, then the
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1736
     * JNI_OnLoad_<code>libname</code> function exported by the library is invoked.
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1737
     * See the JNI Specification for more details.
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1738
     *
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1739
     * 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
  1740
     * 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
  1741
     * dependent manner.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1742
     * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1743
     * The call <code>System.loadLibrary(name)</code> is effectively
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1744
     * equivalent to the call
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1745
     * <blockquote><pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1746
     * Runtime.getRuntime().loadLibrary(name)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1747
     * </pre></blockquote>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1748
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1749
     * @param      libname   the name of the library.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1750
     * @exception  SecurityException  if a security manager exists and its
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1751
     *             <code>checkLink</code> method doesn't allow
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1752
     *             loading of the specified dynamic library
16479
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1753
     * @exception  UnsatisfiedLinkError if either the libname argument
d845c18d13f2 8005716: Enhance JNI specification to allow support of static JNI libraries in Embedded JREs
alanb
parents: 15511
diff changeset
  1754
     *             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
  1755
     *             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
  1756
     *             native library image by the host system.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1757
     * @exception  NullPointerException if <code>libname</code> is
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1758
     *             <code>null</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1759
     * @see        java.lang.Runtime#loadLibrary(java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1760
     * @see        java.lang.SecurityManager#checkLink(java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1761
     */
16906
44dfee24cb71 8010117: Annotate jdk caller sensitive methods with @sun.reflect.CallerSensitive
mchung
parents: 16479
diff changeset
  1762
    @CallerSensitive
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1763
    public static void loadLibrary(String libname) {
16906
44dfee24cb71 8010117: Annotate jdk caller sensitive methods with @sun.reflect.CallerSensitive
mchung
parents: 16479
diff changeset
  1764
        Runtime.getRuntime().loadLibrary0(Reflection.getCallerClass(), libname);
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1765
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1766
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1767
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1768
     * Maps a library name into a platform-specific string representing
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1769
     * a native library.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1770
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1771
     * @param      libname the name of the library.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1772
     * @return     a platform-dependent native library name.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1773
     * @exception  NullPointerException if <code>libname</code> is
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1774
     *             <code>null</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1775
     * @see        java.lang.System#loadLibrary(java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1776
     * @see        java.lang.ClassLoader#findLibrary(java.lang.String)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1777
     * @since      1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1778
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1779
    public static native String mapLibraryName(String libname);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1780
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1781
    /**
11906
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1782
     * Create PrintStream for stdout/err based on encoding.
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1783
     */
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1784
    private static PrintStream newPrintStream(FileOutputStream fos, String enc) {
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1785
       if (enc != null) {
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1786
            try {
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1787
                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
  1788
            } catch (UnsupportedEncodingException uee) {}
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1789
        }
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1790
        return new PrintStream(new BufferedOutputStream(fos, 128), true);
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1791
    }
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1792
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1793
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1794
    /**
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1795
     * Initialize the system class.  Called after thread initialization.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1796
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1797
    private static void initializeSystemClass() {
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
  1798
0a7dab5d5922 6999337: java.exe fails to start if some directory names in path to java binaries contain Russian characters
sherman
parents: 7668
diff changeset
  1799
        // 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
  1800
        // sensitive properties (user.home, user.name, boot.class.path, etc.)
0a7dab5d5922 6999337: java.exe fails to start if some directory names in path to java binaries contain Russian characters
sherman
parents: 7668
diff changeset
  1801
        // during "props" initialization, in which it may need access, via
0a7dab5d5922 6999337: java.exe fails to start if some directory names in path to java binaries contain Russian characters
sherman
parents: 7668
diff changeset
  1802
        // System.getProperty(), to the related system encoding property that
0a7dab5d5922 6999337: java.exe fails to start if some directory names in path to java binaries contain Russian characters
sherman
parents: 7668
diff changeset
  1803
        // have been initialized (put into "props") at early stage of the
0a7dab5d5922 6999337: java.exe fails to start if some directory names in path to java binaries contain Russian characters
sherman
parents: 7668
diff changeset
  1804
        // initialization. So make sure the "props" is available at the
0a7dab5d5922 6999337: java.exe fails to start if some directory names in path to java binaries contain Russian characters
sherman
parents: 7668
diff changeset
  1805
        // very beginning of the initialization and all system properties to
0a7dab5d5922 6999337: java.exe fails to start if some directory names in path to java binaries contain Russian characters
sherman
parents: 7668
diff changeset
  1806
        // be put into it directly.
0a7dab5d5922 6999337: java.exe fails to start if some directory names in path to java binaries contain Russian characters
sherman
parents: 7668
diff changeset
  1807
        props = new Properties();
0a7dab5d5922 6999337: java.exe fails to start if some directory names in path to java binaries contain Russian characters
sherman
parents: 7668
diff changeset
  1808
        initProperties(props);  // initialized by the VM
0a7dab5d5922 6999337: java.exe fails to start if some directory names in path to java binaries contain Russian characters
sherman
parents: 7668
diff changeset
  1809
6882
637546039be3 6977738: Deadlock between java.lang.ClassLoader and java.util.Properties
mchung
parents: 6668
diff changeset
  1810
        // 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
  1811
        // 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
  1812
        // 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
  1813
        // 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
  1814
        // 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
  1815
        // internal implementation use only, these properties should be
637546039be3 6977738: Deadlock between java.lang.ClassLoader and java.util.Properties
mchung
parents: 6668
diff changeset
  1816
        // removed from the system properties.
637546039be3 6977738: Deadlock between java.lang.ClassLoader and java.util.Properties
mchung
parents: 6668
diff changeset
  1817
        //
637546039be3 6977738: Deadlock between java.lang.ClassLoader and java.util.Properties
mchung
parents: 6668
diff changeset
  1818
        // See java.lang.Integer.IntegerCache and the
637546039be3 6977738: Deadlock between java.lang.ClassLoader and java.util.Properties
mchung
parents: 6668
diff changeset
  1819
        // sun.misc.VM.saveAndRemoveProperties method for example.
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
  1820
        //
0a7dab5d5922 6999337: java.exe fails to start if some directory names in path to java binaries contain Russian characters
sherman
parents: 7668
diff changeset
  1821
        // Save a private copy of the system properties object that
0a7dab5d5922 6999337: java.exe fails to start if some directory names in path to java binaries contain Russian characters
sherman
parents: 7668
diff changeset
  1822
        // can only be accessed by the internal implementation.  Remove
0a7dab5d5922 6999337: java.exe fails to start if some directory names in path to java binaries contain Russian characters
sherman
parents: 7668
diff changeset
  1823
        // certain system properties that are not intended for public access.
0a7dab5d5922 6999337: java.exe fails to start if some directory names in path to java binaries contain Russian characters
sherman
parents: 7668
diff changeset
  1824
        sun.misc.VM.saveAndRemoveProperties(props);
0a7dab5d5922 6999337: java.exe fails to start if some directory names in path to java binaries contain Russian characters
sherman
parents: 7668
diff changeset
  1825
6882
637546039be3 6977738: Deadlock between java.lang.ClassLoader and java.util.Properties
mchung
parents: 6668
diff changeset
  1826
4355
12d58d6de82f 6900043: Add method to return line.separator property
martin
parents: 3288
diff changeset
  1827
        lineSeparator = props.getProperty("line.separator");
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1828
        sun.misc.Version.init();
2425
99a19a90813e 6807702: Integer.valueOf cache should be configurable
alanb
parents: 2288
diff changeset
  1829
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1830
        FileInputStream fdIn = new FileInputStream(FileDescriptor.in);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1831
        FileOutputStream fdOut = new FileOutputStream(FileDescriptor.out);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1832
        FileOutputStream fdErr = new FileOutputStream(FileDescriptor.err);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1833
        setIn0(new BufferedInputStream(fdIn));
11906
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1834
        setOut0(newPrintStream(fdOut, props.getProperty("sun.stdout.encoding")));
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1835
        setErr0(newPrintStream(fdErr, props.getProperty("sun.stderr.encoding")));
dc984e35d8a6 4153167: separate between ANSI and OEM code pages on Windows
sherman
parents: 11275
diff changeset
  1836
6668
bf6309ced0b6 6888546: restore System.initializeSystemClasses
mchung
parents: 6001
diff changeset
  1837
        // Load the zip library now in order to keep java.util.zip.ZipFile
bf6309ced0b6 6888546: restore System.initializeSystemClasses
mchung
parents: 6001
diff changeset
  1838
        // from trying to use itself to load this library later.
bf6309ced0b6 6888546: restore System.initializeSystemClasses
mchung
parents: 6001
diff changeset
  1839
        loadLibrary("zip");
bf6309ced0b6 6888546: restore System.initializeSystemClasses
mchung
parents: 6001
diff changeset
  1840
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1841
        // Setup Java signal handlers for HUP, TERM, and INT (where available).
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1842
        Terminator.setup();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1843
25979
42e5d9f8087e 8054857: Fix typos in java.lang.** packages
prappo
parents: 25660
diff changeset
  1844
        // Initialize any miscellaneous operating system settings that need to be
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1845
        // set for the class libraries. Currently this is no-op everywhere except
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1846
        // for Windows where the process-wide error mode is set before the java.io
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1847
        // classes are used.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1848
        sun.misc.VM.initializeOSEnvironment();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1849
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1850
        // The main thread is not added to its thread group in the same
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1851
        // way as other threads; we must do it ourselves here.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1852
        Thread current = Thread.currentThread();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1853
        current.getThreadGroup().add(current);
6668
bf6309ced0b6 6888546: restore System.initializeSystemClasses
mchung
parents: 6001
diff changeset
  1854
bf6309ced0b6 6888546: restore System.initializeSystemClasses
mchung
parents: 6001
diff changeset
  1855
        // register shared secrets
bf6309ced0b6 6888546: restore System.initializeSystemClasses
mchung
parents: 6001
diff changeset
  1856
        setJavaLangAccess();
12038
ba8cfc6c5118 7149320: Move sun.misc.VM.booted() to the end of System.initializeSystemClass()
mduigou
parents: 11906
diff changeset
  1857
ba8cfc6c5118 7149320: Move sun.misc.VM.booted() to the end of System.initializeSystemClass()
mduigou
parents: 11906
diff changeset
  1858
        // Subsystems that are invoked during initialization can invoke
ba8cfc6c5118 7149320: Move sun.misc.VM.booted() to the end of System.initializeSystemClass()
mduigou
parents: 11906
diff changeset
  1859
        // sun.misc.VM.isBooted() in order to avoid doing things that should
ba8cfc6c5118 7149320: Move sun.misc.VM.booted() to the end of System.initializeSystemClass()
mduigou
parents: 11906
diff changeset
  1860
        // wait until the application class loader has been set up.
ba8cfc6c5118 7149320: Move sun.misc.VM.booted() to the end of System.initializeSystemClass()
mduigou
parents: 11906
diff changeset
  1861
        // IMPORTANT: Ensure that this remains the last initialization action!
ba8cfc6c5118 7149320: Move sun.misc.VM.booted() to the end of System.initializeSystemClass()
mduigou
parents: 11906
diff changeset
  1862
        sun.misc.VM.booted();
3111
fefdeafb7ab9 6797688: Umbrella: Merge all JDK 6u4 - 6u12 deployment code into JDK7
herrick
parents: 2703
diff changeset
  1863
    }
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1864
3111
fefdeafb7ab9 6797688: Umbrella: Merge all JDK 6u4 - 6u12 deployment code into JDK7
herrick
parents: 2703
diff changeset
  1865
    private static void setJavaLangAccess() {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1866
        // Allow privileged classes outside of java.lang
32834
e1dca5fe4de3 8137056: Move SharedSecrets and interface friends out of sun.misc
chegar
parents: 32649
diff changeset
  1867
        SharedSecrets.setJavaLangAccess(new JavaLangAccess(){
11117
b6e68b1344d4 7116404: Miscellaneous warnings (java.rmi.**, serialization, some core classes)
alanb
parents: 10360
diff changeset
  1868
            public sun.reflect.ConstantPool getConstantPool(Class<?> klass) {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1869
                return klass.getConstantPool();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1870
            }
18827
ecbd9c8bef12 7122142: (ann) Race condition between isAnnotationPresent and getAnnotations
plevart
parents: 18546
diff changeset
  1871
            public boolean casAnnotationType(Class<?> klass, AnnotationType oldType, AnnotationType newType) {
ecbd9c8bef12 7122142: (ann) Race condition between isAnnotationPresent and getAnnotations
plevart
parents: 18546
diff changeset
  1872
                return klass.casAnnotationType(oldType, newType);
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1873
            }
11117
b6e68b1344d4 7116404: Miscellaneous warnings (java.rmi.**, serialization, some core classes)
alanb
parents: 10360
diff changeset
  1874
            public AnnotationType getAnnotationType(Class<?> klass) {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1875
                return klass.getAnnotationType();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1876
            }
21358
d41ff832d4f6 8027170: Annotations declared on super-super-class should be overridden by super-class.
alundblad
parents: 20831
diff changeset
  1877
            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
  1878
                return klass.getDeclaredAnnotationMap();
d41ff832d4f6 8027170: Annotations declared on super-super-class should be overridden by super-class.
alundblad
parents: 20831
diff changeset
  1879
            }
18827
ecbd9c8bef12 7122142: (ann) Race condition between isAnnotationPresent and getAnnotations
plevart
parents: 18546
diff changeset
  1880
            public byte[] getRawClassAnnotations(Class<?> klass) {
ecbd9c8bef12 7122142: (ann) Race condition between isAnnotationPresent and getAnnotations
plevart
parents: 18546
diff changeset
  1881
                return klass.getRawAnnotations();
ecbd9c8bef12 7122142: (ann) Race condition between isAnnotationPresent and getAnnotations
plevart
parents: 18546
diff changeset
  1882
            }
15510
898d924a7efd 8004698: Implement Core Reflection for Type Annotations
jfranck
parents: 14676
diff changeset
  1883
            public byte[] getRawClassTypeAnnotations(Class<?> klass) {
898d924a7efd 8004698: Implement Core Reflection for Type Annotations
jfranck
parents: 14676
diff changeset
  1884
                return klass.getRawTypeAnnotations();
898d924a7efd 8004698: Implement Core Reflection for Type Annotations
jfranck
parents: 14676
diff changeset
  1885
            }
898d924a7efd 8004698: Implement Core Reflection for Type Annotations
jfranck
parents: 14676
diff changeset
  1886
            public byte[] getRawExecutableTypeAnnotations(Executable executable) {
898d924a7efd 8004698: Implement Core Reflection for Type Annotations
jfranck
parents: 14676
diff changeset
  1887
                return Class.getExecutableTypeAnnotationBytes(executable);
898d924a7efd 8004698: Implement Core Reflection for Type Annotations
jfranck
parents: 14676
diff changeset
  1888
            }
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1889
            public <E extends Enum<E>>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1890
                    E[] getEnumConstantsShared(Class<E> klass) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1891
                return klass.getEnumConstantsShared();
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1892
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1893
            public void blockedOn(Thread t, Interruptible b) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1894
                t.blockedOn(b);
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1895
            }
2703
acd4d6a53e3e 6829503: addShutdownHook fails if called after shutdown has commenced.
mchung
parents: 2425
diff changeset
  1896
            public void registerShutdownHook(int slot, boolean registerShutdownInProgress, Runnable hook) {
acd4d6a53e3e 6829503: addShutdownHook fails if called after shutdown has commenced.
mchung
parents: 2425
diff changeset
  1897
                Shutdown.add(slot, registerShutdownInProgress, hook);
2277
445a331b4a8b 6810254: Lazily instantiate the shared secret access objects
mchung
parents: 2
diff changeset
  1898
            }
2947
b0135c99348e 6511515: poor performance of LogRecord.inferCaller depending on java.lang.Throwable.getStackTraceElement
martin
parents: 2703
diff changeset
  1899
            public int getStackTraceDepth(Throwable t) {
b0135c99348e 6511515: poor performance of LogRecord.inferCaller depending on java.lang.Throwable.getStackTraceElement
martin
parents: 2703
diff changeset
  1900
                return t.getStackTraceDepth();
b0135c99348e 6511515: poor performance of LogRecord.inferCaller depending on java.lang.Throwable.getStackTraceElement
martin
parents: 2703
diff changeset
  1901
            }
b0135c99348e 6511515: poor performance of LogRecord.inferCaller depending on java.lang.Throwable.getStackTraceElement
martin
parents: 2703
diff changeset
  1902
            public StackTraceElement getStackTraceElement(Throwable t, int i) {
b0135c99348e 6511515: poor performance of LogRecord.inferCaller depending on java.lang.Throwable.getStackTraceElement
martin
parents: 2703
diff changeset
  1903
                return t.getStackTraceElement(i);
b0135c99348e 6511515: poor performance of LogRecord.inferCaller depending on java.lang.Throwable.getStackTraceElement
martin
parents: 2703
diff changeset
  1904
            }
17426
45db19517346 8013528: Provide SharedSecrets access to String(char[], boolean) constructor
mduigou
parents: 16906
diff changeset
  1905
            public String newStringUnsafe(char[] chars) {
45db19517346 8013528: Provide SharedSecrets access to String(char[], boolean) constructor
mduigou
parents: 16906
diff changeset
  1906
                return new String(chars, true);
45db19517346 8013528: Provide SharedSecrets access to String(char[], boolean) constructor
mduigou
parents: 16906
diff changeset
  1907
            }
20805
ae41216325dd 8013739: Better LDAP resource management
weijun
parents: 18546
diff changeset
  1908
            public Thread newThreadWithAcc(Runnable target, AccessControlContext acc) {
ae41216325dd 8013739: Better LDAP resource management
weijun
parents: 18546
diff changeset
  1909
                return new Thread(target, acc);
ae41216325dd 8013739: Better LDAP resource management
weijun
parents: 18546
diff changeset
  1910
            }
21628
50fd58446d64 8027351: (ref) Private finalize method invoked in preference to protected superclass method
mchung
parents: 21358
diff changeset
  1911
            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
  1912
                o.finalize();
50fd58446d64 8027351: (ref) Private finalize method invoked in preference to protected superclass method
mchung
parents: 21358
diff changeset
  1913
            }
25660
01fa3ccedf50 8050114: Expose Integer/Long formatUnsigned methods internally
redestad
parents: 24865
diff changeset
  1914
            public void formatUnsignedLong(long val, int shift, char[] buf, int offset, int len) {
01fa3ccedf50 8050114: Expose Integer/Long formatUnsigned methods internally
redestad
parents: 24865
diff changeset
  1915
                Long.formatUnsignedLong(val, shift, buf, offset, len);
01fa3ccedf50 8050114: Expose Integer/Long formatUnsigned methods internally
redestad
parents: 24865
diff changeset
  1916
            }
01fa3ccedf50 8050114: Expose Integer/Long formatUnsigned methods internally
redestad
parents: 24865
diff changeset
  1917
            public void formatUnsignedInt(int val, int shift, char[] buf, int offset, int len) {
01fa3ccedf50 8050114: Expose Integer/Long formatUnsigned methods internally
redestad
parents: 24865
diff changeset
  1918
                Integer.formatUnsignedInt(val, shift, buf, offset, len);
01fa3ccedf50 8050114: Expose Integer/Long formatUnsigned methods internally
redestad
parents: 24865
diff changeset
  1919
            }
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1920
        });
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1921
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1922
}