Java Doc for Project.java in  » Code-Analyzer » findbugs » edu » umd » cs » findbugs » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Code Analyzer » findbugs » edu.umd.cs.findbugs 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   edu.umd.cs.findbugs.Project

Project
public class Project implements XMLWriteable(Code)
A project in the GUI. This consists of some number of Jar files to analyze for bugs, and optionally

  • some number of source directories, for locating the program's source code
  • some number of auxiliary classpath entries, for locating classes referenced by the program which the user doesn't want to analyze
  • some number of boolean options

author:
   David Hovemeyer


Field Summary
final static  StringAUX_CLASSPATH_ENTRY_ELEMENT_NAME
    
final static  StringFILENAME_ATTRIBUTE_NAME
    
final static  StringJAR_ELEMENT_NAME
    
final static  StringPROJECTNAME_ATTRIBUTE_NAME
    
final public static  StringRELATIVE_PATHS
    
final static  StringSRC_DIR_ELEMENT_NAME
    
final public static  StringUNNAMED_PROJECT
     Constant used to name anonymous projects.

Constructor Summary
public  Project()
     Create an anonymous project.

Method Summary
public  voidadd(Project project2)
    
public  booleanaddAuxClasspathEntry(String auxClasspathEntry)
    
public  booleanaddFile(String fileName)
     Add a file to the project.
public  booleanaddSourceDir(String dirName)
     Add a source directory to the project.
public  voidaddTimestamp(long timestamp)
    
public static  List<T>appendWithoutDuplicates(List<T> lst1, List<T> lst2)
    
public  Projectduplicate()
     Return an exact copy of this Project.
public  StringgetAuxClasspathEntry(int n)
     Get the n'th auxiliary classpath entry.
public  List<String>getAuxClasspathEntryList()
     Return the list of aux classpath entries.
public  StringgetFile(int num)
     Get the given file in the list of project files.
public  String[]getFileArray()
     Get project files as an array of Strings.
public  intgetFileCount()
     Get the number of files in the project.
public  List<String>getFileList()
     Get the list of files, directories, and zip files in the project.
public  List<String>getImplicitClasspathEntryList()
     Return the list of implicit classpath entries.
public  intgetNumAuxClasspathEntries()
     Get the number of auxiliary classpath entries.
public  intgetNumSourceDirs()
     Get the number of source directories in the project.
public  booleangetOption(String option)
     Retrieve the Options value.
public  StringgetProjectFileName()
     Get the project filename.
public  StringgetProjectName()
    
public  StringgetSourceDir(int num)
     Get the given source directory.
public  String[]getSourceDirArray()
     Get source dirs as an array of Strings.
public  List<String>getSourceDirList()
     Get the source dir list.
public  FiltergetSuppressionFilter()
    
public  longgetTimestamp()
    
public  booleanisModified()
     Return whether or not this Project has unsaved modifications.
 List<String>makeRelative(List<String> files, Object destination)
    
public  StringprojectNameFromProjectFileName()
    
public  voidread(String inputFile)
     Read the project from an input file.
public static  ProjectreadXML(File f)
    
public  voidremoveAuxClasspathEntry(int n)
     Remove the n'th auxiliary classpath entry.
public  voidremoveFile(int num)
    
public  voidremoveSourceDir(int num)
     Remove source directory at given index.
public  voidsetCurrentWorkingDirectory(File f)
    
public  voidsetModified(boolean isModified)
     Set whether or not this Project has unsaved modifications.
public  voidsetProjectFileName(String projectFileName)
     Set the project filename.
public  voidsetProjectName(String projectName)
    
public  voidsetSuppressionFilter(Filter suppressionFilter)
    
public  voidsetTimestamp(long timestamp)
    
public  StringtoString()
     Convert to a string in a nice (displayable) format.
public static  StringtransformFilename(String fileName)
     Transform a user-entered filename into a proper filename, by adding the ".fb" file extension if it isn't already present.
public  voidwrite(String outputFile, boolean useRelativePaths, String relativeBase)
     Save the project to an output file.
public  voidwriteXML(File f)
    
public  voidwriteXML(XMLOutput xmlOutput)
    
public  voidwriteXML(XMLOutput xmlOutput, Object destination)
    

Field Detail
AUX_CLASSPATH_ENTRY_ELEMENT_NAME
final static String AUX_CLASSPATH_ENTRY_ELEMENT_NAME(Code)



FILENAME_ATTRIBUTE_NAME
final static String FILENAME_ATTRIBUTE_NAME(Code)



JAR_ELEMENT_NAME
final static String JAR_ELEMENT_NAME(Code)



PROJECTNAME_ATTRIBUTE_NAME
final static String PROJECTNAME_ATTRIBUTE_NAME(Code)



RELATIVE_PATHS
final public static String RELATIVE_PATHS(Code)



SRC_DIR_ELEMENT_NAME
final static String SRC_DIR_ELEMENT_NAME(Code)



UNNAMED_PROJECT
final public static String UNNAMED_PROJECT(Code)
Constant used to name anonymous projects.




Constructor Detail
Project
public Project()(Code)
Create an anonymous project.




Method Detail
add
public void add(Project project2)(Code)
add information from project2 to this project



addAuxClasspathEntry
public boolean addAuxClasspathEntry(String auxClasspathEntry)(Code)
Add an auxiliary classpath entry
Parameters:
  auxClasspathEntry - the entry true if the entry was added successfully, or falseif the given entry is already in the list



