1 /*
2 * Copyright (c) 1998, 2013, 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
26 package com.sun.jdi;
27
28 /**
29 * Provides information on the accessibility of a type or type component.
30 * Mirrors for program elements which allow an
31 * an access specifier (private, protected, public) provide information
32 * on that part of the declaration through this interface.
33 *
34 * @author Robert Field
35 * @author Gordon Hirsch
36 * @author James McIlree
37 * @since 1.3
38 */
39 public interface Accessible {
40
41 /**
42 * Returns the Java™ programming language modifiers, encoded
43 * in an integer.
44 * <p>
45 * The modifier encodings are defined in
46 * <cite>The Java™ Virtual Machine Specification</cite>
47 * in the <code>access_flag</code> tables for classes(section 4.1), fields(section 4.5), and methods(section 4.6).
48 */
49 public int modifiers();
50
51 /**
52 * Determines if this object mirrors a private item.
53 * For {@link ArrayType}, the return value depends on the
54 * array component type. For primitive arrays the return value
55 * is always false. For object arrays, the return value is the
56 * same as would be returned for the component type.
57 * For primitive classes, such as {@link java.lang.Integer#TYPE},
58 * the return value is always false.
59 *
60 * @return <code>true</code> for items with private access;
61 * <code>false</code> otherwise.
62 */
63 boolean isPrivate();
64
65 /**
66 * Determines if this object mirrors a package private item.
67 * A package private item is declared with no access specifier.
68 * For {@link ArrayType}, the return value depends on the
69 * array component type. For primitive arrays the return value
70 * is always false. For object arrays, the return value is the
71 * same as would be returned for the component type.
72 * For primitive classes, such as {@link java.lang.Integer#TYPE},
73 * the return value is always false.
74 *
75 * @return <code>true</code> for items with package private access;
76 * <code>false</code> otherwise.
77 */
78 boolean isPackagePrivate();
79
80 /**
81 * Determines if this object mirrors a protected item.
82 * For {@link ArrayType}, the return value depends on the
83 * array component type. For primitive arrays the return value
84 * is always false. For object arrays, the return value is the
85 * same as would be returned for the component type.
86 * For primitive classes, such as {@link java.lang.Integer#TYPE},
87 * the return value is always false.
88 *
89 * @return <code>true</code> for items with private access;
90 * <code>false</code> otherwise.
91 */
92 boolean isProtected();
93
94 /**
95 * Determines if this object mirrors a public item.
96 * For {@link ArrayType}, the return value depends on the
97 * array component type. For primitive arrays the return value
98 * is always true. For object arrays, the return value is the
99 * same as would be returned for the component type.
100 * For primitive classes, such as {@link java.lang.Integer#TYPE},
101 * the return value is always true.
102 *
103 * @return <code>true</code> for items with public access;
104 * <code>false</code> otherwise.
105 */
106 boolean isPublic();
107 }