|
ColdBox Platform v3.8.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.cache.util.ElementCleaner
public class ElementCleaner
A ColdBox utility to help clean cached objects for ColdBox Application Caches
Constructor Summary | |
---|---|
init(any<ICacheProvider> cacheProvider)
Constructor |
Method Summary | |
---|---|
void |
clearAllEvents()
Clears all events from the cache |
void |
clearAllViews()
Clears all views from the cache |
void |
clearByKeySnippet(any keySnippet, [any regex='false'])
Clears keys using the passed in object key snippet |
void |
clearEvent(any eventsnippet, [any queryString=''])
Clears all the event permutations from the cache according to snippet and querystring |
void |
clearEventMulti(any eventsnippets, [any queryString=''])
Clears all the event permutations from the cache according to the list of snippets and querystrings |
void |
clearView(any viewSnippet)
Clears all view name permutations from the cache according to the view name |
void |
clearViewMulti(any viewSnippets)
Clears all view name permutations from the cache according to the view name |
any<ICacheProvider> |
getAssociatedCache()
Get the associated cache provider/manager of type: coldbox |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init(any<ICacheProvider> cacheProvider)
cacheProvider
- The associated cache manager/provider of type: coldbox.system.cache.ICacheProviderMethod Detail |
---|
public void clearAllEvents()
public void clearAllViews()
public void clearByKeySnippet(any keySnippet, [any regex='false'])
keySnippet
- the cache key snippet to useregex
- Use regex or notpublic void clearEvent(any eventsnippet, [any queryString=''])
eventsnippet
- The event snippet to clear on. Can be partial or fullqueryString
- If passed in, it will create a unique hash out of it. For purging purposespublic void clearEventMulti(any eventsnippets, [any queryString=''])
eventsnippets
- The comma-delimmitted list event snippet to clear on. Can be partial or fullqueryString
- The comma-delimmitted list of queryStrings passed in. If passed in, it will create a unique hash out of it. For purging purposes. If passed in the list length must be equal to the list length of the event snippets passed in.public void clearView(any viewSnippet)
viewSnippet
- The view name snippet to purge from the cachepublic void clearViewMulti(any viewSnippets)
viewSnippets
- The comma-delimmitted list or array of view snippet to clear on. Can be partial or fullpublic any<ICacheProvider> getAssociatedCache()
|
ColdBox Platform v3.8.0 | ||||
FRAMES |