org.tmatesoft.svn.core.javahl17

Class JavaHLEventHandler

java.lang.Object

org.tmatesoft.svn.core.javahl17.JavaHLEventHandler

All Implemented Interfaces:

ISVNCanceller, ISVNEventHandler

public class JavaHLEventHandler
extends Object
implements ISVNEventHandler

Field Summary

Fields inherited from interface org.tmatesoft.svn.core.wc.ISVNEventHandler

UNKNOWN

Fields inherited from interface org.tmatesoft.svn.core.ISVNCanceller

NULL

Constructor Summary

Constructors

Constructor and Description
JavaHLEventHandler()

Method Summary

Modifier and Type	Method and Description
void	cancelOperation()
void	checkCancelled() Checks if the current operation is cancelled (somehow interrupted) and should throw an SVNCancelException or notify the handler if exists.
void	handleEvent(SVNEvent event, double progress) Handles the current event.
void	resetPathPrefix()
void	setCancelOperation(boolean cancelOperation)
void	setNotifyCallback(ClientNotifyCallback notifyCallback)
void	setPathPrefix(String pathPrefix)

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaHLEventHandler

public JavaHLEventHandler()

Method Detail

setNotifyCallback

public void setNotifyCallback(ClientNotifyCallback notifyCallback)

setCancelOperation

public void setCancelOperation(boolean cancelOperation)

cancelOperation

public void cancelOperation()

setPathPrefix

public void setPathPrefix(String pathPrefix)

resetPathPrefix

public void resetPathPrefix()

handleEvent

public void handleEvent(SVNEvent event,
                        double progress)

Description copied from interface: ISVNEventHandler

Handles the current event.

Generally all operations represented by do*() methods of SVN*Client objects are followed by generating a sequence of events that are passed to the registered ISVNEventHandler object for custom processing. For example, during an update operation each local item being modified is signaled about by dispatching a specific for this item SVNEvent object to this method where this event can be scrutinized and handled in a desired way.

Specified by:

handleEvent in interface ISVNEventHandler

Parameters:

event - the current event that keeps detailed information on the type of action occured and other attributes like path, status, etc.

progress - currently reserved for future use; now it's value is always set to ISVNEventHandler.UNKNOWN

checkCancelled

public void checkCancelled()
                    throws SVNCancelException

Description copied from interface: ISVNCanceller

Checks if the current operation is cancelled (somehow interrupted) and should throw an SVNCancelException or notify the handler if exists.

This method is often called during iterations when processing trees of versioned items. This way the entire operation may be interrupted without waiting till the iteration run out.

Specified by:

checkCancelled in interface ISVNCanceller

Throws:

SVNCancelException