Class APITestCase

java.lang.Object
junit.framework.Assert
junit.framework.TestCase
com.thoughtworks.qdox.junit.APITestCase
All Implemented Interfaces:
junit.framework.Test

public abstract class APITestCase extends junit.framework.TestCase
APITestCase is a JUnit extension that will let you compare two sources (typically one kept as a static expected result and a generated one) on the API level.

This class has been ported from XJavaDoc's CodeTestCase, carrying over only the parts that compare on the API level. The original CodeTestCase also has comparison of Java source AST (Abstract Syntax Trees). This will probably be extracted into a ASTTestCase class and hosted as a separate project somewhere else. It should probably be based on JavaCC for ease of porting.

Author:
Aslak Hellesøy, Laurent Etiemble
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    assertApiEquals(URL expected, URL actual)
    Compares API of both sources in the readers.
    protected File
     
    protected File
     

    Methods inherited from class junit.framework.TestCase

    countTestCases, createResult, getName, run, run, runBare, runTest, setName, setUp, tearDown, toString

    Methods inherited from class junit.framework.Assert

    assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertTrue, assertTrue, fail, fail, failNotEquals, failNotSame, failSame

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • APITestCase

      public APITestCase()
  • Method Details

    • assertApiEquals

      public static void assertApiEquals(URL expected, URL actual) throws IOException
      Compares API of both sources in the readers.

      Note: This method is for backward naming compatiblity with xjavadoc.codeunit.CodeTestCase.

      Parameters:
      expected - the expected source
      actual - the actual source
      Throws:
      IOException
    • getDir

      protected File getDir()
    • getRootDir

      protected File getRootDir()