proguard.classfile.constant.MethodHandleConstant Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proguard-core Show documentation
ProGuardCORE is a free library to read, analyze, modify, and write Java class files.
There is a newer version: 9.1.6
/*
 * ProGuardCORE -- library to process Java bytecode.
 *
 * Copyright (c) 2002-2020 Guardsquare NV
 *
 * Licensed 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 proguard.classfile.constant;

import proguard.classfile.*;
import proguard.classfile.constant.visitor.ConstantVisitor;

/**
 * This {@link Constant} represents a method handle constant in the constant pool.
 *
 * @author Eric Lafortune
 */
public class MethodHandleConstant extends Constant {
  public static final int REF_GET_FIELD = 1;
  public static final int REF_GET_STATIC = 2;
  public static final int REF_PUT_FIELD = 3;
  public static final int REF_PUT_STATIC = 4;
  public static final int REF_INVOKE_VIRTUAL = 5;
  public static final int REF_INVOKE_STATIC = 6;
  public static final int REF_INVOKE_SPECIAL = 7;
  public static final int REF_NEW_INVOKE_SPECIAL = 8;
  public static final int REF_INVOKE_INTERFACE = 9;

  public int u1referenceKind;
  public int u2referenceIndex;

  /**
   * An extra field pointing to the java.lang.invoke.MethodHandle Clazz object. This field is
   * typically filled out by the {@link
   * proguard.classfile.util.ClassReferenceInitializer
   * ClassReferenceInitializer}.
   */
  public Clazz javaLangInvokeMethodHandleClass;

  /** Creates an uninitialized MethodHandleConstant. */
  public MethodHandleConstant() {}

  /**
   * Creates a new MethodHandleConstant with the given type and method ref index.
   *
   * @param u1referenceKind the reference kind.
   * @param u2referenceIndex the index of the field ref constant, interface method ref constant, or
   *     method ref constant in the constant pool.
   */
  public MethodHandleConstant(int u1referenceKind, int u2referenceIndex) {
    this.u1referenceKind = u1referenceKind;
    this.u2referenceIndex = u2referenceIndex;
  }

  /**
   * Returns the kind of reference to which this constant is pointing.
   *
   * @return One of {@link #REF_GET_FIELD }, {@link #REF_GET_STATIC }, {@link #REF_PUT_FIELD },
   *     {@link #REF_PUT_STATIC }, {@link #REF_INVOKE_VIRTUAL }, {@link #REF_INVOKE_STATIC }, {@link
   *     #REF_INVOKE_SPECIAL }, {@link #REF_NEW_INVOKE_SPECIAL}, or {@link #REF_INVOKE_INTERFACE }.
   */
  public int getReferenceKind() {
    return u1referenceKind;
  }

  /** Returns the field ref, interface method ref, or method ref index. */
  public int getReferenceIndex() {
    return u2referenceIndex;
  }

  /** Returns the class name. */
  public String getClassName(Clazz clazz) {
    return clazz.getRefClassName(u2referenceIndex);
  }

  /** Returns the method/field name. */
  public String getName(Clazz clazz) {
    return clazz.getRefName(u2referenceIndex);
  }

  /** Returns the type. */
  public String getType(Clazz clazz) {
    return clazz.getRefType(u2referenceIndex);
  }

  /** Applies the given constant pool visitor to the reference. */
  public void referenceAccept(Clazz clazz, ConstantVisitor constantVisitor) {
    clazz.constantPoolEntryAccept(u2referenceIndex, constantVisitor);
  }

  // Implementations for Constant.

  @Override
  public int getTag() {
    return Constant.METHOD_HANDLE;
  }

  @Override
  public boolean isCategory2() {
    return false;
  }

  @Override
  public void accept(Clazz clazz, ConstantVisitor constantVisitor) {
    constantVisitor.visitMethodHandleConstant(clazz, this);
  }

  // Implementations for Object.

  @Override
  public boolean equals(Object object) {
    if (object == null || !this.getClass().equals(object.getClass())) {
      return false;
    }

    if (this == object) {
      return true;
    }

    MethodHandleConstant other = (MethodHandleConstant) object;

    return this.u1referenceKind == other.u1referenceKind
        && this.u2referenceIndex == other.u2referenceIndex;
  }

  @Override
  public int hashCode() {
    return Constant.METHOD_HANDLE ^ (u1referenceKind << 5) ^ (u2referenceIndex << 16);
  }

  @Override
  public String toString() {
    return "MethodHandle(" + u1referenceKind + "," + u2referenceIndex + ")";
  }
}