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


java.lang.Object
   com.puppycrawl.tools.checkstyle.api.AutomaticBean
      com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
         com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck

All known Subclasses:   com.puppycrawl.tools.checkstyle.checks.duplicates.StrictDuplicateCodeCheck,  com.puppycrawl.tools.checkstyle.checks.javadoc.PackageHtmlCheck,  com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck,  com.puppycrawl.tools.checkstyle.checks.TranslationCheck,  com.mycompany.checks.LimitImplementationFiles,  com.puppycrawl.tools.checkstyle.bcel.ClassFileSetCheck,  com.puppycrawl.tools.checkstyle.checks.header.CrossLanguageRegexpHeaderCheck,  com.puppycrawl.tools.checkstyle.TreeWalker,
AbstractFileSetCheck
abstract public class AbstractFileSetCheck extends AbstractViolationReporter implements FileSetCheck(Code)
Provides common functionality for many FileSetChecks.
author:
   lkuehne




Method Summary
public  voiddestroy()
    
final protected  File[]filter(File[] aFiles)
     Determines the set of files this FileSetCheck is interested in.
final protected  voidfireErrors(String aFileName)
     Notify all listeners about the errors in a file.
public  StringgetCharset()
    
final protected  LocalizedMessagesgetMessageCollector()
     Returns the collector for violation messages.
final protected  MessageDispatchergetMessageDispatcher()
     A message dispatcher is used to fire violation messages to interested audit listeners.
final protected  voidlog(int aLine, String aKey, Object aArgs)
     Adds a violation message to the AbstractFileSetCheck.getMessageCollector message collector .
final protected  voidlog(int aLineNo, int aColNo, String aKey, Object[] aArgs)
     Adds a violation message to the AbstractFileSetCheck.getMessageCollector message collector .
public  voidsetCharset(String aCharset)
     Sets a named charset.
final public  voidsetFileExtensions(String[] aExtensions)
     Sets the file extensions that identify the files that pass the filter of this FileSetCheck.
Parameters:
  aExtensions - the set of file extensions.
final public  voidsetMessageDispatcher(MessageDispatcher aDispatcher)
    



Method Detail
destroy
public void destroy()(Code)

See Also:   com.puppycrawl.tools.checkstyle.api.FileSetCheck
See Also:   



filter
final protected File[] filter(File[] aFiles)(Code)
Determines the set of files this FileSetCheck is interested in. Returns the files that have one of the currently active file extensions. If no file extensions are active the argument array is returned.

This method can be used in the implementation of process() to filter it's argument list for interesting files.


Parameters:
  aFiles - the candidates for processing the subset of aFiles that this FileSetCheck should process
See Also:   FileSetCheck.process



fireErrors
final protected void fireErrors(String aFileName)(Code)
Notify all listeners about the errors in a file. Calls MessageDispatcher.fireErrors() with all logged errors and than clears errors' list.
Parameters:
  aFileName - the audited file



getCharset
public String getCharset()(Code)
the name of the charset



getMessageCollector
final protected LocalizedMessages getMessageCollector()(Code)
Returns the collector for violation messages. Subclasses can use the collector to find out the violation messages to fire via the message dispatcher. the collector for localized messages.



getMessageDispatcher
final protected MessageDispatcher getMessageDispatcher()(Code)
A message dispatcher is used to fire violation messages to interested audit listeners. the current MessageDispatcher.



log
final protected void log(int aLine, String aKey, Object aArgs)(Code)
Adds a violation message to the AbstractFileSetCheck.getMessageCollector message collector .



log
final protected void log(int aLineNo, int aColNo, String aKey, Object[] aArgs)(Code)
Adds a violation message to the AbstractFileSetCheck.getMessageCollector message collector .



setCharset
public void setCharset(String aCharset) throws UnsupportedEncodingException(Code)
Sets a named charset.
Parameters:
  aCharset - the name of a charset
throws:
  UnsupportedEncodingException - if aCharset is unsupported.



setFileExtensions
final public void setFileExtensions(String[] aExtensions)(Code)
Sets the file extensions that identify the files that pass the filter of this FileSetCheck.
Parameters:
  aExtensions - the set of file extensions. A missinginitial '.' character of an extension is automatically added.



setMessageDispatcher
final public void setMessageDispatcher(MessageDispatcher aDispatcher)(Code)



Methods inherited from com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
final public String getId()(Code)(Java Doc)
protected String getMessageBundle()(Code)(Java Doc)
String getMessageBundle(String aClassName)(Code)(Java Doc)
final public String getSeverity()(Code)(Java Doc)
final public SeverityLevel getSeverityLevel()(Code)(Java Doc)
final protected void log(int aLine, String aKey)(Code)(Java Doc)
final protected void log(int aLineNo, String aKey, Object aArg0)(Code)(Java Doc)
final protected void log(int aLineNo, String aKey, Object aArg0, Object aArg1)(Code)(Java Doc)
final protected void log(int aLineNo, int aColNo, String aKey)(Code)(Java Doc)
final protected void log(DetailAST aAST, String aKey)(Code)(Java Doc)
final protected void log(int aLineNo, int aColNo, String aKey, Object aArg0)(Code)(Java Doc)
final protected void log(DetailAST aAST, String aKey, Object aArg0)(Code)(Java Doc)
final protected void log(int aLineNo, int aColNo, String aKey, Object aArg0, Object aArg1)(Code)(Java Doc)
final protected void log(DetailAST aAST, String aKey, Object aArg0, Object aArg1)(Code)(Java Doc)
abstract protected void log(int aLine, String aKey, Object aArgs)(Code)(Java Doc)
abstract protected void log(int aLine, int aCol, String aKey, Object[] aArgs)(Code)(Java Doc)
final public void setId(String aId)(Code)(Java Doc)
final public void setSeverity(String aSeverity)(Code)(Java Doc)

Methods inherited from com.puppycrawl.tools.checkstyle.api.AutomaticBean
final public void configure(Configuration aConfiguration) throws CheckstyleException(Code)(Java Doc)
final public void contextualize(Context aContext) throws CheckstyleException(Code)(Java Doc)
protected void finishLocalSetup() throws CheckstyleException(Code)(Java Doc)
final protected Configuration getConfiguration()(Code)(Java Doc)
protected void setupChild(Configuration aChildConf) throws CheckstyleException(Code)(Java Doc)

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.