All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.org.apache.bcel.internal.verifier.statics.StringRepresentation Maven / Gradle / Ivy

The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.org.apache.bcel.internal.verifier.statics;

/* ====================================================================
 * 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 [email protected].
 *
 * 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
 * .
 */

import com.sun.org.apache.bcel.internal.classfile.*;
import com.sun.org.apache.bcel.internal.verifier.exc.*;

/**
 * BCEL's Node classes (those from the classfile API that accept() Visitor
 * instances) have toString() methods that were not designed to be robust,
 * this gap is closed by this class.
 * When performing class file verification, it may be useful to output which
 * entity (e.g. a Code instance) is not satisfying the verifier's
 * constraints, but in this case it could be possible for the toString()
 * method to throw a RuntimeException.
 * A (new StringRepresentation(Node n)).toString() never throws any exception.
 * Note that this class also serves as a placeholder for more sophisticated message
 * handling in future versions of JustIce.
 * 
 * @version $Id: StringRepresentation.java,v 1.3 2007-07-19 04:35:00 ofung Exp $
 * @author Enver Haase
 */
public class StringRepresentation extends com.sun.org.apache.bcel.internal.classfile.EmptyVisitor implements Visitor{
	/** The string representation, created by a visitXXX() method, output by toString(). */
	private String tostring;
  /** The node we ask for its string representation. Not really needed; only for debug output. */
  private Node n;
	/**
	 * Creates a new StringRepresentation object which is the representation of n.
	 *
	 * @see #toString()
	 */
	public StringRepresentation(Node n){
		this.n = n;
		n.accept(this); // assign a string representation to field 'tostring' if we know n's class.
	}
	/**
	 * Returns the String representation.
	 */
	public String toString(){
    // The run-time check below is needed because we don't want to omit inheritance
    // of "EmptyVisitor" and provide a thousand empty methods.
    // However, in terms of performance this would be a better idea.
    // If some new "Node" is defined in BCEL (such as some concrete "Attribute"), we
    // want to know that this class has also to be adapted.
    if (tostring == null) throw new AssertionViolatedException("Please adapt '"+getClass()+"' to deal with objects of class '"+n.getClass()+"'.");
		return tostring;
	}
	/**
	 * Returns the String representation of the Node object obj;
	 * this is obj.toString() if it does not throw any RuntimeException,
	 * or else it is a string derived only from obj's class name.
	 */
	private String toString(Node obj){
		String ret;
		try{
			ret = obj.toString();
		}
		catch(RuntimeException e){
			String s = obj.getClass().getName();
			s = s.substring(s.lastIndexOf(".")+1);
			ret = "<<"+s+">>";
    }
    catch(ClassFormatError e){ /* BCEL can be harsh e.g. trying to convert the "signature" of a ReturnaddressType LocalVariable (shouldn't occur, but people do crazy things) */
      String s = obj.getClass().getName();
      s = s.substring(s.lastIndexOf(".")+1);
      ret = "<<"+s+">>";
		}
		return ret;
	}
	////////////////////////////////
	// Visitor methods start here //
	////////////////////////////////
	// We don't of course need to call some default implementation:
	// e.g. we could also simply output "Code" instead of a possibly
	// lengthy Code attribute's toString().
	public void visitCode(Code obj){
		//tostring = toString(obj);
		tostring = ""; // We don't need real code outputs.
	}
	public void visitCodeException(CodeException obj){
		tostring = toString(obj);
	}
	public void visitConstantClass(ConstantClass obj){
		tostring = toString(obj);
	}
	public void visitConstantDouble(ConstantDouble obj){
		tostring = toString(obj);
	}
	public void visitConstantFieldref(ConstantFieldref obj){
		tostring = toString(obj);
	}
	public void visitConstantFloat(ConstantFloat obj){
		tostring = toString(obj);
	}
	public void visitConstantInteger(ConstantInteger obj){
		tostring = toString(obj);
	}
	public void visitConstantInterfaceMethodref(ConstantInterfaceMethodref obj){
		tostring = toString(obj);
	}
	public void visitConstantLong(ConstantLong obj){
		tostring = toString(obj);
	}
	public void visitConstantMethodref(ConstantMethodref obj){
		tostring = toString(obj);
	}
	public void visitConstantNameAndType(ConstantNameAndType obj){
		tostring = toString(obj);
	}
 	public void visitConstantPool(ConstantPool obj){
		tostring = toString(obj);
 	}
	public void visitConstantString(ConstantString obj){
		tostring = toString(obj);
	}
	public void visitConstantUtf8(ConstantUtf8 obj){
		tostring = toString(obj);
	}
	public void visitConstantValue(ConstantValue obj){
		tostring = toString(obj);
	}
	public void visitDeprecated(com.sun.org.apache.bcel.internal.classfile.Deprecated obj){
		tostring = toString(obj);
	}
	public void visitExceptionTable(ExceptionTable obj){
		tostring = toString(obj);
	}
	public void visitField(Field obj){
		tostring = toString(obj);
	}
	public void visitInnerClass(InnerClass obj){
		tostring = toString(obj);
	}
	public void visitInnerClasses(InnerClasses obj){
		tostring = toString(obj);
	}
	public void visitJavaClass(JavaClass obj){
		tostring = toString(obj);
	}
	public void visitLineNumber(LineNumber obj){
		tostring = toString(obj);
	}
	public void visitLineNumberTable(LineNumberTable obj){
		tostring = "";
	}
	public void visitLocalVariable(LocalVariable obj){
		tostring = toString(obj);
	}
	public void visitLocalVariableTable(LocalVariableTable obj){
		tostring = "";
	}
	public void visitMethod(Method obj){
		tostring = toString(obj);
	}
  public void visitSignature(Signature obj){
    tostring = toString(obj);
  }
	public void visitSourceFile(SourceFile obj){
		tostring = toString(obj);
	} 
  public void visitStackMap(StackMap obj){
    tostring = toString(obj);
  }
	public void visitSynthetic(Synthetic obj){
		tostring = toString(obj);
	} 
	public void visitUnknown(Unknown obj){
		tostring = toString(obj);
	}
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy