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