com.tplan.robot.util

Class FileSearchRunnable

java.lang.Object

com.tplan.robot.util.FileSearchRunnable

All Implemented Interfaces:

DescriptionProvider, FileSearchListener, GenericListener<FileSearchListener>, Measurable, Stoppable, VetoableChangeListener, Runnable, Comparator<int[]>, EventListener

public class FileSearchRunnable
extends Object
implements Runnable, VetoableChangeListener, GenericListener<FileSearchListener>, Measurable, DescriptionProvider, Stoppable, Comparator<int[]>, FileSearchListener

Runnable performing search for a string in one or more files and/or file paths.

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

Constructor Summary

Constructors

Constructor and Description
FileSearchRunnable(File[] files, String pattern, boolean ignoreCase)

Method Summary

Modifier and Type	Method and Description
void	addPostTask(Runnable r, String name, float progressAmount)
void	addSearchListener(FileSearchListener listener)
int	compare(int[] o1, int[] o2)
boolean	equals(File[] files, String pattern, boolean ignoreCase)
void	fileSearchStarting(Object source, File file)
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".
String	getProgressDescription() Get description.
boolean	isStopped() Find out whether the task has been already stopped.
void	matchFound(Object source, File file, String line, int lineNumber, int column, String searchedString)
void	matchReplaced(Object source, File file, String line, int lineNumber, int column, String searchedString)
void	processFinished(Object source)
void	processStarting(Object source)
void	progressUpdated(Object source, String progressDesc, float progress)
void	removeSearchListener(FileSearchListener listener)
void	run()
void	searchFinished(Object source)
void	stop() Call this method to request the implementing object to stop the current task or activity.
void	taskFinished(Object source, Runnable r, String name)
void	taskStarting(Object source, Runnable r, String name)
void	vetoableChange(PropertyChangeEvent evt)

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

FileSearchRunnable

public FileSearchRunnable(File[] files,
                          String pattern,
                          boolean ignoreCase)

Method Detail

addPostTask

public void addPostTask(Runnable r,
                        String name,
                        float progressAmount)

equals

public boolean equals(File[] files,
                      String pattern,
                      boolean ignoreCase)

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

vetoableChange

public void vetoableChange(PropertyChangeEvent evt)
                    throws PropertyVetoException

Specified by:

vetoableChange in interface VetoableChangeListener

Throws:

PropertyVetoException

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.

getProgressDescription

public String getProgressDescription()

Description copied from interface: DescriptionProvider

Get description. As consumers of the description are expected to call this method multiple times over a time period, the description may change depending on the internal state of the implementing object, for example to describe the progress or the currently performed task.

Specified by:

getProgressDescription in interface DescriptionProvider

Returns:

description.

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.

compare

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

Specified by:

compare in interface Comparator<int[]>

processStarting

public void processStarting(Object source)

Specified by:

processStarting in interface FileSearchListener

fileSearchStarting

public void fileSearchStarting(Object source,
                               File file)

Specified by:

fileSearchStarting in interface FileSearchListener

matchFound

public void matchFound(Object source,
                       File file,
                       String line,
                       int lineNumber,
                       int column,
                       String searchedString)

Specified by:

matchFound in interface FileSearchListener

matchReplaced

public void matchReplaced(Object source,
                          File file,
                          String line,
                          int lineNumber,
                          int column,
                          String searchedString)

Specified by:

matchReplaced in interface FileSearchListener

searchFinished

public void searchFinished(Object source)

Specified by:

searchFinished in interface FileSearchListener

taskStarting

public void taskStarting(Object source,
                         Runnable r,
                         String name)

Specified by:

taskStarting in interface FileSearchListener

taskFinished

public void taskFinished(Object source,
                         Runnable r,
                         String name)

Specified by:

taskFinished in interface FileSearchListener

progressUpdated

public void progressUpdated(Object source,
                            String progressDesc,
                            float progress)

Specified by:

progressUpdated in interface FileSearchListener

processFinished

public void processFinished(Object source)

Specified by:

processFinished in interface FileSearchListener