addFile
public boolean addFile(String fileName)(Code)
Add a file to the project.
Parameters:
  fileName - the file to add true if the file was added, or false if thefile was already present



addSourceDir
public boolean addSourceDir(String dirName)(Code)
Add a source directory to the project.
Parameters:
  dirName - the directory to add true if the source directory was added, or false if thesource directory was already present



addTimestamp
public void addTimestamp(long timestamp)(Code)



appendWithoutDuplicates
public static List<T> appendWithoutDuplicates(List<T> lst1, List<T> lst2)(Code)



duplicate
public Project duplicate()(Code)
Return an exact copy of this Project.



getAuxClasspathEntry
public String getAuxClasspathEntry(int n)(Code)
Get the n'th auxiliary classpath entry.



getAuxClasspathEntryList
public List<String> getAuxClasspathEntryList()(Code)
Return the list of aux classpath entries.



getFile
public String getFile(int num)(Code)
Get the given file in the list of project files.
Parameters:
  num - the number of the file in the list of project files the name of the file



getFileArray
public String[] getFileArray()(Code)
Get project files as an array of Strings.



getFileCount
public int getFileCount()(Code)
Get the number of files in the project. the number of files in the project



getFileList
public List<String> getFileList()(Code)
Get the list of files, directories, and zip files in the project.



getImplicitClasspathEntryList
public List<String> getImplicitClasspathEntryList()(Code)
Return the list of implicit classpath entries. The implicit classpath is computed from the closure of the set of jar files that are referenced by the "Class-Path" attribute of the manifest of the any jar file that is part of this project or by the "Class-Path" attribute of any directly or indirectly referenced jar. The referenced jar files that exist are the list of implicit classpath entries.



getNumAuxClasspathEntries
public int getNumAuxClasspathEntries()(Code)
Get the number of auxiliary classpath entries.



getNumSourceDirs
public int getNumSourceDirs()(Code)
Get the number of source directories in the project. the number of source directories in the project



getOption
public boolean getOption(String option)(Code)
Retrieve the Options value.
Parameters:
  option - the name of option to get the value of the option



getProjectFileName
public String getProjectFileName()(Code)
Get the project filename.



getProjectName
public String getProjectName()(Code)
Returns the projectName.



getSourceDir
public String getSourceDir(int num)(Code)
Get the given source directory.
Parameters:
  num - the number of the source directory the source directory



getSourceDirArray
public String[] getSourceDirArray()(Code)
Get source dirs as an array of Strings.



getSourceDirList
public List<String> getSourceDirList()(Code)
Get the source dir list.



getSuppressionFilter
public Filter getSuppressionFilter()(Code)
Returns the suppressionFilter.



getTimestamp
public long getTimestamp()(Code)
Returns the timestamp.



isModified
public boolean isModified()(Code)
Return whether or not this Project has unsaved modifications.



makeRelative
List<String> makeRelative(List<String> files, Object destination)(Code)



projectNameFromProjectFileName
public String projectNameFromProjectFileName()(Code)



read
public void read(String inputFile) throws IOException(Code)
Read the project from an input file. This method should only be used on an empty Project (created with the default constructor).
Parameters:
  inputFile - name of the input file to read the project from
throws:
  IOException - if an error occurs while reading



readXML
public static Project readXML(File f) throws IOException, DocumentException, SAXException(Code)



removeAuxClasspathEntry
public void removeAuxClasspathEntry(int n)(Code)
Remove the n'th auxiliary classpath entry.



removeFile
public void removeFile(int num)(Code)
Remove file at the given index in the list of project files
Parameters:
  num - index of the file to remove in the list of project files



removeSourceDir
public void removeSourceDir(int num)(Code)
Remove source directory at given index.
Parameters:
  num - index of the source directory to remove



setCurrentWorkingDirectory
public void setCurrentWorkingDirectory(File f)(Code)



setModified
public void setModified(boolean isModified)(Code)
Set whether or not this Project has unsaved modifications.



setProjectFileName
public void setProjectFileName(String projectFileName)(Code)
Set the project filename.
Parameters:
  projectFileName - the new filename



setProjectName
public void setProjectName(String projectName)(Code)

Parameters:
  projectName - The projectName to set.



setSuppressionFilter
public void setSuppressionFilter(Filter suppressionFilter)(Code)

Parameters:
  suppressionFilter - The suppressionFilter to set.



setTimestamp
public void setTimestamp(long timestamp)(Code)

Parameters:
  timestamp - The timestamp to set.



toString
public String toString()(Code)
Convert to a string in a nice (displayable) format.



transformFilename
public static String transformFilename(String fileName)(Code)
Transform a user-entered filename into a proper filename, by adding the ".fb" file extension if it isn't already present.



write
public void write(String outputFile, boolean useRelativePaths, String relativeBase) throws IOException(Code)
Save the project to an output file.
Parameters:
  outputFile - name of output file
Parameters:
  useRelativePaths - true if the project should be writtenusing only relative paths
Parameters:
  relativeBase - if useRelativePaths is true,this file is taken as the base directory in terms of whichall files should be made relative
throws:
  IOException - if an error occurs while writing



writeXML
public void writeXML(File f) throws IOException(Code)



writeXML
public void writeXML(XMLOutput xmlOutput) throws IOException(Code)



writeXML
public void writeXML(XMLOutput xmlOutput, Object destination) throws IOException(Code)



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.