com.ibm.wala.shrike.shrikeBT.ConstantPoolReader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.ibm.wala.shrike Show documentation
T. J. Watson Libraries for Analysis
The newest version!
/*
 * Copyright (c) 2002,2006 IBM Corporation.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 */
package com.ibm.wala.shrike.shrikeBT;

import com.ibm.wala.shrike.shrikeCT.BootstrapMethodsReader.BootstrapMethod;

/**
 * This class provides read-only access to a constant pool. It gets subclassed for each class
 * reader/editor toolkit you want to work with.
 */
public abstract class ConstantPoolReader {
  /**
   * Retrieve the JVM constant pool item type (a Constants.CONSTANT_xxx value). This method should
   * be overriden by a toolkit-specific subclass.
   *
   * @param index the constant pool item to examine
   */
  public abstract int getConstantPoolItemType(int index);

  /**
   * Retrieve the value of a CONSTANT_Integer constant pool item. This method should be overriden by
   * a toolkit-specific subclass.
   *
   * @param index the constant pool item to examine
   */
  public abstract int getConstantPoolInteger(int index);

  /**
   * Retrieve the value of a CONSTANT_Float constant pool item. This method should be overriden by a
   * toolkit-specific subclass.
   *
   * @param index the constant pool item to examine
   */
  public abstract float getConstantPoolFloat(int index);

  /**
   * Retrieve the value of a CONSTANT_Long constant pool item. This method should be overriden by a
   * toolkit-specific subclass.
   *
   * @param index the constant pool item to examine
   */
  public abstract long getConstantPoolLong(int index);

  /**
   * Retrieve the value of a CONSTANT_Double constant pool item. This method should be overriden by
   * a toolkit-specific subclass.
   *
   * @param index the constant pool item to examine
   */
  public abstract double getConstantPoolDouble(int index);

  /**
   * Retrieve the value of a CONSTANT_String constant pool item. This method should be overriden by
   * a toolkit-specific subclass.
   *
   * @param index the constant pool item to examine
   */
  public abstract String getConstantPoolString(int index);

  /**
   * Retrieve the value of a CONSTANT_MethodType constant pool item. This method should be overriden
   * by a toolkit-specific subclass.
   *
   * @param index the constant pool item to examine
   */
  public abstract String getConstantPoolMethodType(int index);

  /**
   * Retrieve the value of a CONSTANT_Class constant pool item in JVM internal class format (e.g.,
   * java/lang/Object). This method should be overriden by a toolkit-specific subclass.
   *
   * @param index the constant pool item to examine
   */
  public abstract String getConstantPoolClassType(int index);

  /**
   * Retrieve the class part of a CONSTANT_FieldRef, CONSTANT_MethodRef, or
   * CONSTANT_InterfaceMethodRef constant pool item, in JVM internal class format (e.g.,
   * java/lang/Object). This method should be overriden by a toolkit-specific subclass.
   *
   * @param index the constant pool item to examine
   */
  public abstract String getConstantPoolMemberClassType(int index);

  /**
   * Retrieve the name part of a CONSTANT_FieldRef, CONSTANT_MethodRef, or
   * CONSTANT_InterfaceMethodRef constant pool item, This method should be overriden by a
   * toolkit-specific subclass.
   *
   * @param index the constant pool item to examine
   */
  public abstract String getConstantPoolMemberName(int index);

  /**
   * Retrieve the type part of a CONSTANT_FieldRef, CONSTANT_MethodRef, or
   * CONSTANT_InterfaceMethodRef constant pool item, in JVM internal type format (e.g.,
   * Ljava/lang/Object;). This method should be overriden by a toolkit-specific subclass.
   *
   * @param index the constant pool item to examine
   */
  public abstract String getConstantPoolMemberType(int index);

  /**
   * Retrieve the class part of the CONSTANT_FieldRef, CONSTANT_MethodRef, or
   * CONSTANT_InterfaceMethodRef constant pool item pointed to by a CONSTANT_MethodHandle entry.
   * This method should be overriden by a toolkit-specific subclass.
   *
   * @param index the constant pool item to examine
   */
  public abstract String getConstantPoolHandleClassType(int index);

  /**
   * Retrieve the name part of the CONSTANT_FieldRef, CONSTANT_MethodRef, or
   * CONSTANT_InterfaceMethodRef constant pool item pointed to by a CONSTANT_MethodHandle entry.
   * This method should be overriden by a toolkit-specific subclass.
   *
   * @param index the constant pool item to examine
   */
  public abstract String getConstantPoolHandleName(int index);

  /**
   * Retrieve the type part of the CONSTANT_FieldRef, CONSTANT_MethodRef, or
   * CONSTANT_InterfaceMethodRef constant pool item pointed to by a CONSTANT_MethodHandle entry.
   * This method should be overriden by a toolkit-specific subclass.
   *
   * @param index the constant pool item to examine
   */
  public abstract String getConstantPoolHandleType(int index);

  public abstract byte getConstantPoolHandleKind(int index);

  public abstract BootstrapMethod getConstantPoolDynamicBootstrap(int index);

  public abstract String getConstantPoolDynamicName(int index);

  public abstract String getConstantPoolDynamicType(int index);
}