Java Doc for JDependTask.java in  » Build » ANT » org » apache » tools » ant » taskdefs » optional » jdepend » 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 » Build » ANT » org.apache.tools.ant.taskdefs.optional.jdepend 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.tools.ant.Task
   org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask

JDependTask
public class JDependTask extends Task (Code)
Runs JDepend tests.

JDepend is a tool to generate design quality metrics for each Java package. It has been initially created by Mike Clark. JDepend can be found at http://www.clarkware.com/software/JDepend.html. The current implementation spawn a new Java VM.


Inner Class :public static class FormatAttribute extends EnumeratedAttribute



Method Summary
public  PathcreateClassespath()
     Adds a path to class code to analyze.
public  PathcreateClasspath()
     Adds a path to the classpath.
public  PatternSet.NameEntrycreateExclude()
    
public  Commandline.ArgumentcreateJvmarg(CommandlineJava commandline)
     Create a new JVM argument.
public  PathcreateSourcespath()
     Adds a path to source code to analyze.
protected  ExecuteWatchdogcreateWatchdog()
    
public  voidexecute()
    
public  intexecuteAsForked(CommandlineJava commandline, ExecuteWatchdog watchdog)
     Execute the task by forking a new JVM.
public  intexecuteInVM(CommandlineJava commandline)
     Execute inside VM.
public  PathgetClassespath()
     Gets the classespath.
public  PathgetClasspath()
     Gets the classpath to be used for this compilation.
public  FilegetDir()
    
public  PatternSetgetExcludes()
    
public  booleangetFork()
    
public  booleangetHaltonerror()
    
public  FilegetOutputFile()
    
public  PathgetSourcespath()
     Gets the sourcepath.
public  LonggetTimeout()
    
public  voidsetClasspath(Path classpath)
     Set the classpath to be used for this compilation.
public  voidsetClasspathRef(Reference r)
     Adds a reference to a classpath defined elsewhere.
public  voidsetDir(File dir)
     The directory to invoke the VM in.
public  voidsetFork(boolean value)
     If true, forks into a new JVM.
public  voidsetFormat(FormatAttribute ea)
     The format to write the output in, "xml" or "text".
public  voidsetHaltonerror(boolean haltonerror)
     Whether or not to halt on failure.
public  voidsetIncluderuntime(boolean b)
     If true, include jdepend.jar in the forked VM.
public  voidsetJvm(String value)
     The command used to invoke a forked Java Virtual Machine. Default is java.
public  voidsetOutputFile(File outputFile)
     The output file name.
public  voidsetTimeout(Long value)
     Set the timeout value (in milliseconds).

If the operation is running for more than this value, the jdepend will be canceled.




Method Detail
createClassespath
public Path createClassespath()(Code)
Adds a path to class code to analyze. a classes path



createClasspath
public Path createClasspath()(Code)
Adds a path to the classpath. a classpath



createExclude
public PatternSet.NameEntry createExclude()(Code)
add a name entry on the exclude list a pattern for the excludes



createJvmarg
public Commandline.Argument createJvmarg(CommandlineJava commandline)(Code)
Create a new JVM argument. Ignored if no JVM is forked.
Parameters:
  commandline - the commandline to create the argument on create a new JVM argument so that any argument canbe passed to the JVM.
See Also:   JDependTask.setFork(boolean)



createSourcespath
public Path createSourcespath()(Code)
Adds a path to source code to analyze. a source path



createWatchdog
protected ExecuteWatchdog createWatchdog() throws BuildException(Code)
null if there is a timeout value, otherwise thewatchdog instance.
throws:
  BuildException - in case of error



execute
public void execute() throws BuildException(Code)
execute the task
exception:
  BuildException - if an error occurs



executeAsForked
public int executeAsForked(CommandlineJava commandline, ExecuteWatchdog watchdog) throws BuildException(Code)
Execute the task by forking a new JVM. The command will block until it finishes. To know if the process was destroyed or not, use the killedProcess() method of the watchdog class.
Parameters:
  commandline - the commandline for forked jvm
Parameters:
  watchdog - the watchdog in charge of cancelling the test if itexceeds a certain amount of time. Can be null. the result of running the jdepend
throws:
  BuildException - in case of error



executeInVM
public int executeInVM(CommandlineJava commandline) throws BuildException(Code)
Execute inside VM.
Parameters:
  commandline - the command line the return value of the mvm
exception:
  BuildException - if an error occurs



getClassespath
public Path getClassespath()(Code)
Gets the classespath. the classes path



