|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectProgressMailer
public class ProgressMailer
Reports progress by sending email to the specified address at regular interval.
Constructor Summary | |
---|---|
ProgressMailer(Session session,
Address[] address)
Creates an objects reporting progress to the specified email adresses. |
|
ProgressMailer(String host,
String address)
Creates an objects reporting progress to the specified email address. |
Method Summary | |
---|---|
void |
complete()
Send an emails saying that the operation finished. |
void |
dispose()
Releases any resource used by this object. |
void |
exceptionOccurred(Throwable exception)
Send an exception stack trace by email. |
String |
getDescription()
Deprecated. Replaced by getTask() . |
float |
getProgress()
|
InternationalString |
getTask()
|
long |
getTimeInterval()
Returns the time laps (in milliseconds) between two emails. |
boolean |
isCanceled()
|
void |
progress(float percent)
Notifies progress. |
void |
setCanceled(boolean canceled)
|
void |
setDescription(String description)
Deprecated. Replaced by setTask(org.opengis.util.InternationalString) . |
void |
setTask(InternationalString task)
|
void |
setTimeInterval(long interval)
Set the time laps (in milliseconds) between two emails. |
void |
started()
Send an emails saying that the operation started. |
void |
warningOccurred(String source,
String margin,
String warning)
Send a warning by email. |
Methods inherited from class Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ProgressMailer(String host, String address) throws AddressException
host
- The server to use for sending emails.address
- Email adress where to send progress reports.
AddressException
- if the specified address use an invalid syntax.public ProgressMailer(Session session, Address[] address)
session
- Session to use for sending emails.address
- Method Detail |
---|
public long getTimeInterval()
public void setTimeInterval(long interval)
public String getDescription()
getTask()
.
getDescription
in interface ProgressListener
public void setDescription(String description)
setTask(org.opengis.util.InternationalString)
.
setDescription
in interface ProgressListener
public void setTask(InternationalString task)
setTask
in interface ProgressListener
public InternationalString getTask()
getTask
in interface ProgressListener
public void started()
started
in interface ProgressListener
public void progress(float percent)
setTimeInterval(long)
is ellapsed since the last email.
progress
in interface ProgressListener
public float getProgress()
getProgress
in interface ProgressListener
public void complete()
complete
in interface ProgressListener
public void dispose()
dispose
in interface ProgressListener
public boolean isCanceled()
isCanceled
in interface ProgressListener
public void setCanceled(boolean canceled)
setCanceled
in interface ProgressListener
public void warningOccurred(String source, String margin, String warning)
warningOccurred
in interface ProgressListener
public void exceptionOccurred(Throwable exception)
exceptionOccurred
in interface ProgressListener
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |