proguard.classfile.util.renderer.ConstantViewModel 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

package proguard.classfile.util.renderer;

import java.io.PrintWriter;
import java.io.StringWriter;
import proguard.classfile.Clazz;
import proguard.classfile.constant.Constant;
import proguard.classfile.visitor.ClassPrinter;

/**
 * This utility class renders {@link Constant} objects into a more human-readable format. It can be
 * used as a Java type renderer in Intellij-based IDE to support debugging.
 *
 * @author Kymeng Tang
 */
public class ConstantViewModel extends ProcessableViewModel {
  private MemberViewModel.Pair model;

  /**
   * A constructor to keep track of the {@link Constant} object to be rendered and its associated
   * {@link Clazz}
   *
   * @param clazz The {@link Clazz} that the {@link Constant} entry belongs to.
   * @param constant The {@link Constant} object to be rendered.
   */
  public ConstantViewModel(Clazz clazz, Constant constant) {
    model = new MemberViewModel.Pair<>(clazz, constant);
    this.processingFlags = renderProcessingFlags(constant.processingFlags);
  }

  /**
   * A utility method that renders a {@link Constant} entry into a preview string, e.g., String(18)
   * -> "Foo".
   *
   * @return A string previewing the constant pool entry.
   */
  public String renderPreview() {
    StringWriter stringWriter = new StringWriter();
    model.value.accept(model.key, new ClassPrinter(new PrintWriter(stringWriter)));
    stringWriter.flush();
    return stringWriter.toString().trim();
  }
}