Package org.tmatesoft.svn.core.wc
Class SVNEvent
java.lang.Object
org.tmatesoft.svn.core.wc.SVNEvent
The SVNEvent class is used to provide detailed information on
an operation progress to the ISVNEventHandler (if any) registered
for an SVN*Client object. Such events are generated by
an operation invoked by do*() method of an SVN*Client object
and passed to a developer's event handler for notification. Retrieving
information out of an SVNEvent the developer can decide how it
should be interpreted.
then registering a handler:
now when invoking an update operation:
the registered instance of the ISVNEventHandler implementation will be dispatched progress events.
This is an example:
implementing ISVNEventHandler
import org.tmatesoft.svn.core.wc.ISVNEventHandler; import org.tmatesoft.svn.core.SVNCancelException; import org.tmatesoft.svn.core.wc.SVNEvent; import org.tmatesoft.svn.core.wc.SVNEventAction; import org.tmatesoft.svn.core.wc.SVNStatusType; import org.tmatesoft.svn.core.SVNNodeKind; import java.io.File; ... public class MyCustomUpdateEventHandler implements ISVNEventHandler { public void handleEvent(SVNEvent event, double progress) { //get the action type if(event.getAction() == SVNEventAction.UPDATE_UPDATE){ //get the item's node kind SVNNodeKind kind = even.getNodeKind(); //get the item's contents status if(event.getContentsStatus() == SVNStatusType.CHANGED && kind == SVNNodeKind.FILE){ ... } ... //get the item's properties status if(event.getPropertiesStatus() == SVNStatusType.MERGED){ ... } //get the item's lock status if(event.getLockStatus() == SVNStatusType.LOCK_UNLOCKED){ ... } //get the item's relative path String path = event.getPath(); //or in a java.io.File representation File fsEntry = event.getFile(); //get update revision long revision = event.getRevision(); ... } ... } public void checkCancelled() throws SVNCancelException{ throw new SVNCancelException("cancelled!"); } }
then registering a handler:
import org.tmatesoft.svn.core.wc.SVNUpdateClient; ... SVNUpdateClient updateClient; ... updateClient.setEventHandler(new MyCustomUpdateEventHandler()); ...
now when invoking an update operation:
updateClient.doUpdate(...);
the registered instance of the ISVNEventHandler implementation will be dispatched progress events.
- Since:
- 1.2
- Version:
- 1.3
- Author:
- TMate Software Ltd.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionSVNEvent
(File file, SVNNodeKind kind, String mimetype, long revision, SVNStatusType cstatus, SVNStatusType pstatus, SVNStatusType lstatus, SVNLock lock, SVNEventAction action, SVNEventAction expected, SVNErrorMessage error, SVNMergeRange range, String changelistName, SVNProperties revisionProperties, String propertyName) Constructs an SVNEvent object.SVNEvent
(SVNErrorMessage errorMessage, SVNEventAction expected) Constructs an SVNEvent object given an error message for a filed operation. -
Method Summary
Modifier and TypeMethodDescriptionGets the type of an action performed upon the item.Returns a changelist name.Gets the status type of either file or directory contents.Gets the error message that (if it's an error situation and therefore the string is not null) points to some fault.Returns the expected action.getFile()
Returns local path the event is fired for.getInfo()
getLock()
Gets the file item's lock information (if any) represented by an SVNLock object.Gets the file item's lock status.Returns the merge range.Gets the MIME type of the item relying upon the special SVN's 'svn:mime-type' property.Gets the node kind of the item characterizing it as an entry - whether it's a directory, file, etc.long
Returns the local revision before it will be changed by an update.Returns the item's repository url before it will be changed by an update.Gets the status type of the item's properties.long
Gets the revision number specific for the action context.getURL()
Returns the repository URL that this event is fired for.void
void
void
setPreviousRevision
(long previousRevision) Sets the item revision which will be changed by the operation after this event is handled.void
setPreviousURL
(SVNURL url) Sets the item url which will be changed by the operation after this event is handled.void
setPropertyName
(String propertyName) void
setRevisionProperties
(SVNProperties revisionProperties) void
Sets the repository url.toString()
-
Constructor Details
-
SVNEvent
Constructs an SVNEvent object given an error message for a filed operation.Used by SVNKit internals to construct and initialize an SVNEvent object. It's not intended for users (from an API point of view).
- Parameters:
errorMessage
- the message describing the operation fault
-
SVNEvent
public SVNEvent(File file, SVNNodeKind kind, String mimetype, long revision, SVNStatusType cstatus, SVNStatusType pstatus, SVNStatusType lstatus, SVNLock lock, SVNEventAction action, SVNEventAction expected, SVNErrorMessage error, SVNMergeRange range, String changelistName, SVNProperties revisionProperties, String propertyName) Constructs an SVNEvent object.Used by SVNKit internals to construct and initialize an SVNEvent object. It's not intended for users (from an API point of view).
- Parameters:
file
- local pathaction
- the type of action the item is exposed tokind
- the item's node kindrevision
- a revision numbermimetype
- the item's MIME typecstatus
- the item's contents statuspstatus
- the item's properties statuslstatus
- the item's lock statuslock
- the item's lockexpected
- the action type that was expectederror
- an error messagerange
- merge rangechangelistName
- change list name
-
-
Method Details
-
getFile
Returns local path the event is fired for.- Returns:
- local path
-
getAction
Gets the type of an action performed upon the item. An action is one of predefined SVNEventAction constants that are specific for each kind of operation, such as update actions, commit actions, etc.- Returns:
- the current action
-
getExpectedAction
Returns the expected action. It is always the same as the action returned bygetAction()
except those cases whengetAction()
returnsSVNEventAction.SKIP
(i.e. when the expected operation is skipped).- Returns:
- the expected action
-
getContentsStatus
Gets the status type of either file or directory contents. Use predefined SVNStatusType constants to examine the item's status. For a directory contents are its entries.- Returns:
- the item's status type
-
getErrorMessage
Gets the error message that (if it's an error situation and therefore the string is not null) points to some fault.- Returns:
- an error message (in case of an error occured) or null if everything is OK
-
getLock
Gets the file item's lock information (if any) represented by an SVNLock object.- Returns:
- the file item's lock info if the file is locked; otherwise null
-
getLockStatus
Gets the file item's lock status. The value of SVNStatusType.LOCK_INAPPLICABLE means the lock status is irrelevant during the current event action.- Returns:
- the lock status of the file item
-
getMimeType
Gets the MIME type of the item relying upon the special SVN's 'svn:mime-type' property.You can use
SVNProperty
's metods to find out whether it's a text MIME type or a binary:import org.tmatesoft.svn.core.SVNProperty; ... String mimeType = event.getMimeType(); if(SVNProperty.isBinaryMimeType(mimeType)){ //your processing }
- Returns:
- the item's MIME type as a string or null if the item has no 'svn:mime-type' property set
-
getNodeKind
Gets the node kind of the item characterizing it as an entry - whether it's a directory, file, etc. The value of SVNNodeKind.NONE may mean the node kind is inapplicable diring the current event action. The value of SVNNodeKind.UNKNOWN may mean deleted entries.- Returns:
- the item's node kind
-
getPropertiesStatus
Gets the status type of the item's properties. The value of SVNStatusType.INAPPLICABLE may mean the item has no versioned properties or that properties status is irrelevant during the current event action.- Returns:
- the status type of the item's properties
-
getRevision
public long getRevision()Gets the revision number specific for the action context. It may be whether an update revision or a committed one or an inapplicable value when a revision number is irrelevant during the event action.- Returns:
- a revision number
-
getPreviousRevision
public long getPreviousRevision()Returns the local revision before it will be changed by an update.- Returns:
- revision prior to modification
- Since:
- 1.2.0, SVN 1.5.0
-
getURL
Returns the repository URL that this event is fired for.- Returns:
- repository url
-
getPreviousURL
Returns the item's repository url before it will be changed by an update.- Returns:
- repository url prior to modification
- Since:
- 1.2.0, SVN 1.5.0
-
getChangelistName
Returns a changelist name. Relevant for changelist operations provided bySVNChangelistClient
.- Returns:
- changelist name
- Since:
- 1.2.0, SVN 1.5.0
-
getMergeRange
Returns the merge range. Whenaction
isSVNEventAction.MERGE_BEGIN
, and both the left and right sides of the merge are not from the same URL, the return value is null.- Returns:
- merge range
- Since:
- 1.2.0, New in SVN 1.5.0
-
setPreviousRevision
public void setPreviousRevision(long previousRevision) Sets the item revision which will be changed by the operation after this event is handled. Note: this method is not intended for API users.- Parameters:
previousRevision
- previous revision- Since:
- 1.2.0, SVN 1.5.0
-
setURL
Sets the repository url. Note: this method is not intended for API users.- Parameters:
url
- repository url
-
setPreviousURL
Sets the item url which will be changed by the operation after this event is handled. Note: this method is not intended for API users.- Parameters:
url
- previous url- Since:
- 1.2.0, SVN 1.5.0
-
toString
-
getInfo
-
setInfo
-
setFile
-
getRevisionProperties
-
setRevisionProperties
-
getPropertyName
-
setPropertyName
-