Module org.apache.sis.storage
Package org.apache.sis.storage.event

Class StoreEvent

Object
EventObject
StoreEvent
All Implemented Interfaces:
Serializable, Localized
Direct Known Subclasses:
Cascaded­Store­Event, Warning­Event
public abstract class StoreEvent extends EventObject implements Localized
Parent class of events happening in a data store resource. The event may be a warning or a change in the metadata, content or structure of a resource. Those events are created by Resource implementations and sent to all registered listeners.
Since:
1.0
See Also:

  • Constructor Details

    • StoreEvent

      protected StoreEvent(Resource source)
      Constructs an event that occurred in the given resource.
      Parameters:
      source - the resource where the event occurred.
      Throws:
      Illegal­Argument­Exception - if the given source is null.

  • Method Details

    • getSource

      public Resource getSource()
      Returns the resource where the event occurred. It is not necessarily the resource in which listeners have been registered; it may be one of the resource children.
      Overrides:
      get­Source in class Event­Object
      Returns:
      the resource where the event occurred.

    • getLocale

      public Locale getLocale()
      Returns the locale associated to this event, or null if unspecified. That locale may be used for formatting messages related to this event. The event locale is typically inherited from the Data­Store locale.
      Specified by:
      get­Locale in interface Localized
      Returns:
      the locale associated to this event (typically specified by the data store), or null if unknown.
      See Also:

    • isConsumed

      public final boolean isConsumed()
      Indicates whether this event has been consumed by any listener. A consumed event is not propagated further to other listeners.
      Returns:
      true if this event has been consumed, false otherwise.
      Since:
      1.3

    • consume

      public void consume(boolean later)
      Marks this event as consumed. This stops its further propagation to other listeners.
      Parameters:
      later - false for consuming now, or true for consuming after all listeners registered on the source resource but before listeners registered on the parent resource or data store.
      Since:
      1.3