Java Doc for BlockFileHandler.java in  » IDE-Netbeans » nbi » org » netbeans » installer » infra » utils » comment » handlers » 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 » IDE Netbeans » nbi » org.netbeans.installer.infra.utils.comment.handlers 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.netbeans.installer.infra.utils.comment.handlers.BlockFileHandler

All known Subclasses:   org.netbeans.installer.infra.utils.comment.handlers.SourcesFileHandler,  org.netbeans.installer.infra.utils.comment.handlers.HtmlFileHandler,  org.netbeans.installer.infra.utils.comment.handlers.JspFileHandler,  org.netbeans.installer.infra.utils.comment.handlers.XmlFileHandler,
BlockFileHandler
abstract public class BlockFileHandler implements FileHandler(Code)
The base class for ahndling file types in which block comments are used, such as java source files or xml documents.
author:
   Kirill Sorokin


Field Summary
final protected  StringcommentEnd
     The comment closing string.
final protected  PatterncommentPattern
     The regular expression pattern which matches the initial comment.
final protected  StringcommentPrefix
     The prefix which should be used for each line in the comment.
final protected  StringcommentStart
     The comment opening string.
protected  Stringcontents
     The cached file contents.

Constructor Summary
protected  BlockFileHandler(Pattern commentPattern, String commentStart, String commentPrefix, String commentEnd)
     The constructor which should be called by the extending classes.

Method Summary
protected  intgetCommentPosition()
     Calculates the proper initial comment position.
final public  StringgetCorrectComment(String text, int lineLength)
    
final public  StringgetCurrentComment()
    
final public  voidinsertComment(String text, int lineLength)
    
final public  voidload(File file)
    
final public  voidsave(File file)
    
final public  voidupdateComment(String text, int lineLength)
    

Field Detail
commentEnd
final protected String commentEnd(Code)
The comment closing string.



commentPattern
final protected Pattern commentPattern(Code)
The regular expression pattern which matches the initial comment.



commentPrefix
final protected String commentPrefix(Code)
The prefix which should be used for each line in the comment. If there should be no prefix - an empty line should be used.



commentStart
final protected String commentStart(Code)
The comment opening string.



contents
protected String contents(Code)
The cached file contents.




Constructor Detail
BlockFileHandler
protected BlockFileHandler(Pattern commentPattern, String commentStart, String commentPrefix, String commentEnd)(Code)
The constructor which should be called by the extending classes. It merely sets the class fields, performnig some basic validation.
Parameters:
  commentPattern - The regular expression pattern which matches theinitial comment.
Parameters:
  commentStart - The comment opening string.
Parameters:
  commentPrefix - The prefix which should be used for each line in thecomment.
Parameters:
  commentEnd - The comment closing string.
throws:
  java.lang.IllegalArgumentException - if the parameters validationfails.




Method Detail
getCommentPosition
protected int getCommentPosition()(Code)
Calculates the proper initial comment position. This is used in the insertComment method to devise the position at which to insert the new comment. Extending classes may want to override this method to provide initial comment position that is correct for their file type (e.g. in xml documents the comment should appear only after the <?xml ... ?> tag. The proper position for the initial comment.



getCorrectComment
final public String getCorrectComment(String text, int lineLength)(Code)



getCurrentComment
final public String getCurrentComment()(Code)



insertComment
final public void insertComment(String text, int lineLength)(Code)



load
final public void load(File file) throws IOException(Code)



save
final public void save(File file) throws IOException(Code)



updateComment
final public void updateComment(String text, int lineLength)(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.