Glassfish example source code file (ClassFile.java)

This example Glassfish source code file (ClassFile.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Glassfish tags/keywords

classfile, classfile, collection, collection, method, method, string, string, util

The Glassfish ClassFile.java source code

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

/*
 * ClassFile.java
 *
 * Created on August 17, 2004, 8:43 AM
 */

package com.sun.enterprise.tools.verifier.apiscan.classfile;

import java.util.Collection;

/**
 * This represents the information available in a Java .class file. This
 * interface is used by {@link ClosureCompilerImpl} for closure computation. The
 * interface only represents the information as needed by api scanning feature
 * in verifier. I expect it to evolve over time to something very similar to
 * BCEL's ClassFile. Now a note about different ways a Java class can be named
 * and in different places different names are used for the same Java class. 1)
 * In the format "p.a.b". This is what we use when declaring variables etc in a
 * Java code. I do not use this because this is not an unambiguous
 * representation of a Java class. By looking at p.a.b it is not possible to say
 * if b is an inner class in class p.a or b is an outer class in package p.a. 2)
 * In the format "p.outer$inner". It is what is used when we invoke java command
 * or Class.forName(). It is same as what is returned by
 * java.lang.Class.getName() method. It is an unambiguous representation of a
 * class name, because by looking at it, we can tell "inner" is an inner class
 * of a class "outer" which belongs to package p. By default our {@link
 * #getName()} returns in this format. 3) In the format "p/outer$inner" This is
 * the internal name of a class. It is called internal name because in byte code
 * this is what is encoded. It is again an unambiguous representation as this a
 * path expression. It is fairly simple to convert from 2 to 3 by a simple call
 * to String.replace('.','/'). Similarly to convert from 3 to 2, call
 * String.replace('/','.'); Here is a test of what you understood. What does
 * this class name "a$b.c$d.Foo$Bar$Goo" mean? "Goo" is an inner class in a
 * class "Foo$Bar" which is defined in a package "a$b.c$d".
 *
 * @author Sanjeeb.Sahoo@Sun.COM
 */
public interface ClassFile {
    /**
     * @return names of the classes that are directly referenced by this class.
     *         The returned class names are in external form.
     */
    Collection<String> getAllReferencedClassNames();

    /**
     * @return names of the classes that are directly referenced by this class.
     *         The returned class names are in internal form. This is done with
     *         a purpose as it is easy to look up files with internal class
     *         name.
     */
    Collection getAllReferencedClassNamesInInternalForm();

    /**
     * @return the external name of this Java class. External name is of the
     *         form java.util.Map$Entry. It is what is used when we invoke java
     *         command or Class.forName(). It is same as what is returned by
     *         java.lang.Class.getName() method. Pl note that a Java Class name
     *         and package name can contain $, so when you see a$b, don't assume
     *         it is an inner class.
     * @see #getInternalName()
     */
    String getName();

    /**
     * @return the internal name of the Java class. Internal name is what is
     *         available in file system, e.g. java/util/Map$Entry Pl note that a
     *         Java Class name and package name can contain $, so when you see
     *         a$b, don't assume it is an inner class.
     */
    String getInternalName();

    /**
     * @return internal package name of the Java class. Unlike class name,
     *         package names do not have many forms. They are always specified
     *         using dor notation (i.e. java.lang). See getName() method in
     *         java.lang.Package class. Accordingly we have only one API for
     *         package name. Returns "" for default package.
     */
    String getPackageName();

    /**
     * @return all the methods that are present in this class. This includes
     *         methods that are added by compiler as well, e.g. clinit and init
     *         methods.
     */
    Collection<? extends Method> getMethods();

    /**
     * @param methodRef is the reference of the method that is being looked for
     * @return return the method object that matches the guven criteria. null,
     *         otherwise.
     */
    Method getMethod(MethodRef methodRef);

    /**
     * @return external name of super class
     */
    String getNameOfSuperClass();

    /**
     * @return internal name of super class. Every class other than
     *         java.lang.Object has a super class.
     */
    String getInternalNameOfSuperClass();

    /**
     * @return external names of any interfaces implemented by this class.
     */
    String[] getNamesOfInterfaces();

    /**
     * @return internal names of any interfaces implemented by this class.
     */
    String[] getInternalNamesOfInterfaces();

    /**
     * @return true if this is an interface, else false
     */
    boolean isInterface();

}