Java example source code file (ConstantHTML.java)

This example Java source code file (ConstantHTML.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

bgcolor, constant_class, constant_methodref, constant_nameandtype, href, string, target\=_top, target\=constantpool

The ConstantHTML.java Java example source code

/*
 * reserved comment block
 * DO NOT REMOVE OR ALTER!
 */

package com.sun.org.apache.bcel.internal.util;

/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2001 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" and
 *    "Apache BCEL" must not be used to endorse or promote products
 *    derived from this software without prior written permission. For
 *    written permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache",
 *    "Apache BCEL", nor may "Apache" appear in their name, without
 *    prior written permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

import com.sun.org.apache.bcel.internal.classfile.*;
import java.io.*;

/**
 * Convert constant pool into HTML file.
 *
 * @author  <A HREF="mailto:markus.dahm@berlin.de">M. Dahm
 *
 */
final class ConstantHTML implements com.sun.org.apache.bcel.internal.Constants {
  private String        class_name;     // name of current class
  private String        class_package;  // name of package
  private ConstantPool  constant_pool;  // reference to constant pool
  private PrintWriter   file;           // file to write to
  private String[]      constant_ref;   // String to return for cp[i]
  private Constant[]    constants;      // The constants in the cp
  private Method[]      methods;

  ConstantHTML(String dir, String class_name, String class_package, Method[] methods,
               ConstantPool constant_pool) throws IOException
  {
    this.class_name     = class_name;
    this.class_package  = class_package;
    this.constant_pool  = constant_pool;
    this.methods        = methods;
    constants           = constant_pool.getConstantPool();
    file                = new PrintWriter(new FileOutputStream(dir + class_name + "_cp.html"));
    constant_ref        = new String[constants.length];
    constant_ref[0]     = "<unknown>";

    file.println("<HTML>");

    // Loop through constants, constants[0] is reserved
    for(int i=1; i < constants.length; i++) {
      if(i % 2 == 0)
        file.print("<TR BGCOLOR=\"#C0C0C0\">\n");
    }

    file.println("</TABLE>");
    file.close();
  }

  String referenceConstant(int index) {
    return constant_ref[index];
  }

  private void writeConstant(int index) {
    byte   tag = constants[index].getTag();
    int    class_index, name_index;
    String ref;

    // The header is always the same
    file.println("<H4> " + index + " " + CONSTANT_NAMES[tag] + "");

    /* For every constant type get the needed parameters and print them appropiately
     */
    switch(tag) {
    case CONSTANT_InterfaceMethodref:
    case CONSTANT_Methodref:
      // Get class_index and name_and_type_index, depending on type
      if(tag == CONSTANT_Methodref) {
        ConstantMethodref c = (ConstantMethodref)constant_pool.getConstant(index, CONSTANT_Methodref);
        class_index = c.getClassIndex();
        name_index  = c.getNameAndTypeIndex();
      }
      else {
        ConstantInterfaceMethodref c1 = (ConstantInterfaceMethodref)constant_pool.getConstant(index, CONSTANT_InterfaceMethodref);
        class_index = c1.getClassIndex();
        name_index  = c1.getNameAndTypeIndex();
      }

      // Get method name and its class
      String method_name        = constant_pool.constantToString(name_index, CONSTANT_NameAndType);
      String html_method_name = Class2HTML.toHTML(method_name);

      // Partially compacted class name, i.e., / -> .
      String method_class = constant_pool.constantToString(class_index, CONSTANT_Class);
      String short_method_class         = Utility.compactClassName(method_class); // I.e., remove java.lang.
      short_method_class = Utility.compactClassName(method_class); // I.e., remove java.lang.
      short_method_class = Utility.compactClassName(short_method_class, class_package + ".", true); // Remove class package prefix

      // Get method signature
      ConstantNameAndType c2 = (ConstantNameAndType)constant_pool.getConstant(name_index, CONSTANT_NameAndType);
      String signature = constant_pool.constantToString(c2.getSignatureIndex(), CONSTANT_Utf8);
      // Get array of strings containing the argument types
      String[] args = Utility.methodSignatureArgumentTypes(signature, false);

      // Get return type string
      String type = Utility.methodSignatureReturnType(signature, false);
      String ret_type = Class2HTML.referenceType(type);

      StringBuffer buf = new StringBuffer("(");
      for(int i=0; i < args.length; i++) {
        buf.append(Class2HTML.referenceType(args[i]));
        if(i < args.length - 1)
          buf.append(", ");
      }
      buf.append(")");

      String arg_types = buf.toString();

      if(method_class.equals(class_name)) // Method is local to class
        ref = "<A HREF=\"" + class_name + "_code.html#method" + getMethodNumber(method_name + signature) +
          "\" TARGET=Code>" + html_method_name + "</A>";
      else
        ref = "<A HREF=\"" + method_class + ".html" + "\" TARGET=_top>" + short_method_class +
          "</A>." + html_method_name;

      constant_ref[index] = ret_type + " <A HREF=\"" + class_name + "_cp.html#cp" + class_index +
        "\" TARGET=Constants>" +
        short_method_class + "</A>. " + arg_types;

      file.println("<P>" + ret_type + " " + ref + arg_types + " \n
" +
                   "<LI>Class index(" + class_index +        ")\n" +
                   "<LI>NameAndType index(" + name_index + ")
");
      break;

    case CONSTANT_Fieldref:
      // Get class_index and name_and_type_index
      ConstantFieldref c3 = (ConstantFieldref)constant_pool.getConstant(index, CONSTANT_Fieldref);
      class_index = c3.getClassIndex();
      name_index  = c3.getNameAndTypeIndex();

      // Get method name and its class (compacted)
      String field_class = constant_pool.constantToString(class_index, CONSTANT_Class);
      String short_field_class = Utility.compactClassName(field_class); // I.e., remove java.lang.
      short_field_class = Utility.compactClassName(short_field_class, class_package + ".", true); // Remove class package prefix

      String field_name  = constant_pool.constantToString(name_index, CONSTANT_NameAndType);

      if(field_class.equals(class_name)) // Field is local to class
        ref = "<A HREF=\"" + field_class + "_methods.html#field" +
          field_name + "\" TARGET=Methods>" + field_name + "</A>";
      else
        ref = "<A HREF=\"" + field_class + ".html\" TARGET=_top>" +
          short_field_class + "</A>." + field_name + "\n";

      constant_ref[index] = "<A HREF=\"" + class_name + "_cp.html#cp" + class_index +   "\" TARGET=Constants>" +
        short_field_class + "</A>.";

      file.println("<P>" + ref + "
\n" + "
" +
                   "<LI>Class(" + class_index +      ")
\n" +
                   "<LI>NameAndType(" + name_index + ")
");
      break;

    case CONSTANT_Class:
      ConstantClass c4 = (ConstantClass)constant_pool.getConstant(index, CONSTANT_Class);
      name_index  = c4.getNameIndex();
      String class_name2  = constant_pool.constantToString(index, tag); // / -> .
      String short_class_name = Utility.compactClassName(class_name2); // I.e., remove java.lang.
      short_class_name = Utility.compactClassName(short_class_name, class_package + ".", true); // Remove class package prefix

      ref = "<A HREF=\"" + class_name2 + ".html\" TARGET=_top>" + short_class_name + "";
      constant_ref[index] = "<A HREF=\"" + class_name + "_cp.html#cp" + index +
        "\" TARGET=ConstantPool>" + short_class_name + "</A>";

      file.println("<P>" + ref + "
" +
                   "<LI>Name index(" + name_index +   ")
\n");
      break;

    case CONSTANT_String:
      ConstantString c5 = (ConstantString)constant_pool.getConstant(index, CONSTANT_String);
      name_index = c5.getStringIndex();

      String str = Class2HTML.toHTML(constant_pool.constantToString(index, tag));

      file.println("<P>" + str + "
" +
                   "<LI>Name index(" + name_index +   ")
\n");
      break;

    case CONSTANT_NameAndType:
      ConstantNameAndType c6 = (ConstantNameAndType)constant_pool.getConstant(index, CONSTANT_NameAndType);
      name_index = c6.getNameIndex();
      int signature_index = c6.getSignatureIndex();

      file.println("<P>" + Class2HTML.toHTML(constant_pool.constantToString(index, tag)) + "
" +
                   "<LI>Name index(" + name_index + ")\n" +
                   "<LI>Signature index(" +
                   signature_index + ")</A>
\n");
      break;

    default:
      file.println("<P>" + Class2HTML.toHTML(constant_pool.constantToString(index, tag)) + "\n");
    } // switch
  }

  private final int getMethodNumber(String str) {
    for(int i=0; i < methods.length; i++) {
      String cmp = methods[i].getName() + methods[i].getSignature();
      if(cmp.equals(str))
        return i;
    }
    return -1;
  }
}


Other Java examples (source code examples)
Here is a short list of links related to this Java ConstantHTML.java source code file:

  
 The search page
  
 Other Java source code examples at this package level
  
 Click here to learn more about this project

");
      else
        file.print("<TR BGCOLOR=\"#A0A0A0\">
");

      if(constants[i] != null)
        writeConstant(i);

      file.print("</TD>

... this post is sponsored by my books ...
#1 New Release!	FP Best Seller

 

new blog posts