apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/builder/tests/tags/ValidInterfaceMethodTagTests.java

/*******************************************************************************
 * Copyright (c) 2008 IBM Corporation and others.
 * 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
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.pde.api.tools.builder.tests.tags;

import junit.framework.Test;

import org.eclipse.core.runtime.IPath;

/**
 * Tests valid javadoc tags on interface methods
 * 
 * @since 1.0
 */
public class ValidInterfaceMethodTagTests extends ValidMethodTagTests {

	/**
	 * Constructor
	 * @param name
	 */
	public ValidInterfaceMethodTagTests(String name) {
		super(name);
	}

	/* (non-Javadoc)
	 * @see org.eclipse.pde.api.tools.builder.tests.ApiBuilderTests#getTestSourcePath()
	 */
	protected IPath getTestSourcePath() {
		return super.getTestSourcePath().append("interface");
	}
	
	/**
	 * @return the test for this class
	 */
	public static Test suite() {
		return buildTestSuite(ValidInterfaceMethodTagTests.class);
	}

	public void testValidInterfaceMethodTag1I() {
		x1(true);
	}

	public void testValidInterfaceMethodTag1F() {
		x1(false);
	}
	
	/**
	 * Tests the supported @noreference tag on interface methods
	 */
	private void x1(boolean inc) {
		deployTagTest("test1.java", inc, false);
	}

	public void testValidInterfaceMethodTag2I() {
		x2(true);
	}
	
	public void testValidInterfaceMethodTag2F() {
		x2(false);
	}
	
	/**
	 * Tests the supported @noreference tag on outer interface methods
	 */
	private void x2(boolean inc) {
		deployTagTest("test2.java", inc, false);
	}

	public void testValidInterfaceMethodTag3I() {
		x3(true);
	}

	public void testValidInterfaceMethodTag3F() {
		x3(false);
	}

	/**
	 * Tests the supported @noreference tag on inner interface methods
	 */
	private void x3(boolean inc) {
		deployTagTest("test3.java", inc, false);
	}
	
	public void testValidInterfaceMethodTag4I() {
		x4(true);
	}
	
	public void testValidInterfaceMethodTag4F() {
		x4(false);
	}

	/**
	 * Tests the supported @noreference tag on a variety of inner / outer interface methods
	 */
	private void x4(boolean inc) {
		deployTagTest("test4.java", inc, false);
	}
	
	public void testValidInterfaceMethodTag5I() {
		x5(true);
	}
	
	public void testValidInterfaceMethodTag5F() {
		x5(false);
	}
	
	/**
	 * Tests the supported @noreference tag on interface methods in the default package
	 */
	private void x5(boolean inc) {
		deployTagTest("test5.java", inc, true);
	}
}