org.netbeans.modules.refactoring.api

Class ProgressEvent

java.lang.Object

java.util.EventObject

org.netbeans.modules.refactoring.api.ProgressEvent

All Implemented Interfaces:

Serializable

public final class ProgressEvent
extends EventObject

Progress event object.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	START Start event id
static int	STEP Step event id
static int	STOP Stop event id

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ProgressEvent(Object source, int eventId) Creates ProgressEvent instance.
ProgressEvent(Object source, int eventId, int operationType, int count) Creates ProgressEvent instance.

Method Summary

Modifier and Type	Method and Description
int	getCount() Returns step count.
int	getEventId() Returns ID of the event.
int	getOperationType() Returns operation type.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

START

public static final int START

Start event id

See Also:

Constant Field Values

STEP

public static final int STEP

Step event id

See Also:

Constant Field Values

STOP

public static final int STOP

Stop event id

See Also:

Constant Field Values

Constructor Detail

ProgressEvent

public ProgressEvent(@NonNull
                     Object source,
                     int eventId)

Creates ProgressEvent instance.

Parameters:

source - Source of the event.

eventId - ID of the event.

ProgressEvent

public ProgressEvent(@NonNull
                     Object source,
                     int eventId,
                     int operationType,
                     int count)

Creates ProgressEvent instance.

Parameters:

source - Source of the event.

eventId - ID of the event.

operationType - Source-specific number identifying source operation that is being processed.

count - Number of steps that the processed opration consists of.

Method Detail

getEventId

public int getEventId()

Returns ID of the event.

Returns:

ID of the event.

getOperationType

public int getOperationType()

Returns operation type.

Returns:

Source-specific number identifying operation being processed. Needs to be valid for START events, can be 0 for STEP and STOP events.

getCount

public int getCount()

Returns step count.

Returns:

Number of step that the operation being processed consists of. Needs to be valid for START events, can be 0 for STEP and STOP events. If it is not 0 for STEP events, it is a new progress.