Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.opensymphony.oscache.base.events
Class CachePatternEvent

    java.lang.Object
      com.opensymphony.oscache.base.events.CacheEvent
          com.opensymphony.oscache.base.events.CachePatternEvent

public final class CachePatternEvent
extends CacheEvent

A CachePatternEvent is fired when a pattern has been applied to a cache.

Version:
  $Revision: 1.1 $
Author:
  Chris Miller

Field Summary

Fields inherited from class com.opensymphony.oscache.base.events.CacheEvent
`origin`

Constructor Summary
`CachePatternEvent(Cache map, java.lang.String pattern)` Constructs a cache pattern event with no origin
`CachePatternEvent(Cache map, java.lang.String pattern, java.lang.String origin)` Constructs a cache pattern event

Method Summary
`Cache` | `getMap()` Retrieve the cache map that had the pattern applied.
`java.lang.String` | `getPattern()` Retrieve the pattern that was applied to the cache.
`java.lang.String` | `toString()`

Methods inherited from class com.opensymphony.oscache.base.events.CacheEvent
`getOrigin`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### CachePatternEvent

    public CachePatternEvent(Cache map,
                             java.lang.String pattern)

  Constructs a cache pattern event with no origin

Parameters:
  `map` - The cache map that the pattern was applied to
  `pattern` - The pattern that was applied

### CachePatternEvent

    public CachePatternEvent(Cache map,
                             java.lang.String pattern,
                             java.lang.String origin)

  Constructs a cache pattern event

Parameters:
  `map` - The cache map that the pattern was applied to
  `pattern` - The cache pattern that the event applies to.
  `origin` - An optional tag that can be attached to the event to specify the event's origin. This is useful to prevent events from being fired recursively in some situations, such as when an event handler causes another event to be fired, or for logging purposes.

Method Detail

### getMap

    public Cache getMap()

  Retrieve the cache map that had the pattern applied.

### getPattern

    public java.lang.String getPattern()

  Retrieve the pattern that was applied to the cache.

### toString

    public java.lang.String toString()

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| See www.opensymphony.com for more information.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD