org.sourcejammer.client.plugin
Class SJClientFileAdapter

java.lang.Object
  |
  +--org.sourcejammer.client.plugin.SJClientFileAdapter

All Implemented Interfaces:

SJClientFileEventListener, SJClientPlugin

public abstract class SJClientFileAdapter

extends java.lang.Object

implements SJClientFileEventListener

Title: $FileName: SJClientFileAdapter.java$

Version:

$VerNum: 2$

Author:

$AuthorName: Rob MacGrogan$

$Description: $
$KeyWordsOff: $

Abstract implementation of SJClientFileEventListener. Provides some useful methods and stub implementations of all methods. It is highly recommended that you extend this class instead of directly implementing SJClientFileEventListener for your file event listener plugins.

Field Summary

private java.util.HashMap

params

Constructor Summary

SJClientFileAdapter()

Method Summary

void	fileAdded(SJClientFileEvent ev)
void	fileBranched(SJClientFileEvent ev)
void	fileCheckedIn(SJClientFileEvent ev)
void	fileCheckedOut(SJClientFileEvent ev)
void	fileCheckOutUndone(SJClientFileEvent ev)
void	fileCopy(SJClientFileEvent ev)
void	fileDescriptionChanged(SJClientFileEvent ev)
void	fileDetailsViewed(SJClientFileEvent ev)
void	fileDiffViewed(SJClientFileEvent ev)
void	fileForceCheckedIn(SJClientFileEvent ev)
void	fileGet(SJClientFileEvent ev)
void	fileMove(SJClientFileEvent ev)
void	fileRemoved(SJClientFileEvent ev)
void	fileRenamed(SJClientFileEvent ev)
void	fileRolledBack(SJClientFileEvent ev)
void	fileShared(SJClientFileEvent ev)
void	fileShareRemoved(SJClientFileEvent ev)
void	fileVersionGet(SJClientFileEvent ev)
void	fileViewed(SJClientFileEvent ev)
protected java.lang.String	getParameter(java.lang.String name) Returns the requested parameter as a String.
void	initPlugin(java.util.HashMap params) Warning! If you override this method, be sure to call super.initPlugin().
void	mapType(java.lang.String nameSpaceURI, java.lang.String part, java.lang.Class javaType) If your plugin needs to send or receive any objects of customized clases to/from the server, you must register each class by calling this method from the initPlugin() method. First of all, the custom class must be availble to (in the classpath of) both client and server.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sourcejammer.client.plugin.SJClientFileEventListener

fileMoveCopy

Field Detail

params

private java.util.HashMap params

Constructor Detail

SJClientFileAdapter

public SJClientFileAdapter()

Method Detail

getParameter

protected java.lang.String getParameter(java.lang.String name)

Returns the requested parameter as a String.

initPlugin

public void initPlugin(java.util.HashMap params)

Warning! If you override this method, be sure to call super.initPlugin().

Specified by:

initPlugin in interface SJClientPlugin

mapType

public void mapType(java.lang.String nameSpaceURI,
                    java.lang.String part,
                    java.lang.Class javaType)

If your plugin needs to send or receive any objects of customized clases to/from the server, you must register each class by calling this method from the initPlugin() method.

First of all, the custom class must be availble to (in the classpath of) both client and server. Second, the class must be deployed on the server. Third, you must call this method once for each custom class, passing the Namespace URI and part specified for the class when you deployed.

Each class should only be registered once, system-wide. If you use the same class in multiple plugins, be sure to register the class in only one of your plugins.

Please refer to the Apache SOAP documentation for further details.

fileAdded

public void fileAdded(SJClientFileEvent ev)

Specified by:

fileAdded in interface SJClientFileEventListener

See Also:

SJClientFileEventListener.fileAdded(SJClientFileEvent)

fileBranched

public void fileBranched(SJClientFileEvent ev)

Specified by:

fileBranched in interface SJClientFileEventListener

See Also:

SJClientFileEventListener.fileBranched(SJClientFileEvent)

