Thu, 18 Apr 2013 20:00:14 -0700
8012656: cache frequently used name strings for DocImpl classes
Reviewed-by: darcy
duke@1 | 1 | /* |
jjg@1358 | 2 | * Copyright (c) 2000, 2012, Oracle and/or its affiliates. All rights reserved. |
duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@1 | 4 | * |
duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
duke@1 | 10 | * |
duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 15 | * accompanied this code). |
duke@1 | 16 | * |
duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 20 | * |
ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@554 | 23 | * questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package com.sun.tools.javadoc; |
duke@1 | 27 | |
duke@1 | 28 | import static com.sun.tools.javac.code.Flags.*; |
duke@1 | 29 | |
duke@1 | 30 | /** |
duke@1 | 31 | * A class whose instances are filters over Modifier bits. |
duke@1 | 32 | * Filtering is done by returning boolean values. |
duke@1 | 33 | * Classes, methods and fields can be filtered, or filtering |
duke@1 | 34 | * can be done directly on modifier bits. |
jjg@1359 | 35 | * |
jjg@1359 | 36 | * <p><b>This is NOT part of any supported API. |
jjg@1359 | 37 | * If you write code that depends on this, you do so at your own risk. |
jjg@1359 | 38 | * This code and its internal interfaces are subject to change or |
jjg@1359 | 39 | * deletion without notice.</b> |
jjg@1359 | 40 | * |
jjg@1358 | 41 | * @see com.sun.tools.javac.code.Flags |
duke@1 | 42 | * @author Robert Field |
duke@1 | 43 | */ |
duke@1 | 44 | |
duke@1 | 45 | public class ModifierFilter { |
duke@1 | 46 | |
duke@1 | 47 | /** |
duke@1 | 48 | * Package private access. |
duke@1 | 49 | * A "pseudo-" modifier bit that can be used in the |
duke@1 | 50 | * constructors of this class to specify package private |
duke@1 | 51 | * access. This is needed since there is no Modifier.PACKAGE. |
duke@1 | 52 | */ |
duke@1 | 53 | public static final long PACKAGE = 0x8000000000000000L; |
duke@1 | 54 | |
duke@1 | 55 | /** |
duke@1 | 56 | * All access modifiers. |
duke@1 | 57 | * A short-hand set of modifier bits that can be used in the |
duke@1 | 58 | * constructors of this class to specify all access modifiers, |
duke@1 | 59 | * Same as PRIVATE | PROTECTED | PUBLIC | PACKAGE. |
duke@1 | 60 | */ |
duke@1 | 61 | public static final long ALL_ACCESS = |
duke@1 | 62 | PRIVATE | PROTECTED | PUBLIC | PACKAGE; |
duke@1 | 63 | |
duke@1 | 64 | private long oneOf; |
duke@1 | 65 | private long must; |
duke@1 | 66 | private long cannot; |
duke@1 | 67 | |
duke@1 | 68 | private static final int ACCESS_BITS = PRIVATE | PROTECTED | PUBLIC; |
duke@1 | 69 | |
duke@1 | 70 | /** |
duke@1 | 71 | * Constructor - Specify a filter. |
duke@1 | 72 | * |
duke@1 | 73 | * @param oneOf If zero, everything passes the filter. |
duke@1 | 74 | * If non-zero, at least one of the specified |
duke@1 | 75 | * bits must be on in the modifier bits to |
duke@1 | 76 | * pass the filter. |
duke@1 | 77 | */ |
duke@1 | 78 | public ModifierFilter(long oneOf) { |
duke@1 | 79 | this(oneOf, 0, 0); |
duke@1 | 80 | } |
duke@1 | 81 | |
duke@1 | 82 | /** |
duke@1 | 83 | * Constructor - Specify a filter. |
duke@1 | 84 | * For example, the filter below will only pass synchronized |
duke@1 | 85 | * methods that are private or package private access and are |
duke@1 | 86 | * not native or static. |
duke@1 | 87 | * <pre> |
duke@1 | 88 | * ModifierFilter( Modifier.PRIVATE | ModifierFilter.PACKAGE, |
duke@1 | 89 | * Modifier.SYNCHRONIZED, |
duke@1 | 90 | * Modifier.NATIVE | Modifier.STATIC) |
duke@1 | 91 | * </pre><p> |
duke@1 | 92 | * Each of the three arguments must either be |
duke@1 | 93 | * zero or the or'ed combination of the bits specified in the |
duke@1 | 94 | * class Modifier or this class. During filtering, these values |
duke@1 | 95 | * are compared against the modifier bits as follows: |
duke@1 | 96 | * |
duke@1 | 97 | * @param oneOf If zero, ignore this argument. |
duke@1 | 98 | * If non-zero, at least one of the bits must be on. |
duke@1 | 99 | * @param must All bits specified must be on. |
duke@1 | 100 | * @param cannot None of the bits specified can be on. |
duke@1 | 101 | */ |
duke@1 | 102 | public ModifierFilter(long oneOf, long must, long cannot) { |
duke@1 | 103 | this.oneOf = oneOf; |
duke@1 | 104 | this.must = must; |
duke@1 | 105 | this.cannot = cannot; |
duke@1 | 106 | } |
duke@1 | 107 | |
duke@1 | 108 | /** |
duke@1 | 109 | * Filter on modifier bits. |
duke@1 | 110 | * |
duke@1 | 111 | * @param modifierBits Bits as specified in the Modifier class |
duke@1 | 112 | * |
duke@1 | 113 | * @return Whether the modifierBits pass this filter. |
duke@1 | 114 | */ |
duke@1 | 115 | public boolean checkModifier(int modifierBits) { |
duke@1 | 116 | // Add in the "pseudo-" modifier bit PACKAGE, if needed |
duke@1 | 117 | long fmod = ((modifierBits & ACCESS_BITS) == 0) ? |
duke@1 | 118 | modifierBits | PACKAGE : |
duke@1 | 119 | modifierBits; |
duke@1 | 120 | return ((oneOf == 0) || ((oneOf & fmod) != 0)) && |
duke@1 | 121 | ((must & fmod) == must) && |
duke@1 | 122 | ((cannot & fmod) == 0); |
duke@1 | 123 | } |
duke@1 | 124 | |
duke@1 | 125 | } // end ModifierFilter |