/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */
package org.apache.bcel.generic;

import org.apache.bcel.Const;
import org.apache.bcel.Repository;
import org.apache.bcel.classfile.JavaClass;

import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.checker.signature.qual.BinaryName;
import org.checkerframework.checker.signature.qual.ClassGetName;
import org.checkerframework.framework.qual.AnnotatedFor;

/** 
 * Denotes reference such as java.lang.String.
 *
 * @version $Id$
 */
@AnnotatedFor({"signature"})
public class ObjectType extends ReferenceType {

    private final @BinaryName String class_name; // Class name of type

    /**
     * @since 6.0
     */
    // TODO: actualy type is @BinaryName =
    // @ClassGetName-for-nonarray, but that type requires warning
    // suppressions at call sites, so just use @ClassGetName.
    public static ObjectType getInstance(final /*@ BinaryName*/ @ClassGetName String class_name) {
        return new ObjectType(class_name);
    }

    /**
     * @param class_name fully qualified class name, e.g. java.lang.String
     */
    @SuppressWarnings("signature") // string manipulation
    public ObjectType(final @BinaryName String class_name) {
        // second argument to super is a @FieldDescriptor
        super(Const.T_REFERENCE, "L" + class_name.replace('.', '/') + ";");
        // TODO: Javadoc says argument is like "java.lang.String", but then why does this line replace slashes??
        // Is this sometimes called with a non-@BinaryName argument, namely a @FieldDescriptor or @InternalForm (those are the only two representations that contain "/")?
        this.class_name = class_name.replace('/', '.');
    }


    /** @return name of referenced class
     */
    public @BinaryName String getClassName() {
        return class_name;
    }


    /** @return a hash code value for the object.
     */
    @Override
    public int hashCode() {
        return class_name.hashCode();
    }


    /** @return true if both type objects refer to the same class.
     */
    @Override
    public boolean equals( final @Nullable Object type ) {
        return (type instanceof ObjectType)
                ? ((ObjectType) type).class_name.equals(class_name)
                : false;
    }


    /**
     * If "this" doesn't reference a class, it references an interface
     * or a non-existant entity.
     * @deprecated (since 6.0) this method returns an inaccurate result
     *   if the class or interface referenced cannot
     *   be found: use referencesClassExact() instead
     */
    @Deprecated
    public boolean referencesClass() {
        try {
            final JavaClass jc = Repository.lookupClass(class_name);
            return jc.isClass();
        } catch (final ClassNotFoundException e) {
            return false;
        }
    }


    /**
     * If "this" doesn't reference an interface, it references a class
     * or a non-existant entity.
     * @deprecated (since 6.0) this method returns an inaccurate result
     *   if the class or interface referenced cannot
     *   be found: use referencesInterfaceExact() instead
     */
    @Deprecated
    public boolean referencesInterface() {
        try {
            final JavaClass jc = Repository.lookupClass(class_name);
            return !jc.isClass();
        } catch (final ClassNotFoundException e) {
            return false;
        }
    }


    /**
     * Return true if this type references a class,
     * false if it references an interface.
     * @return true if the type references a class, false if
     *   it references an interface
     * @throws ClassNotFoundException if the class or interface
     *   referenced by this type can't be found
     */
    public boolean referencesClassExact() throws ClassNotFoundException {
        final JavaClass jc = Repository.lookupClass(class_name);
        return jc.isClass();
    }


    /**
     * Return true if this type references an interface,
     * false if it references a class.
     * @return true if the type references an interface, false if
     *   it references a class
     * @throws ClassNotFoundException if the class or interface
     *   referenced by this type can't be found
     */
    public boolean referencesInterfaceExact() throws ClassNotFoundException {
        final JavaClass jc = Repository.lookupClass(class_name);
        return !jc.isClass();
    }


    /**
     * Return true if this type is a subclass of given ObjectType.
     * @throws ClassNotFoundException if any of this class's superclasses
     *  can't be found
     */
    public boolean subclassOf( final ObjectType superclass ) throws ClassNotFoundException {
        if (this.referencesInterfaceExact() || superclass.referencesInterfaceExact()) {
            return false;
        }
        return Repository.instanceOf(this.class_name, superclass.class_name);
    }


    /**
     * Java Virtual Machine Specification edition 2, � 5.4.4 Access Control
     * @throws ClassNotFoundException if the class referenced by this type
     *   can't be found
     */
    public boolean accessibleTo( final ObjectType accessor ) throws ClassNotFoundException {
        final JavaClass jc = Repository.lookupClass(class_name);
        if (jc.isPublic()) {
            return true;
        }
        final JavaClass acc = Repository.lookupClass(accessor.class_name);
        return acc.getPackageName().equals(jc.getPackageName());
    }
}

@@ -1458,179 +1458,8 @@
  */%0A
-    // TODO: actualy type is @BinaryName =%0A    // @ClassGetName-for-nonarray, but that type requires warning%0A    // suppressions at call sites, so just use @ClassGetName.%0A
     
@@ -1505,12 +1505,9 @@
 nal 
-/*@ 
+@
 Bina
@@ -1516,24 +1516,8 @@
 Name
-*/ @ClassGetName
  Str
@@ -1671,24 +1671,208 @@
 ing%0A     */%0A
+    // The argument can be either @BinaryName or @InternalForm.  There is no Signature Checker%0A    // annotation for that.  Use @BinaryName since the documentation is closest to that.%0A
     @Suppres
@@ -2128,279 +2128,81 @@
 // T
-ODO: Javadoc says argument is like %22java.lang.String%22, but then why does this line replace slashes??%0A        // Is this sometimes called with a non-@BinaryName argument, namely a @FieldDescriptor or @InternalForm (those are the only two representations that contain %22/%22)?
+his has an effect only if the argument is @InternalForm, not @BinaryName.
 %0A   

Update type annotation