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