getClasspath
public Path getClasspath()(Code)
Gets the classpath to be used for this compilation. the class path used for compilation



getDir
public File getDir()(Code)
the dir attribute



getExcludes
public PatternSet getExcludes()(Code)
the excludes patterns



getFork
public boolean getFork()(Code)
the value of the fork attribute



getHaltonerror
public boolean getHaltonerror()(Code)
the value of the haltonerror attribute



getOutputFile
public File getOutputFile()(Code)
the output file name



getSourcespath
public Path getSourcespath()(Code)
Gets the sourcepath. the sources path



getTimeout
public Long getTimeout()(Code)
the timeout value



setClasspath
public void setClasspath(Path classpath)(Code)
Set the classpath to be used for this compilation.
Parameters:
  classpath - a class path to be used



setClasspathRef
public void setClasspathRef(Reference r)(Code)
Adds a reference to a classpath defined elsewhere.
Parameters:
  r - a classpath reference



setDir
public void setDir(File dir)(Code)
The directory to invoke the VM in. Ignored if no JVM is forked.
Parameters:
  dir - the directory to invoke the JVM from.
See Also:   JDependTask.setFork(boolean)



setFork
public void setFork(boolean value)(Code)
If true, forks into a new JVM. Default: false.
Parameters:
  value - true if a JVM should be forked,otherwise false



setFormat
public void setFormat(FormatAttribute ea)(Code)
The format to write the output in, "xml" or "text".
Parameters:
  ea - xml or text



setHaltonerror
public void setHaltonerror(boolean haltonerror)(Code)
Whether or not to halt on failure. Default: false.
Parameters:
  haltonerror - the value to set



setIncluderuntime
public void setIncluderuntime(boolean b)(Code)
If true, include jdepend.jar in the forked VM.
Parameters:
  b - include ant run time yes or no
since:
   Ant 1.6



setJvm
public void setJvm(String value)(Code)
The command used to invoke a forked Java Virtual Machine. Default is java. Ignored if no JVM is forked.
Parameters:
  value - the new VM to use instead of java
See Also:   JDependTask.setFork(boolean)



setOutputFile
public void setOutputFile(File outputFile)(Code)
The output file name.
Parameters:
  outputFile - the output file name



setTimeout
public void setTimeout(Long value)(Code)
Set the timeout value (in milliseconds).

If the operation is running for more than this value, the jdepend will be canceled. (works only when in 'fork' mode).


Parameters:
  value - the maximum time (in milliseconds) allowed beforedeclaring the test as 'timed-out'
See Also:   JDependTask.setFork(boolean)



Fields inherited from org.apache.tools.ant.Task
protected Target target(Code)(Java Doc)
protected String taskName(Code)(Java Doc)
protected String taskType(Code)(Java Doc)
protected RuntimeConfigurable wrapper(Code)(Java Doc)

Methods inherited from org.apache.tools.ant.Task
final public void bindToOwner(Task owner)(Code)(Java Doc)
public void execute() throws BuildException(Code)(Java Doc)
public Target getOwningTarget()(Code)(Java Doc)
public RuntimeConfigurable getRuntimeConfigurableWrapper()(Code)(Java Doc)
public String getTaskName()(Code)(Java Doc)
public String getTaskType()(Code)(Java Doc)
protected RuntimeConfigurable getWrapper()(Code)(Java Doc)
protected void handleErrorFlush(String output)(Code)(Java Doc)
protected void handleErrorOutput(String output)(Code)(Java Doc)
protected void handleFlush(String output)(Code)(Java Doc)
protected int handleInput(byte[] buffer, int offset, int length) throws IOException(Code)(Java Doc)
protected void handleOutput(String output)(Code)(Java Doc)
public void init() throws BuildException(Code)(Java Doc)
final protected boolean isInvalid()(Code)(Java Doc)
public void log(String msg)(Code)(Java Doc)
public void log(String msg, int msgLevel)(Code)(Java Doc)
public void log(Throwable t, int msgLevel)(Code)(Java Doc)
public void log(String msg, Throwable t, int msgLevel)(Code)(Java Doc)
public void maybeConfigure() throws BuildException(Code)(Java Doc)
final public void perform()(Code)(Java Doc)
public void reconfigure()(Code)(Java Doc)
public void setOwningTarget(Target target)(Code)(Java Doc)
public void setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)(Code)(Java Doc)
public void setTaskName(String name)(Code)(Java Doc)
public void setTaskType(String type)(Code)(Java Doc)

w___w___w_._j__a_va___2_s___.___c_o___m | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.