fileCheckedIn

public void fileCheckedIn(SJClientFileEvent ev)

Specified by:

fileCheckedIn in interface SJClientFileEventListener

See Also:

SJClientFileEventListener.fileCheckedIn(SJClientFileEvent)

fileCheckedOut

public void fileCheckedOut(SJClientFileEvent ev)

Specified by:

fileCheckedOut in interface SJClientFileEventListener

See Also:

SJClientFileEventListener.fileCheckedOut(SJClientFileEvent)

fileCheckOutUndone

public void fileCheckOutUndone(SJClientFileEvent ev)

Specified by:

fileCheckOutUndone in interface SJClientFileEventListener

See Also:

SJClientFileEventListener.fileCheckOutUndone(SJClientFileEvent)

fileCopy

public void fileCopy(SJClientFileEvent ev)

See Also:

org.sourcejammer.client.plugin.SJClientFileEventListener#fileCopy(SJClientFileEvent)

fileDescriptionChanged

public void fileDescriptionChanged(SJClientFileEvent ev)

Specified by:

fileDescriptionChanged in interface SJClientFileEventListener

See Also:

SJClientFileEventListener.fileDescriptionChanged(SJClientFileEvent)

fileDetailsViewed

public void fileDetailsViewed(SJClientFileEvent ev)

Specified by:

fileDetailsViewed in interface SJClientFileEventListener

See Also:

SJClientFileEventListener.fileDetailsViewed(SJClientFileEvent)

fileDiffViewed

public void fileDiffViewed(SJClientFileEvent ev)

Specified by:

fileDiffViewed in interface SJClientFileEventListener

See Also:

SJClientFileEventListener.fileDiffViewed(SJClientFileEvent)

fileForceCheckedIn

public void fileForceCheckedIn(SJClientFileEvent ev)

Specified by:

fileForceCheckedIn in interface SJClientFileEventListener

See Also:

SJClientFileEventListener.fileForceCheckedIn(SJClientFileEvent)

fileGet

public void fileGet(SJClientFileEvent ev)

Specified by:

fileGet in interface SJClientFileEventListener

See Also:

SJClientFileEventListener.fileGet(SJClientFileEvent)

fileMove

public void fileMove(SJClientFileEvent ev)

See Also:

org.sourcejammer.client.plugin.SJClientFileEventListener#fileMove(SJClientFileEvent)

fileRemoved

public void fileRemoved(SJClientFileEvent ev)

Specified by:

fileRemoved in interface SJClientFileEventListener

See Also:

SJClientFileEventListener.fileRemoved(SJClientFileEvent)

fileRenamed

public void fileRenamed(SJClientFileEvent ev)

Specified by:

fileRenamed in interface SJClientFileEventListener

See Also:

SJClientFileEventListener.fileRenamed(SJClientFileEvent)

fileRolledBack

public void fileRolledBack(SJClientFileEvent ev)

Specified by:

fileRolledBack in interface SJClientFileEventListener

See Also:

SJClientFileEventListener.fileRolledBack(SJClientFileEvent)

fileShared

public void fileShared(SJClientFileEvent ev)

Specified by:

fileShared in interface SJClientFileEventListener

See Also:

SJClientFileEventListener.fileShared(SJClientFileEvent)

fileShareRemoved

public void fileShareRemoved(SJClientFileEvent ev)

Specified by:

fileShareRemoved in interface SJClientFileEventListener

See Also:

SJClientFileEventListener.fileShareRemoved(SJClientFileEvent)

fileVersionGet

public void fileVersionGet(SJClientFileEvent ev)

Specified by:

fileVersionGet in interface SJClientFileEventListener

See Also:

SJClientFileEventListener.fileVersionGet(SJClientFileEvent)

fileViewed

public void fileViewed(SJClientFileEvent ev)

Specified by:

fileViewed in interface SJClientFileEventListener

See Also:

SJClientFileEventListener.fileViewed(SJClientFileEvent)