|
| |
|
| java.lang.Object
 org.acm.seguin.summary.Summary
org.acm.seguin.summary.PackageSummary
| PackageSummary | | public class PackageSummary extends Summary (Code) | | Creates a summary of a package
author:
Chris Seguin
since:
2.6.31 |
| PackageSummary | | protected PackageSummary(String packageName)(Code) | | Constructor for the package summary
since:
2.6.31
Parameters:
packageName - the name of the package |
| accept | | public Object accept(SummaryVisitor visitor, Object data)(Code) | | Provide method to visit a node
since:
2.6.31
Parameters:
visitor - the visitor
Parameters:
data - the data for the visit some new data |
| addFileSummary | | protected void addFileSummary(FileSummary fileSummary)(Code) | | Add a file summary
since:
2.6.31
Parameters:
fileSummary - the file summary that we are adding |
| deleteFileSummary | | public void deleteFileSummary(FileSummary fileSummary)(Code) | | Delete a file summary
since:
2.6.31
Parameters:
fileSummary - the file summary object that we are removing |
| getAllPackages | | public static Iterator getAllPackages()(Code) | | Get a package summary object
since:
2.6.31 all package summaries |
| getDirectory | | public File getDirectory()(Code) | | Get the directory associated with this package
since:
2.6.31 a file or null if none |
| getFileSummaries | | public Iterator getFileSummaries()(Code) | | Return an iterator of the files
since:
2.6.31 the iterator |
| getFileSummary | | public FileSummary getFileSummary(String name)(Code) | | Get a file summary by file name
since:
2.6.31
Parameters:
name - the name of the file summary the file summary if it is found and null otherwise |
| getName | | public String getName()(Code) | | Get the name of the package
since:
2.6.31 the package name |
| getPackageSummary | | public static PackageSummary getPackageSummary(String name)(Code) | | Get a package summary object
since:
2.6.31
Parameters:
name - the name of the package that we are creating The PackageSummary value |
| isTopLevel | | public boolean isTopLevel()(Code) | | Determines if it is the top level package
since:
2.6.31 true if it is the top level |
| loadAll | | public static void loadAll(ObjectInputStream in) throws IOException(Code) | | Loads all the packages from the object input stream
since:
2.6.31
Parameters:
in - Description of Parameter
exception:
IOException - Description of Exception |
| removeAll | | public static void removeAll()(Code) | | Removes all the packages to allow them to be reloaded
since:
2.6.31 |
| saveAll | | public static void saveAll(ObjectOutputStream out) throws IOException(Code) | | Saves all the packages to an object output stream
since:
2.6.31
Parameters:
out - Description of Parameter
exception:
IOException - Description of Exception |
| toString | | public String toString()(Code) | | Converts this object to a string
since:
2.6.31 the string |
| Fields inherited from org.acm.seguin.summary.Summary | protected int modifiers(Code)(Java Doc)
|
|
|
|