| 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 Pattern | addPattern(String expression)
Adds a pattern to the cache and returns the compiled pattern. | | public Pattern | addPattern(String expression, int options)
Adds a pattern to the cache and returns the compiled pattern. | | public int | capacity()
Returns the maximum number of patterns that can be cached at one time. | | public Pattern | getPattern(String expression)
This method fetches a pattern from the cache. | | public Pattern | getPattern(String expression, int options)
This method fetches a pattern from the cache. | | public int | size()
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. |
| 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). |
|
|