Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.renderer.util
Class WikiSyntaxEscapeTask

java.lang.Object
  extended by com.jivesoftware.util.AbstractPollableRunnable
      extended by com.jivesoftware.forum.renderer.util.WikiSyntaxEscapeTask
All Implemented Interfaces:
PollableRunnable, java.io.Serializable, java.lang.Runnable

public class WikiSyntaxEscapeTask
extends AbstractPollableRunnable
implements java.io.Serializable

Cleans up any messages in the system that have been imported and not modified since the last import.

This task is cancellable and will resume from the last message ID modified

See Also:
Serialized Form

Constructor Summary
WikiSyntaxEscapeTask()
           
 
Method Summary
 void cancel()
          Not implemented in this implementation.
 void doRun()
          Executes the logic of the task.
 int getTaskMaximum()
          Returns the maximum value of task progress (default is 100).
 int getTaskValue()
          Returns the current value of the task's progress.
 long getTimestamp()
           
 boolean isCancel()
           
 boolean isIndeterminate()
          Returns true if we are unable to determine the progress being made, false othewise.
 void setTimestamp(long timestamp)
           
 
Methods inherited from class com.jivesoftware.util.AbstractPollableRunnable
getEndDate, getPercentComplete, getStartDate, getTaskMinimum, isFinished, isRunning, run
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WikiSyntaxEscapeTask

public WikiSyntaxEscapeTask()
Method Detail

getTimestamp

public long getTimestamp()

setTimestamp

public void setTimestamp(long timestamp)

isIndeterminate

public boolean isIndeterminate()
Description copied from interface: PollableRunnable
Returns true if we are unable to determine the progress being made, false othewise. This is useful to use when progress can't be determined but some indication of activity needs to be displayed.

Specified by:
isIndeterminate in interface PollableRunnable
Overrides:
isIndeterminate in class AbstractPollableRunnable
Returns:
true if we are unable to determine the progress being made, false othewise.

getTaskMaximum

public int getTaskMaximum()
Description copied from interface: PollableRunnable
Returns the maximum value of task progress (default is 100). If this is in indeterminate mode then this will return -1.

Specified by:
getTaskMaximum in interface PollableRunnable
Overrides:
getTaskMaximum in class AbstractPollableRunnable
Returns:
the maximum value of task progress.

getTaskValue

public int getTaskValue()
Description copied from interface: PollableRunnable
Returns the current value of the task's progress. This will be x where min <= x <= max. If this is in indeterminate mode then this will return -1.

Specified by:
getTaskValue in interface PollableRunnable
Specified by:
getTaskValue in class AbstractPollableRunnable
Returns:
the current value of the task's progress.

isCancel

public boolean isCancel()

cancel

public void cancel()
Description copied from class: AbstractPollableRunnable
Not implemented in this implementation.

Specified by:
cancel in interface PollableRunnable
Overrides:
cancel in class AbstractPollableRunnable

doRun

public void doRun()
Description copied from class: AbstractPollableRunnable
Executes the logic of the task. Errors should be handled by the implementing class as this method does not throw any exceptions.

Specified by:
doRun in class AbstractPollableRunnable

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.