Java Doc for CheckStyleTask.java in  » Code-Analyzer » checkstyle » com » puppycrawl » tools » checkstyle » 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 » checkstyle » com.puppycrawl.tools.checkstyle 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


com.puppycrawl.tools.checkstyle.CheckStyleTask

CheckStyleTask
public class CheckStyleTask extends Task (Code)
An implementation of a ANT task for calling checkstyle. See the documentation of the task for usage.
author:
   Oliver Burn

Inner Class :public static class FormatterType extends EnumeratedAttribute
Inner Class :public static class Formatter
Inner Class :public static class Property
Inner Class :public static class Listener



Method Summary
public  voidaddFileset(FileSet aFS)
     Adds a set of files (nested fileset attribute).
public  voidaddFormatter(Formatter aFormatter)
     Add a formatter.
public  voidaddProperty(Property aProperty)
     Add an override property.
public  PathcreateClasspath()
    
public  voidexecute()
     Actually checks the files specified.
protected  AuditListener[]getListeners()
     Return the list of listeners set in this task.
protected  File[]scanFileSets()
     returns the list of files (full path name) to process.
public  voidsetClasspath(Path aClasspath)
     Set the class path.
public  voidsetClasspathRef(Reference aClasspathRef)
     Set the class path from a reference defined elsewhere.
public  voidsetConfig(File aFile)
    
public  voidsetConfigURL(URL aURL)
    
public  voidsetFailOnViolation(boolean aFail)
    
public  voidsetFailureProperty(String aPropertyName)
     Tells this task to set the named property to "true" when there is a violation.
public  voidsetFile(File aFile)
    
public  voidsetMaxErrors(int aMaxErrors)
     Sets the maximum number of errors allowed.
public  voidsetMaxWarnings(int aMaxWarnings)
     Sets the maximum number of warings allowed.
public  voidsetPackageNamesFile(File aFile)
    
public  voidsetProperties(File aProps)
     Sets a properties file for use instead of individually setting them.



Method Detail
addFileset
public void addFileset(FileSet aFS)(Code)
Adds a set of files (nested fileset attribute).
Parameters:
  aFS - the file set to add



addFormatter
public void addFormatter(Formatter aFormatter)(Code)
Add a formatter.
Parameters:
  aFormatter - the formatter to add for logging.



addProperty
public void addProperty(Property aProperty)(Code)
Add an override property.
Parameters:
  aProperty - the property to add



createClasspath
public Path createClasspath()(Code)
a created path for locating classes



execute
public void execute() throws BuildException(Code)
Actually checks the files specified. All errors are reported to System.out. Will fail if any errors occurred.
throws:
  BuildException - an error occurred



getListeners
protected AuditListener[] getListeners() throws ClassNotFoundException, InstantiationException, IllegalAccessException, IOException(Code)
Return the list of listeners set in this task. the list of listeners.
throws:
  ClassNotFoundException - if an error occurs
throws:
  InstantiationException - if an error occurs
throws:
  IllegalAccessException - if an error occurs
throws:
  IOException - if an error occurs



scanFileSets
protected File[] scanFileSets()(Code)
returns the list of files (full path name) to process. the list of files included via the filesets.



setClasspath
public void setClasspath(Path aClasspath)(Code)
Set the class path.
Parameters:
  aClasspath - the path to locate classes



setClasspathRef
public void setClasspathRef(Reference aClasspathRef)(Code)
Set the class path from a reference defined elsewhere.
Parameters:
  aClasspathRef - the reference to an instance defining the classpath



setConfig
public void setConfig(File aFile)(Code)

Parameters:
  aFile - the configuration file to use



setConfigURL
public void setConfigURL(URL aURL)(Code)

Parameters:
  aURL - the URL of the configuration to use



setFailOnViolation
public void setFailOnViolation(boolean aFail)(Code)

Parameters:
  aFail - whether to fail if a violation is found



setFailureProperty
public void setFailureProperty(String aPropertyName)(Code)
Tells this task to set the named property to "true" when there is a violation.
Parameters:
  aPropertyName - the name of the property to setin the event of an failure.



setFile
public void setFile(File aFile)(Code)

Parameters:
  aFile - the file to be checked



setMaxErrors
public void setMaxErrors(int aMaxErrors)(Code)
Sets the maximum number of errors allowed. Default is 0.
Parameters:
  aMaxErrors - the maximum number of errors allowed.



setMaxWarnings
public void setMaxWarnings(int aMaxWarnings)(Code)
Sets the maximum number of warings allowed. Default is Integer.MAX_VALUE .
Parameters:
  aMaxWarnings - the maximum number of warnings allowed.



setPackageNamesFile
public void setPackageNamesFile(File aFile)(Code)

Parameters:
  aFile - the package names file to use



setProperties
public void setProperties(File aProps)(Code)
Sets a properties file for use instead of individually setting them.
Parameters:
  aProps - the properties File to use



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