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


com.puppycrawl.tools.checkstyle.api.Check
   com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck

LineLengthCheck
public class LineLengthCheck extends Check (Code)
Checks for long lines.

Rationale: Long lines are hard to read in printouts or if developers have limited screen space for the source code, e.g. if the IDE displays additional information like project tree, class hierarchy, etc.

Note: Support for the special handling of imports in CheckStyle Version 2 has been dropped as it is a special case of regexp: The user can set the ignorePattern to "^import" and achieve the same effect.

The default maximum allowable line length is 80 characters. To change the maximum, set property max.

To ignore lines in the check, set property ignorePattern to a regular expression for the lines to ignore.

An example of how to configure the check is:

 <module name="LineLength"/>
 

An example of how to configure the check to accept lines up to 120 characters long is:

 <module name="LineLength">
 <property name="max" value="120"/>
 </module>
 

An example of how to configure the check to ignore lines that begin with " * ", followed by just one word, such as within a Javadoc comment, is:

 <module name="LineLength">
 <property name="ignorePattern" value="^ *\* *[^ ]+$"/>
 </module>
 

author:
   Lars Kühne



Constructor Summary
public  LineLengthCheck()
     Creates a new LineLengthCheck instance.

Method Summary
public  voidbeginTree(DetailAST aRootAST)
    
public  int[]getDefaultTokens()
    
public  voidsetIgnorePattern(String aFormat)
     Set the ignore pattern.
public  voidsetMax(int aLength)
    


Constructor Detail
LineLengthCheck
public LineLengthCheck()(Code)
Creates a new LineLengthCheck instance.




Method Detail
beginTree
public void beginTree(DetailAST aRootAST)(Code)



getDefaultTokens
public int[] getDefaultTokens()(Code)



setIgnorePattern
public void setIgnorePattern(String aFormat) throws ConversionException(Code)
Set the ignore pattern.
Parameters:
  aFormat - a String value
throws:
  ConversionException - unable to parse aFormat



setMax
public void setMax(int aLength)(Code)

Parameters:
  aLength - the maximum length of a line



Methods inherited from com.puppycrawl.tools.checkstyle.api.Check
public void beginTree(DetailAST aRootAST)(Code)(Java Doc)
public void destroy()(Code)(Java Doc)
public void finishTree(DetailAST aRootAST)(Code)(Java Doc)
public int[] getAcceptableTokens()(Code)(Java Doc)
final public ClassLoader getClassLoader()(Code)(Java Doc)
abstract public int[] getDefaultTokens()(Code)(Java Doc)
final public FileContents getFileContents()(Code)(Java Doc)
final public String[] getLines()(Code)(Java Doc)
public int[] getRequiredTokens()(Code)(Java Doc)
final protected int getTabWidth()(Code)(Java Doc)
final public Set getTokenNames()(Code)(Java Doc)
public void init()(Code)(Java Doc)
public void leaveToken(DetailAST aAST)(Code)(Java Doc)
final protected void log(int aLine, String aKey, Object aArgs)(Code)(Java Doc)
final protected void log(int aLineNo, int aColNo, String aKey, Object[] aArgs)(Code)(Java Doc)
final public void setClassLoader(ClassLoader aLoader)(Code)(Java Doc)
final public void setFileContents(FileContents aContents)(Code)(Java Doc)
final public void setMessages(LocalizedMessages aMessages)(Code)(Java Doc)
final public void setTabWidth(int aTabWidth)(Code)(Java Doc)
final public void setTokens(String[] aStrRep)(Code)(Java Doc)
public void visitToken(DetailAST aAST)(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.