EnclosingMethodAttributeTest.java

/* *******************************************************************
 * Copyright (c) 2004 IBM
 * All rights reserved.
 * This program and the accompanying materials are made available
 * under the terms of the Eclipse Public License v 2.0
 * which accompanies this distribution and is available at
 * https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.txt
 *
 * Contributors:
 *     Andy Clement -     initial implementation
 * ******************************************************************/

package org.aspectj.apache.bcel.classfile.tests;

import java.io.File;
import java.io.IOException;

import org.aspectj.apache.bcel.classfile.Attribute;
import org.aspectj.apache.bcel.classfile.ConstantPool;
import org.aspectj.apache.bcel.classfile.EnclosingMethod;
import org.aspectj.apache.bcel.classfile.JavaClass;
import org.aspectj.apache.bcel.util.SyntheticRepository;

public class EnclosingMethodAttributeTest extends BcelTestCase {

	@Override
	protected void setUp() throws Exception {
		super.setUp();
	}

	/**
	 * Verify for an inner class declared inside the 'main' method that the enclosing method attribute is set correctly.
	 */
	public void testCheckMethodLevelNamedInnerClass() throws ClassNotFoundException {
		SyntheticRepository repos = createRepos("testcode.jar");
		JavaClass clazz = repos.loadClass("AttributeTestClassEM01$1S");
		ConstantPool pool = clazz.getConstantPool();
		Attribute[] encMethodAttrs = findAttribute("EnclosingMethod", clazz);
		assertTrue("Expected 1 EnclosingMethod attribute but found " + encMethodAttrs.length, encMethodAttrs.length == 1);
		EnclosingMethod em = (EnclosingMethod) encMethodAttrs[0];
		String enclosingClassName = em.getEnclosingClass().getClassname(pool);
		String enclosingMethodName = em.getEnclosingMethod().getName(pool);
		assertTrue("Expected class name to be 'AttributeTestClassEM01' but was " + enclosingClassName, enclosingClassName
				.equals("AttributeTestClassEM01"));
		assertTrue("Expected method name to be 'main' but was " + enclosingMethodName, enclosingMethodName.equals("main"));
	}

	/**
	 * Verify for an inner class declared at the type level that the EnclosingMethod attribute is set correctly (i.e. to a null
	 * value)
	 */
	public void testCheckClassLevelNamedInnerClass() throws ClassNotFoundException {
		SyntheticRepository repos = createRepos("testcode.jar");
		JavaClass clazz = repos.loadClass("AttributeTestClassEM02$1");
		ConstantPool pool = clazz.getConstantPool();
		Attribute[] encMethodAttrs = findAttribute("EnclosingMethod", clazz);
		assertTrue("Expected 1 EnclosingMethod attribute but found " + encMethodAttrs.length, encMethodAttrs.length == 1);
		EnclosingMethod em = (EnclosingMethod) encMethodAttrs[0];
		String enclosingClassName = em.getEnclosingClass().getClassname(pool);
		assertTrue("The class is not within a method, so method_index should be null, but it is " + em.getEnclosingMethodIndex(),
				em.getEnclosingMethodIndex() == 0);
		assertTrue("Expected class name to be 'AttributeTestClassEM02' but was " + enclosingClassName, enclosingClassName
				.equals("AttributeTestClassEM02"));
	}

	/**
	 * Check that we can save and load the attribute correctly.
	 */
	public void testAttributeSerializtion() throws ClassNotFoundException, IOException {
		// Read in the class
		SyntheticRepository repos = createRepos("testcode.jar");
		JavaClass clazz = repos.loadClass("AttributeTestClassEM02$1");
		ConstantPool pool = clazz.getConstantPool();
		Attribute[] encMethodAttrs = findAttribute("EnclosingMethod", clazz);
		assertTrue("Expected 1 EnclosingMethod attribute but found " + encMethodAttrs.length, encMethodAttrs.length == 1);

		// Write it out
		File tfile = createTestdataFile("AttributeTestClassEM02$1.class");
		clazz.dump(tfile);

		// Read in the new version and check it is OK
		SyntheticRepository repos2 = createRepos(".");
		JavaClass clazz2 = repos2.loadClass("AttributeTestClassEM02$1");
		EnclosingMethod em = (EnclosingMethod) encMethodAttrs[0];
		String enclosingClassName = em.getEnclosingClass().getClassname(pool);
		assertTrue("The class is not within a method, so method_index should be null, but it is " + em.getEnclosingMethodIndex(),
				em.getEnclosingMethodIndex() == 0);
		assertTrue("Expected class name to be 'AttributeTestClassEM02' but was " + enclosingClassName, enclosingClassName
				.equals("AttributeTestClassEM02"));
		assertTrue(tfile.delete());
	}

	@Override
	protected void tearDown() throws Exception {
		super.tearDown();
	}

}