com.helger.commons.regex

Class RegExPool

java.lang.Object

com.helger.commons.cache.AbstractCache<KEYTYPE,VALUETYPE>

com.helger.commons.cache.AbstractNotifyingCache<KEYTYPE,VALUETYPE>

com.helger.commons.cache.AbstractNotifyingCacheWithMaxSize<RegExPattern,Pattern>

com.helger.commons.regex.RegExPool

All Implemented Interfaces:

ISimpleCache<RegExPattern,Pattern>, SimpleCacheMBean, IHasSize, IHasName

public final class RegExPool
extends AbstractNotifyingCacheWithMaxSize<RegExPattern,Pattern>

This class provides a pool for cached regular expressions. It caches up to a limited number of compiled Pattern objects.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_CACHE_SIZE The default number of items to keep in the cache

Fields inherited from class com.helger.commons.cache.AbstractCache

DEFAULT_JMX_ENABLED, m_aCacheAccessStats, m_aRWLock, STATISTICS_PREFIX

Method Summary

Methods

Modifier and Type	Method and Description
static EChange	clearPatternCache() Clear all cached patterns.
static Pattern	getPattern(String sRegEx) Get the cached regular expression pattern.
static Pattern	getPattern(String sRegEx, int nOptions) Get the cached regular expression pattern.
protected Pattern	getValueToCache(RegExPattern aRegEx) This abstract method is invoked, once a new value needs to be put into the cache.

Methods inherited from class com.helger.commons.cache.AbstractNotifyingCacheWithMaxSize

createCache, getMaxSize, toString

Methods inherited from class com.helger.commons.cache.AbstractNotifyingCache

getFromCache

Methods inherited from class com.helger.commons.cache.AbstractCache

clearCache, getFromCacheNoStats, getFromCacheNoStatsNotLocked, getFromCacheNotLocked, getName, isEmpty, isJMXEnabled, isNotEmpty, putInCache, putInCacheNotLocked, removeFromCache, setJMXEnabled, size

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MAX_CACHE_SIZE

public static final int MAX_CACHE_SIZE

The default number of items to keep in the cache

See Also:

Constant Field Values

Method Detail

getValueToCache

@Nullable
@IsLocked(value=WRITE)
protected Pattern getValueToCache(@Nullable@RegEx
                                                  RegExPattern aRegEx)

Description copied from class: AbstractNotifyingCache

This abstract method is invoked, once a new value needs to be put into the cache. This method is invoked within a locked section.

Specified by:

getValueToCache in class AbstractNotifyingCache<RegExPattern,Pattern>

Parameters:

aRegEx - The key for which the value to cache is required. May be nullable or not - depends upon the implementation.

Returns:

The value to be cached. May not be null.

getPattern

@Nonnull
public static Pattern getPattern(@Nonnull@Nonempty@RegEx
                         String sRegEx)

Get the cached regular expression pattern.

Parameters:

sRegEx - The regular expression to retrieve. May neither be null nor empty.

Returns:

The compiled regular expression pattern and never null .

Throws:

IllegalArgumentException - If the passed regular expression has an illegal syntax

getPattern

@Nonnull
public static Pattern getPattern(@Nonnull@Nonempty@RegEx
                         String sRegEx,
                         @Nonnegative
                         int nOptions)

Get the cached regular expression pattern.

Parameters:

sRegEx - The regular expression to retrieve. May neither be null nor empty.

nOptions - The options used for Pattern.compile

Returns:

The compiled regular expression pattern and never null .

Throws:

IllegalArgumentException - If the passed regular expression has an illegal syntax

See Also:

Pattern.compile(String, int)

clearPatternCache

@Nonnull
public static EChange clearPatternCache()

Clear all cached patterns.

Returns:

EChange