langtools/src/share/classes/com/sun/tools/javac/util/Assert.java
author jlahoda
Fri, 01 Aug 2014 11:09:40 -0700
changeset 25848 3bc09f4676a9
parent 8032 e1aa25ccdabb
permissions -rw-r--r--
8043643: Add an crules analyzer avoiding string concatenation in messages of Assert checks. Summary: Generalizing the crules infrastructure, adding a new analyzer to check String concatenation in Assert calls. Reviewed-by: jjg, vromero
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
8032
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
     1
/*
25848
3bc09f4676a9 8043643: Add an crules analyzer avoiding string concatenation in messages of Assert checks.
jlahoda
parents: 8032
diff changeset
     2
 * Copyright (c) 2011, 2014, Oracle and/or its affiliates. All rights reserved.
8032
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
     4
 *
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    10
 *
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    15
 * accompanied this code).
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    16
 *
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    20
 *
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    23
 * questions.
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    24
 */
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    25
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    26
package com.sun.tools.javac.util;
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    27
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    28
/**
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    29
 * Simple facility for unconditional assertions.
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    30
 * The methods in this class are described in terms of equivalent assert
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    31
 * statements, assuming that assertions have been enabled.
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    32
 *
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    33
 *  <p><b>This is NOT part of any supported API.
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    34
 *  If you write code that depends on this, you do so at your own risk.
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    35
 *  This code and its internal interfaces are subject to change or
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    36
 *  deletion without notice.</b>
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    37
 */
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    38
public class Assert {
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    39
    /** Equivalent to
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    40
     *   assert cond;
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    41
     */
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    42
    public static void check(boolean cond) {
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    43
        if (!cond)
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    44
            error();
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    45
    }
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    46
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    47
    /** Equivalent to
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    48
     *   assert (o == null);
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    49
     */
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    50
    public static void checkNull(Object o) {
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    51
        if (o != null)
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    52
            error();
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    53
    }
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    54
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    55
    /** Equivalent to
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    56
     *   assert (t != null); return t;
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    57
     */
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    58
    public static <T> T checkNonNull(T t) {
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    59
        if (t == null)
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    60
            error();
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    61
        return t;
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    62
    }
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    63
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    64
    /** Equivalent to
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    65
     *   assert cond : value;
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    66
     */
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    67
    public static void check(boolean cond, int value) {
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    68
        if (!cond)
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    69
            error(String.valueOf(value));
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    70
    }
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    71
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    72
    /** Equivalent to
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    73
     *   assert cond : value;
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    74
     */
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    75
    public static void check(boolean cond, long value) {
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    76
        if (!cond)
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    77
            error(String.valueOf(value));
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    78
    }
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    79
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    80
    /** Equivalent to
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    81
     *   assert cond : value;
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    82
     */
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    83
    public static void check(boolean cond, Object value) {
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    84
        if (!cond)
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    85
            error(String.valueOf(value));
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    86
    }
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    87
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    88
    /** Equivalent to
25848
3bc09f4676a9 8043643: Add an crules analyzer avoiding string concatenation in messages of Assert checks.
jlahoda
parents: 8032
diff changeset
    89
     *   assert cond : msg;
8032
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    90
     */
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    91
    public static void check(boolean cond, String msg) {
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    92
        if (!cond)
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    93
            error(msg);
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    94
    }
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    95
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    96
    /** Equivalent to
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    97
     *   assert (o == null) : value;
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    98
     */
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
    99
    public static void checkNull(Object o, Object value) {
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   100
        if (o != null)
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   101
            error(String.valueOf(value));
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   102
    }
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   103
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   104
    /** Equivalent to
25848
3bc09f4676a9 8043643: Add an crules analyzer avoiding string concatenation in messages of Assert checks.
jlahoda
parents: 8032
diff changeset
   105
     *   assert (o == null) : msg;
8032
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   106
     */
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   107
    public static void checkNull(Object o, String msg) {
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   108
        if (o != null)
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   109
            error(msg);
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   110
    }
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   111
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   112
    /** Equivalent to
25848
3bc09f4676a9 8043643: Add an crules analyzer avoiding string concatenation in messages of Assert checks.
jlahoda
parents: 8032
diff changeset
   113
     *   assert (o != null) : msg;
8032
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   114
     */
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   115
    public static <T> T checkNonNull(T t, String msg) {
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   116
        if (t == null)
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   117
            error(msg);
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   118
        return t;
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   119
    }
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   120
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   121
    /** Equivalent to
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   122
     *   assert false;
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   123
     */
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   124
    public static void error() {
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   125
        throw new AssertionError();
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   126
    }
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   127
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   128
    /** Equivalent to
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   129
     *   assert false : msg;
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   130
     */
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   131
    public static void error(String msg) {
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   132
        throw new AssertionError(msg);
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   133
    }
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   134
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   135
    /** Prevent instantiation. */
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   136
    private Assert() { }
e1aa25ccdabb 6396503: javac should not require assertions enabled
jjg
parents:
diff changeset
   137
}