org.xwiki.job.event.status
Class PushLevelProgressEvent

java.lang.Object
  extended by org.xwiki.job.event.status.PushLevelProgressEvent
All Implemented Interfaces:
Event

public class PushLevelProgressEvent
extends Object
implements Event

Indicate to the progress listener that a new step level is starting.

Since:
4.0M1

Constructor Summary
PushLevelProgressEvent()
          Matches any PushLevelProgressEvent.
PushLevelProgressEvent(int steps)
           
 
Method Summary
 int getSteps()
           
 boolean matches(Object arg0)
          Compares two events to see if they match, meaning that a listener that registered to receive notifications like referenceEvent will be notified of any occuring event for which referenceEvent.matches(occuringEvent) will return true.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PushLevelProgressEvent

public PushLevelProgressEvent()
Matches any PushLevelProgressEvent.


PushLevelProgressEvent

public PushLevelProgressEvent(int steps)
Parameters:
steps - the number of sub steps.
Method Detail

matches

public boolean matches(Object arg0)
Description copied from interface: Event
Compares two events to see if they match, meaning that a listener that registered to receive notifications like referenceEvent will be notified of any occuring event for which referenceEvent.matches(occuringEvent) will return true. The matching algorithm depends on the event implementation. For example for Document events two events match if they implement the same event class and if their EventFilter match. Note that the implementation is left open in order to cater for all the possible ways this Observation component can be used.

Specified by:
matches in interface Event
Parameters:
arg0 - the occuring event matched against the current object
Returns:
true if the passed event matches this event, false otherwise.

getSteps

public int getSteps()
Returns:
the number of sub steps