com.ibm.sigtest
Class ProjectDesc

java.lang.Object
  extended bycom.ibm.sigtest.ProjectDesc

public class ProjectDesc
extends java.lang.Object

This class stores a name and a collection of class descriptions, to form a project.

Author:
Matthew J. Duftler (duftler@us.ibm.com)

Constructor Summary
ProjectDesc(java.lang.String name)
           
 
Method Summary
 void addClassDesc(ClassDesc classDesc)
           
 java.lang.String compare(ProjectDesc that)
          This method compares this project description to the specified one.
static java.lang.String compareProjectFile(java.io.File projectFile)
          This method compares the specified project file to the classes currently available on the classpath.
 ClassDesc getClassDesc(java.lang.String className)
           
 java.util.List getClassDescs()
           
static ProjectDesc readProjectFile(java.lang.String projectName, java.io.File file)
          This method reads the specified project file into memory.
 void setClassDescs(java.util.List classDescs)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ProjectDesc

public ProjectDesc(java.lang.String name)
Method Detail

addClassDesc

public void addClassDesc(ClassDesc classDesc)

getClassDesc

public ClassDesc getClassDesc(java.lang.String className)

setClassDescs

public void setClassDescs(java.util.List classDescs)

getClassDescs

public java.util.List getClassDescs()

compare

public java.lang.String compare(ProjectDesc that)
This method compares this project description to the specified one.

Parameters:
that - the project description to compare this one to
Returns:
a description of the differences, or null if they match perfectly

compareProjectFile

public static java.lang.String compareProjectFile(java.io.File projectFile)
                                           throws java.io.IOException
This method compares the specified project file to the classes currently available on the classpath.

Returns:
a description of the differences, or null if they match perfectly
Throws:
java.io.IOException

toString

public java.lang.String toString()

readProjectFile

public static ProjectDesc readProjectFile(java.lang.String projectName,
                                          java.io.File file)
                                   throws java.io.IOException
This method reads the specified project file into memory.

Parameters:
projectName - the name to be used when referring to the project in error messages
file - the project file to read from
Returns:
a model of the project
Throws:
java.io.IOException


Copyright © 2003 IBM. All Rights Reserved.