View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   *  Unless required by applicable law or agreed to in writing, software
12   *  distributed under the License is distributed on an "AS IS" BASIS,
13   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   *  See the License for the specific language governing permissions and
15   *  limitations under the License.
16   */
17  package org.apache.bcel.generic;
18  
19  /**
20   * Denotes that an instruction may start the process of loading and resolving the referenced class in the Virtual Machine.
21   */
22  public interface LoadClass {
23  
24      /**
25       * Returns the {@link ObjectType} of the referenced class or interface that may be loaded and resolved.
26       *
27       * @param cpg A ConstantPoolGen
28       * @return object type that may be loaded or null if a primitive is referenced
29       */
30      ObjectType getLoadClassType(ConstantPoolGen cpg);
31  
32      /**
33       * Returns the type associated with this instruction. LoadClass instances are always typed, but this type does not always refer to the type of the class or
34       * interface that it possibly forces to load. For example, {@link GETFIELD} would return the type of the field and not the type of the class where the field
35       * is defined. If no class is forced to be loaded, {@code null} is returned. An example for this is an {@link NEWARRAY} instruction that creates an
36       * {@code int[][]}.
37       *
38       * @param cpg A ConstantPoolGen
39       * @return the type associated with this instruction.
40       * @see #getLoadClassType(ConstantPoolGen)
41       */
42      Type getType(ConstantPoolGen cpg);
43  }