Java Doc for PatternCache.java in  » Development » Jakarta-ORO » org » apache » oro » text » 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 » Development » Jakarta ORO » org.apache.oro.text 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.oro.text.PatternCache

All known Subclasses:   org.apache.oro.text.GenericPatternCache,
PatternCache
public interface PatternCache (Code)
An interface defining the basic functions of a regular expression cache.

A PatternCache is an object that takes care of compiling, storing, and retrieving regular expressions so that the programmer does not have to explicitly manage these operation himself. The main benefit derived is the ease of use from only having to express regular expressions by their String representations.
version:
   @version@
since:
   1.0
See Also:   MalformedCachePatternException





Method Summary
public  PatternaddPattern(String expression)
     Adds a pattern to the cache and returns the compiled pattern.
public  PatternaddPattern(String expression, int options)
     Adds a pattern to the cache and returns the compiled pattern.
public  intcapacity()
     Returns the maximum number of patterns that can be cached at one time.
public  PatterngetPattern(String expression)
     This method fetches a pattern from the cache.
public  PatterngetPattern(String expression, int options)
     This method fetches a pattern from the cache.
public  intsize()
     Returns the number of elements in the cache, not to be confused with the PatternCache.capacity() which returns the number of elements that can be held in the cache at one time.



Method Detail
addPattern
public Pattern addPattern(String expression) throws MalformedPatternException(Code)
Adds a pattern to the cache and returns the compiled pattern. This method is in principle almost identical to PatternCache.getPattern(String) except for the fact that it throws a MalformedPatternException if an expression cannot be compiled.

addPattern() is meant to be used when you expressly intend to add an expression to a cache and is useful for front-loading a cache with expressions before use. If the expression added does not already exist in the cache, it is compiled, added to the cache, and returned. If the compiled expression is already in the cache, it is simply returned.

The expected behavior of this method should be to start replacing patterns in the cache only after the cache has been filled to capacity.


Parameters:
  expression - The regular expression to add to the cache. The Pattern corresponding to the String representation of theregular expression.
exception:
  MalformedPatternException - If there is an error in compilingthe regular expression.




addPattern
public Pattern addPattern(String expression, int options) throws MalformedPatternException(Code)
Adds a pattern to the cache and returns the compiled pattern. This method is in principle almost identical to PatternCache.getPattern(String) except for the fact that it throws a MalformedPatternException if an expression cannot be compiled.

addPattern() is meant to be used when you expressly intend to add an expression to the cache and is useful for front-loading a cache with expressions before use. If the expression added does not already exist in the cache, it is compiled, added to the cache, and returned. If the compiled expression is already in the cache, it is simply returned.

The expected behavior of this method should be to start replacing patterns in the cache only after the cache has been filled to capacity.


Parameters:
  expression - The regular expression to add to the cache.
Parameters:
  options - The compilation options to use when compiling theexpression. The Pattern corresponding to the String representation of theregular expression.
exception:
  MalformedPatternException - If there is an error in compilingthe regular expression.




capacity
public int capacity()(Code)
Returns the maximum number of patterns that can be cached at one time.

The maximum number of patterns that can be cached at one time.




getPattern
public Pattern getPattern(String expression) throws MalformedCachePatternException(Code)
This method fetches a pattern from the cache. It is nearly identical to PatternCache.addPattern addPattern() except that it doesn't throw a MalformedPatternException. If the pattern is not in the cache, it is compiled, placed in the cache, and returned. If the pattern cannot be compiled successfully, the implementation must throw an exception derived from MalformedCachePatternException. Note that this exception is derived from RuntimeException, which means you are NOT forced to catch it by the compiler. Please refer to MalformedCachePatternException for a discussion of when you should and shouldn't catch this exception.


Parameters:
  expression - The regular expression to fetch from the cache incompiled form. The Pattern corresponding to the String representation of theregular expression.
exception:
  MalformedCachePatternException - If there is an error incompiling the regular expression.




getPattern
public Pattern getPattern(String expression, int options) throws MalformedCachePatternException(Code)
This method fetches a pattern from the cache. It is nearly identical to PatternCache.addPattern addPattern() except that it doesn't throw a MalformedPatternException. If the pattern is not in the cache, it is compiled, placed in the cache, and returned. If the pattern cannot be compiled successfully, it throws a MalformedCachePatternException. Note that this exception is derived from RuntimeException, which means you are NOT forced to catch it by the compiler. Please refer to MalformedCachePatternException for a discussion of when you should and shouldn't catch this exception.


Parameters:
  expression - The regular expression to fetch from the cache incompiled form.
Parameters:
  options - The compilation options to use when compiling theexpression. The Pattern corresponding to the String representation of theregular expression.
exception:
  MalformedCachePatternException - If there is an error incompiling the regular expression.




size
public int size()(Code)
Returns the number of elements in the cache, not to be confused with the PatternCache.capacity() which returns the number of elements that can be held in the cache at one time.

The current size of the cache (i.e., the number of elementscurrently cached).




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