[an error occurred while processing this directive]

JavaClass Class Client Specifications

Purpose

A JavaClass object contains documentation, package and file information, and feature definitions for a Java class. These objects represent Java classes in a CASE tool for developing software in Java.

Superclasses and Interfaces

Superclass: Object

Importing Information

import javacase.JavaClass;

Client Data Model

A JavaClass manages the following types of information about a Java class:

source code location -
package and file containing the source code
inheritance -
parent class and interfaces implemented by the class
client documentation -
HTML text describing the purpose, importing information, and client data model
implementation documentation -
HTML text describing the implementation data model
features -
class and instance variables and methods

Methods are provided for setting and getting all information for a JavaClass, except that some information cannot be set for data integrity reasons described below. Features can be accessed individually by name (variables) or signature (methods). Features can also be accessed as collections using traversals.

Documentation about features of a Java class is not maintained directly by JavaClass objects. This documentation can be accessed through the features of the class.

Data Integrity

The most important data integrity consideration concerns the parent of a JavaClass. Since the graph of the parent relationship cannot contain cycles, assigning class A as a parent of class B is not permitted when B is an ancestor of A. The ancestral relationship is defined recursively as follows. B is an ancestor of A if either B is the same as A or if B is the parent of C, where C is an ancestor of A.

Data integrity could also be corrupted by inconsistency between package location and importing information. To avoid this problem, there is no provision for setting the importing information. The importing information text is constructed from the package information of the JavaClass. This is set when the class is added to a JavaPackage.

Finally, there are data integrity requirements imposed by the Java language definition with regard to source code file names. The language requires that code for a public class be located in a file whose name is the class name with a .java suffix. Thus a public Java class cannot be moved to a different source code file.

Method Preconditions

Some of the JavaClass methods have preconditions. Methods are provided for checking these preconditions prior to executing the method. If the check fails then the program is terminated with a IllegalArgumentException exception.

Public Methods

Constructors

public JavaClass()
new JavaClass() returns a new JavaClass for a Java class whose parent class is the Java Object class.
public JavaClass(JavaClass par)
new JavaClass(JavaClass par) returns a new JavaClass for a Java class whose parent class is par.

Source Code Information

JavaPackage getPackage()
jcl.getPackage() returns the package that contains jcl, or null if jcl is not currently assigned to a package.
JavaFile getFile()
jcl.getFile() returns the source code file that defines jcl.
void moveCode(JavaFile jf)
jcl.moveCode(f) moves source code for jcl from its source code file to file jf.
Preconditions:
jcl is not a public class. jf is in the same package as jcl.

Inheritance Information

JavaClass getParent()
jcl.getParent() returns the class for jcl, or null if jcl is class Object.
boolean hasAncestor(JavaClass jcl1)
jcl.hasAncestor(jcl1) returns true if jcl1 is the same class as, or an ancestor of jcl.
void setParent(JavaClass par)
jcl.setParent(par) sets par as the parent class for jcl.
precondition: par.hasAncestor(jcl) is false.

Documentation

HTMLText getPurpose()
jcl.getPurpose() returns text describing the purpose of jcl.
void setPurpose(HTMLText txt)
jcl.setPurpose(txt) sets the text describing the purpose of jcl to txt.
HTMLText getImportingInformation()
jcl.getImportingInformation() returns text describing importing information for jcl.
HTMLText getClientDataModel()
jcl.getClientDataModel() returns text describing the client data model of jcl.
void setClientDataModel(HTMLText txt)
jcl.setClientDataModel(txt) sets the text describing the client data model of jcl to txt.
HTMLText getImplementationDataModel()
jcl.getImplementationDataModel() returns text describing the implementation data model of jcl.
void setImplementationDataModel(HTMLText txt)
jcl.setImplementationDataModel(txt) sets the text describing the implementation data model of jcl to txt.

Individual Feature Information

public void addMethod(JavaMethod m)
jcl.addMethod(JavaMethod m) adds the method m to jcl.
Preconditions:
jcl does not contain a method whose signature is the same as m's.
public void removeMethod(JavaMethod m)
jcl.removeMethod(JavaMethod m) removes the method m from jcl.
Preconditions:
m is a method of jcl.
public void addVariable(JavaVariable v)
jcl.addVariable(JavaVariable v) adds the variable v to jcl.
Preconditions:
jcl does not contain a variable whose name is the same as v's.
public void removeVariable(JavaVariable v)
jcl.removeVariable(JavaVariable v) removes the variable v from jcl.
Preconditions:
v is a method of jcl.

Feature Traversal

void traversePublicClassVariables(IVisitor vis)
jc.traversePublicClassVariables(vis) executes vis.visit(var) for each public class variable var of jc.
void traverseRestrictedClassVariables(IVisitor vis)
jc.traverseRestrictedClassVariables(vis) executes vis.visit(var) for each restricted access class variable var of jc.
void traversePublicInstanceVariables(IVisitor vis)
jc.traversePublicInstanceVariables(vis) executes vis.visit(var) for each public instance variable var of jc.
void traverseRestrictedInstanceVariables(IVisitor vis)
jc.traverseRestrictedInstanceVariables(vis) executes vis.visit(var) for each restricted access instance variable var of jc.
void traversePublicClassMethods(IVisitor vis)
jc.traversePublicClassMethods(vis) executes vis.visit(meth) for each public class method meth of jc.
void traverseRestrictedClassMethods(IVisitor vis)
jc.traverseRestrictedClassMethods(vis) executes vis.visit(meth) for each restricted access class method meth of jc.
void traversePublicInstanceMethods(IVisitor vis)
jc.traversePublicInstanceMethods(vis) executes vis.visit(meth) for each public instance method meth of jc.
void traverseRestrictedInstanceMethods(IVisitor vis)
jc.traverseRestrictedInstanceMethods(vis) executes vis.visit(meth) for each restricted access instance method meth of jc.

[an error occurred while processing this directive]