plugins/org.eclipse.objectteams.otequinox.hook/src/org/eclipse/objectteams/otequinox/hook/IByteCodeAnalyzer.java

/**********************************************************************
 * This file is part of "Object Teams Development Tooling"-Software
 * 
 * Copyright 2008 Technical University Berlin, Germany.
 * 
 * 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
 * 
 * Please visit http://www.eclipse.org/objectteams for updates and contact.
 * 
 * Contributors:
 * Technical University Berlin - Initial API and implementation
 **********************************************************************/
package org.eclipse.objectteams.otequinox.hook;

import java.io.InputStream;

/**
 * Interface for byte code analyzers that peek specific information
 * from a class' byte code without parsing the whole structure.
 * 
 * @author stephan
 * @since 1.2.3
 */
public interface IByteCodeAnalyzer {

	/** 
	 * Fetch the superclass name of a given class.
	 * @param classStream stream providing the class bytes
	 * @param className fully qualified name of the class
	 * @return fully qualified ('.'-separated) name of the class' superclass or null if an exception occurred.
	 */
	String getSuperclass(InputStream classStream, String className);
	
	/** 
	 * Fetch the superclass name of a given class.
	 * @param classBytes array of class bytes
	 * @param className fully qualified name of the class
	 * @return fully qualified ('.'-separated) name of the class' superclass or null if an exception occurred.
	 */
	String getSuperclass(byte[] classBytes, String className);
}