UTJML

edu.utep.cs.utjml.canica.tool
Interface Toolable

All Known Implementing Classes:
ToolController

public interface Toolable

The Toolable class is responsible to provide the services to run the external tools of Canica. The tools are contained in the UTJML tools and Java SDK 1.4.2 systems. Such tools are: Java compiler, JML compiler, JML syntax checker, Java Virtual Machine, test generator, Javadoc, and JMLdoc.

Author:
Angelica B. Perez Apr 24, 2006

Method Summary
 void checkJML()
          This service calls the JML checker tool from the UTJML tools system to check JML syntax to a single Java file.
 void checkJMLCurrAndSubdirs()
          This service calls the JML checker tool from the UTJML tools system to check JML syntax to all files under specific directory and all subdirectories.
 void checkJMLCurrentDir()
          This service calls the JML checker tool from the UTJML tools system to check JML syntax to all files in the current directory.
 void checkJMLGroupOfFiles()
          This service calls the JML checker tool from the UTJML tools system to check JML syntax to a group of files.
 void compileJava()
          Calls the Java compiler tool from the Java SDK 1.4.2 to compile the active editing Java file.
 void compileJML()
          This service calls the JML compiler tool from the UTJML tools system to compile the active editing file.
 void compileJMLTest()
          This service calls the tool from the UTJML tools system to compile the active editing file for test.
 void compileTestDataForTest()
          This service calls the Java compiler tool from the Java SDK 1.4.2 system to compile the test data generated of the active editing file.
 void getAutomTestingToolAction()
          This service does automatically testing to the active editing file.
 void javaDoc()
          This service calls the Javadoc tool from the Java SDK 1.4.2 system to generate Java documentation to a single file, a group of files, or all files under specific directory and subdirectories.
 void JMLDoc()
          It generates JML documentation to the active editing file or files given using the JMLDoc tool from the UTJML tools.
 void loadAndTest()
          This service lets the user load a test file in the JML editor to compile it with the Java compiler and then test it.
 void run()
          This service calls the Java Virtual Machine tool from the Java SDK 1.4.2 to run the Java bytecode file of the active editing file.
 void runTest()
          It runs the test data file class (*_JML_TestData.class) corresponding to the active editing file.
 void runTestGeneration()
          This service calls the tool from the UTJML tools system to generate test data for a Java file.
 void selectRunTestClass()
          It runs a test class file.
 

Method Detail

compileJava

void compileJava()
Calls the Java compiler tool from the Java SDK 1.4.2 to compile the active editing Java file.


runTest

void runTest()
It runs the test data file class (*_JML_TestData.class) corresponding to the active editing file. It displays the output to the Run Test view (Output subsystem).


selectRunTestClass

void selectRunTestClass()
It runs a test class file. It provides a Dialog to choose a specific test class file. It doesn't need to be opened in the JML editor.


javaDoc

void javaDoc()
This service calls the Javadoc tool from the Java SDK 1.4.2 system to generate Java documentation to a single file, a group of files, or all files under specific directory and subdirectories.


JMLDoc

void JMLDoc()
It generates JML documentation to the active editing file or files given using the JMLDoc tool from the UTJML tools.


checkJML

void checkJML()
This service calls the JML checker tool from the UTJML tools system to check JML syntax to a single Java file.


checkJMLCurrentDir

void checkJMLCurrentDir()
This service calls the JML checker tool from the UTJML tools system to check JML syntax to all files in the current directory.


checkJMLGroupOfFiles

void checkJMLGroupOfFiles()
This service calls the JML checker tool from the UTJML tools system to check JML syntax to a group of files.


checkJMLCurrAndSubdirs

void checkJMLCurrAndSubdirs()
This service calls the JML checker tool from the UTJML tools system to check JML syntax to all files under specific directory and all subdirectories.


compileJML

void compileJML()
This service calls the JML compiler tool from the UTJML tools system to compile the active editing file.


run

void run()
This service calls the Java Virtual Machine tool from the Java SDK 1.4.2 to run the Java bytecode file of the active editing file.


compileJMLTest

void compileJMLTest()
This service calls the tool from the UTJML tools system to compile the active editing file for test.


runTestGeneration

void runTestGeneration()
This service calls the tool from the UTJML tools system to generate test data for a Java file. This is the second step for testing.


compileTestDataForTest

void compileTestDataForTest()
This service calls the Java compiler tool from the Java SDK 1.4.2 system to compile the test data generated of the active editing file. This is the third step for testing.


loadAndTest

void loadAndTest()
This service lets the user load a test file in the JML editor to compile it with the Java compiler and then test it.


getAutomTestingToolAction

void getAutomTestingToolAction()
This service does automatically testing to the active editing file. It executes the four steps: compile JML for test, generate test data, compile test data generated for test, and run the tests.


UTJML

UTJML is Copyright (C) 2004-2006 by University of Texas at El Paso and is distributed under the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This release depends on code from the JML project.