Java Doc for CharPreprocessor.java in  » IDE-Netbeans » lexer » org » netbeans » lib » lexer » 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 » lexer » org.netbeans.lib.lexer 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.netbeans.lib.lexer.CharPreprocessor

All known Subclasses:   org.netbeans.lib.lexer.UnicodeEscapesPreprocessor,
CharPreprocessor
abstract public class CharPreprocessor (Code)
Character preprocessor allows to translate a sequence of characters to a single character so it may be used for example for Unicode sequences translation.
If there are any preprocessed characters for a particular token then a special token instance get created that provides the preprocessed chars.
author:
   Miloslav Metelka
version:
   1.00




Method Summary
public static  CharPreprocessorcreateUnicodeEscapesPreprocessor()
     Create instance of character preprocessor for Unicode escape sequences.
 voidinit(CharPreprocessorOperation operation)
    
final protected  voidinputBackup(int count)
     Backup a given number of input characters.
final protected  intinputRead()
     Read a single character for preprocessing from the underlying input.
abstract protected  booleanisSensitiveChar(char ch)
     Check whether the given character may be part of the sequences preprocessed by this preprocessor.
abstract protected  intmaxLookahead()
     Return maximum number of extra characters (not being part of the recognized sequence) that this preprocessor may look ahead in order to recognize the preprocessed character sequence.
final protected  voidnotifyError(String errorMessage)
     Notify the error that occurred during preprocessing of the current character.
final protected  voidoutputOriginal(int ch)
     Output the character as it was read from the input.
final protected  voidoutputPreprocessed(char ch, int extraInputLength)
     Output preprocessed character.
abstract protected  voidpreprocessChar()
     Preprocess at least one character of the input.
Preprocessor must always preprocess at least one input character per invocation but only a minimum necessary number of characters should be preprocessed by each invocation of this method.

Example:

 public void preprocessChar() {
 switch (ch = inputRead()) {
 case '\\': // possible start of sequence
 switch (ch = inputRead()) {
 case 'u': // start of escape sequence
 ...



Method Detail
createUnicodeEscapesPreprocessor
public static CharPreprocessor createUnicodeEscapesPreprocessor()(Code)
Create instance of character preprocessor for Unicode escape sequences.



init
void init(CharPreprocessorOperation operation)(Code)



inputBackup
final protected void inputBackup(int count)(Code)
Backup a given number of input characters.
Parameters:
  count - >=0 number of chars to backup.



inputRead
final protected int inputRead()(Code)
Read a single character for preprocessing from the underlying input. valid character or LexerInput.EOF if there are no morecharacters available on the input.



isSensitiveChar
abstract protected boolean isSensitiveChar(char ch)(Code)
Check whether the given character may be part of the sequences preprocessed by this preprocessor.
The infrastructure may use this method to test whether it can start relexing starting at a particular position.



maxLookahead
abstract protected int maxLookahead()(Code)
Return maximum number of extra characters (not being part of the recognized sequence) that this preprocessor may look ahead in order to recognize the preprocessed character sequence.
For example for unicode escape sequences the returned number is 1 (see UnicodeEscapesPreprocessor implementation for details).



notifyError
final protected void notifyError(String errorMessage)(Code)
Notify the error that occurred during preprocessing of the current character.
Parameters:
  errorMessage - non-null error description.



outputOriginal
final protected void outputOriginal(int ch)(Code)
Output the character as it was read from the input.
By using this method the infrastructure knows that the character is the same like the original character read by CharPreprocessor.inputRead() .



outputPreprocessed
final protected void outputPreprocessed(char ch, int extraInputLength)(Code)
Output preprocessed character. There is usually more than one input character forming a single preprocessed character.
Parameters:
  ch - preprocessed character.
Parameters:
  extraInputLength - >0 number of extra input characters(besides a single character) that form the preprocessed character.
For example for unicode escape sequence "\u0020" it's 6-1=5.
The number is expected to be greater than zero(otherwise the present implementation would not work correctly).which should be fine for the known implementations (if not please request an API change).



preprocessChar
abstract protected void preprocessChar()(Code)
Preprocess at least one character of the input.
Preprocessor must always preprocess at least one input character per invocation but only a minimum necessary number of characters should be preprocessed by each invocation of this method.

Example:

 public void preprocessChar() {
 switch (ch = inputRead()) {
 case '\\': // possible start of sequence
 switch (ch = inputRead()) {
 case 'u': // start of escape sequence
 ... // read the whole sequence
 outputPreprocessed(prepCh, extraInputLength);
 break;
 default:
 outputOriginal('\\');
 outputOriginal(ch);
 break;
 }
 break;
 default:
 outputOriginal(ch);
 }
 }
 

The processor is only designed to do several-chars-to-one translation.
It is not designed to return more than one character for a single input char.
Also if the character is really preprocessed it must be composed from at least two input characters (see extraInputLength parameter of CharPreprocessor.outputPreprocessed(char,int) .

The preprocessor must be able to process all the characters given to it on input. However it should not preprocess EOF in any way - the EOF is just information that there is an end of the input and any possibly unfinished escape sequence needs to be translated in a reasonable way.
Once all the characters prior EOF were preprocessed the EOF should be returned by CharPreprocessor.outputOriginal(int) .




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.