com.tplan.robot.util

Class ReplaceRunnable

java.lang.Object

com.tplan.robot.util.ReplaceRunnable

All Implemented Interfaces:

FileMapConsumer, GenericListener<FileSearchListener>, Measurable, Stoppable, Runnable, Comparator<int[]>

public class ReplaceRunnable
extends Object
implements Runnable, Comparator<int[]>, GenericListener<FileSearchListener>, Stoppable, Measurable, FileMapConsumer

Runnable performing string replacement in the specified list of files and locations.

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Constructor Summary

Constructors

Constructor and Description
ReplaceRunnable(String pattern, String replacement, boolean caseSensitive)

Method Summary

Modifier and Type	Method and Description
void	addSearchListener(FileSearchListener listener)
int	compare(int[] o1, int[] o2)
void	genericEvent(FileSearchListener listener, EventObject event, Object customObject) Call the listener method on a particular listener.
float	getProgress() Get the task progress where 0 means "0% done" and 1 means "100% done".
boolean	isStopped() Find out whether the task has been already stopped.
void	removeSearchListener(FileSearchListener listener)
void	run()
void	setFileMap(Map<File,List<int[]>> map)
void	stop() Call this method to request the implementing object to stop the current task or activity.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

ReplaceRunnable

public ReplaceRunnable(String pattern,
                       String replacement,
                       boolean caseSensitive)

Method Detail

setFileMap

public void setFileMap(Map<File,List<int[]>> map)

Specified by:

setFileMap in interface FileMapConsumer

genericEvent

public void genericEvent(FileSearchListener listener,
                         EventObject event,
                         Object customObject)

Description copied from interface: GenericListener

Call the listener method on a particular listener. For example, when the listener is a ChangeListener the method should call listener.stateChanged((ChangeEvent)event). This method will be called by the GenericListenerSupport.fireEvent(com.tplan.robot.util.GenericListener, java.util.EventObject, java.lang.Object) method for each registered listener.

Specified by:

genericEvent in interface GenericListener<FileSearchListener>

Parameters:

listener - the registered listener.

event - an event to fire to the listener. The implementing class should check whether it is an appropriate event matching the listener type and throw an IllegalArgumentException if not. For example, if the listener is a ChangeListener the event must be a ChangeEvent.

customObject - an optional object allowing the implementing class to transfer data between individual call of this method. For example, the argument may be a List where the method will store all exceptions thrown by the listener to.

addSearchListener

public void addSearchListener(FileSearchListener listener)

removeSearchListener

public void removeSearchListener(FileSearchListener listener)

run

public void run()

Specified by:

run in interface Runnable

compare

public int compare(int[] o1,
                   int[] o2)

Specified by:

compare in interface Comparator<int[]>

stop

public void stop()

Description copied from interface: Stoppable

Call this method to request the implementing object to stop the current task or activity.

Specified by:

stop in interface Stoppable

isStopped

public boolean isStopped()

Description copied from interface: Stoppable

Find out whether the task has been already stopped.

Specified by:

isStopped in interface Stoppable

Returns:

true if the task has been stopped, false otherwise. If the task hasn't been started yet, the method should return false.

getProgress

public float getProgress()

Description copied from interface: Measurable

Get the task progress where 0 means "0% done" and 1 means "100% done".

Specified by:

getProgress in interface Measurable

Returns:

a relative number between 0 and 1 indicating how much has been completed.