UninitializedObjectType.java

/*
 * 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.verifier.structurals;

import org.apache.bcel.Const;
import org.apache.bcel.Constants;
import org.apache.bcel.generic.ObjectType;
import org.apache.bcel.generic.ReferenceType;

/**
 * This class represents an uninitialized object type; see The Java Virtual Machine Specification, Second Edition, page
 * 147: 4.9.4 for more details.
 */
public class UninitializedObjectType extends ReferenceType implements Constants {

    /** The "initialized" version. */
    private final ObjectType initialized;

    /**
     * Creates a new instance.
     *
     * @param objectType uninitialized object type.
     */
    public UninitializedObjectType(final ObjectType objectType) {
        super(Const.T_UNKNOWN, "<UNINITIALIZED OBJECT OF TYPE '" + objectType.getClassName() + "'>");
        initialized = objectType;
    }

    /**
     * Returns true on equality of this and o. Equality means the ObjectType instances of "initialized" equal one another in
     * this and the o instance.
     */
    @Override
    public boolean equals(final Object o) {
        if (!(o instanceof UninitializedObjectType)) {
            return false;
        }
        return initialized.equals(((UninitializedObjectType) o).initialized);
    }

    /**
     * Returns the ObjectType of the same class as the one of the uninitialized object represented by this
     * UninitializedObjectType instance.
     *
     * @return the ObjectType.
     */
    public ObjectType getInitialized() {
        return initialized;
    }

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