/*
* Copyright (c) 1998, 2001, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.jdi;
/**
* Provides information on the accessibility of a type or type component.
* Mirrors for program elements which allow an
* an access specifier (private, protected, public) provide information
* on that part of the declaration through this interface.
*
* @author Robert Field
* @author Gordon Hirsch
* @author James McIlree
* @since 1.3
*/
public interface Accessible {
/**
* Returns the Java<sup><font size=-2>TM</font></sup>
* programming language modifiers, encoded in an integer.
* <p>
* The modifier encodings are defined in the
* <a href="http://java.sun.com/docs/books/vmspec/">Java Virtual Machine
* Specification</a>, in the <code>access_flag</code> tables for
* <a href="http://java.sun.com/docs/books/vmspec/2nd-edition/html/ClassFile.doc.html#75734">classes</a>,
* <a href="http://java.sun.com/docs/books/vmspec/2nd-edition/html/ClassFile.doc.html#88358">fields</a>, and
* <a href="http://java.sun.com/docs/books/vmspec/2nd-edition/html/ClassFile.doc.html#75568">methods</a>.
*/
public int modifiers();
/**
* Determines if this object mirrors a private item.
* For {@link ArrayType}, the return value depends on the
* array component type. For primitive arrays the return value
* is always false. For object arrays, the return value is the
* same as would be returned for the component type.
* For primitive classes, such as {@link java.lang.Integer#TYPE},
* the return value is always false.
*
* @return <code>true</code> for items with private access;
* <code>false</code> otherwise.
*/
boolean isPrivate();
/**
* Determines if this object mirrors a package private item.
* A package private item is declared with no access specifier.
* For {@link ArrayType}, the return value depends on the
* array component type. For primitive arrays the return value
* is always false. For object arrays, the return value is the
* same as would be returned for the component type.
* For primitive classes, such as {@link java.lang.Integer#TYPE},
* the return value is always false.
*
* @return <code>true</code> for items with package private access;
* <code>false</code> otherwise.
*/
boolean isPackagePrivate();
/**
* Determines if this object mirrors a protected item.
* For {@link ArrayType}, the return value depends on the
* array component type. For primitive arrays the return value
* is always false. For object arrays, the return value is the
* same as would be returned for the component type.
* For primitive classes, such as {@link java.lang.Integer#TYPE},
* the return value is always false.
*
* @return <code>true</code> for items with private access;
* <code>false</code> otherwise.
*/
boolean isProtected();
/**
* Determines if this object mirrors a public item.
* For {@link ArrayType}, the return value depends on the
* array component type. For primitive arrays the return value
* is always true. For object arrays, the return value is the
* same as would be returned for the component type.
* For primitive classes, such as {@link java.lang.Integer#TYPE},
* the return value is always true.
*
* @return <code>true</code> for items with public access;
* <code>false</code> otherwise.
*/
boolean isPublic();
}