net.java.sip.communicator.service.history.event
Class ProgressEvent

java.lang.Object
  java.util.EventObject
      net.java.sip.communicator.service.history.event.ProgressEvent

All Implemented Interfaces:

Serializable

public class ProgressEvent
extends EventObject

A "ProgressEvent" event gets delivered through the search process of HistoryReader Service. The event is created with arguments - the search conditions (if they do not exist null is passed). We must know the search conditions due the fact that we must differ searches if more than one exist. The real information is the progress of the current search.

Author:

Damian Minkov

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

ProgressEvent(Object source, Date startDate, Date endDate)
Constructs a new ProgressEvent.

ProgressEvent(Object source, Date startDate, Date endDate, String[] keywords)
Constructs a new ProgressEvent.

ProgressEvent(Object source, Date startDate, Date endDate, String[] keywords, int progress)
Constructs a new ProgressEvent.

Method Summary

Date	getEndDate() The end date in the search condition.
String[]	getKeywords() The keywords in the search condition.
int	getProgress() Gets the current progress that will be fired.
Date	getStartDate() The start date in the search condition.
void	setProgress(int progress) Sets the progress that will be fired

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

Constructor Detail

ProgressEvent

public ProgressEvent(Object source,
                     Date startDate,
                     Date endDate,
                     String[] keywords,
                     int progress)

Constructs a new ProgressEvent.

Parameters:

source - Object The source firing this event

startDate - Date The start date in the search condition.

endDate - Date The end date in the search condition.

keywords - String[] The keywords in the search condition.

progress - int The current progress that we will pass.

ProgressEvent

public ProgressEvent(Object source,
                     Date startDate,
                     Date endDate,
                     String[] keywords)

Constructs a new ProgressEvent.

Parameters:

source - Object The source firing this event

startDate - Date The start date in the search condition.

endDate - Date The end date in the search condition.

keywords - String[] The keywords in the search condition.

ProgressEvent

public ProgressEvent(Object source,
                     Date startDate,
                     Date endDate)

Constructs a new ProgressEvent.

Parameters:

source - Object The source firing this event

startDate - Date The start date in the search condition.

endDate - Date The end date in the search condition.

Method Detail

getProgress

public int getProgress()

Gets the current progress that will be fired.

Returns:

int the progress value

getEndDate

public Date getEndDate()

The end date in the search condition.

Returns:

Date end date value

getKeywords

public String[] getKeywords()

The keywords in the search condition.

Returns:

String[] array of keywords fo searching

getStartDate

public Date getStartDate()

The start date in the search condition.

Returns:

Date start date value

setProgress

public void setProgress(int progress)

Sets the progress that will be fired

Parameters:

progress - int progress value