|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface is the commom interface for all subversion operations. It is implemented by SVNClient and SVNClientSynchronized
Method Summary | |
void |
add(java.lang.String path,
boolean recurse)
Adds a file to the repository. |
byte[] |
blame(java.lang.String path,
Revision revisionStart,
Revision revisionEnd)
Deprecated. |
void |
blame(java.lang.String path,
Revision revisionStart,
Revision revisionEnd,
BlameCallback callback)
Retrieve the content together with the author, the revision and the date of the last change of each line |
void |
cancelOperation()
cancel the active operation |
long |
checkout(java.lang.String moduleName,
java.lang.String destPath,
Revision revision,
boolean recurse)
Executes a revision checkout. |
void |
cleanup(java.lang.String path)
Recursively cleans up a local directory, finishing any incomplete operations, removing lockfiles, etc. |
long |
commit(java.lang.String[] path,
java.lang.String message,
boolean recurse)
Commits changes to the repository. |
void |
commitMessageHandler(CommitMessage messageHandler)
Sets the commit message handler. |
void |
copy(java.lang.String srcPath,
java.lang.String destPath,
java.lang.String message,
Revision revision)
Copies a versioned file with the history preserved. |
void |
diff(java.lang.String target1,
Revision revision1,
java.lang.String target2,
Revision revision2,
java.lang.String outFileName,
boolean recurse)
Display the differences between two paths |
void |
dispose()
release the native peer (should not depend on finalize) |
long |
doExport(java.lang.String srcPath,
java.lang.String destPath,
Revision revision,
boolean force)
Exports the contents of either a subversion repository into a 'clean' directory (meaning a directory with no administrative directories). |
void |
doImport(java.lang.String path,
java.lang.String url,
java.lang.String message,
boolean recurse)
Import a file or directory into a repository directory at head. |
long |
doSwitch(java.lang.String path,
java.lang.String url,
Revision revision,
boolean recurse)
Update local copy to mirror a new url. |
byte[] |
fileContent(java.lang.String path,
Revision revision)
Retrieve the content of a file |
java.lang.String |
getConfigDirectory()
Get the configuration directory |
java.lang.String |
getLastPath()
Deprecated. |
Info |
info(java.lang.String path)
Retrieves the working copy information for an item |
DirEntry[] |
list(java.lang.String url,
Revision revision,
boolean recurse)
Lists the directory entries of an url on the server. |
LogMessage[] |
logMessages(java.lang.String path,
Revision revisionStart,
Revision revisionEnd)
Retrieve the log messages for an item |
LogMessage[] |
logMessages(java.lang.String path,
Revision revisionStart,
Revision revisionEnd,
boolean stopOnCopy)
Retrieve the log messages for an item |
LogMessage[] |
logMessages(java.lang.String path,
Revision revisionStart,
Revision revisionEnd,
boolean stopOnCopy,
boolean discoverPath)
Retrieve the log messages for an item |
void |
merge(java.lang.String path1,
Revision revision1,
java.lang.String path2,
Revision revision2,
java.lang.String localPath,
boolean force,
boolean recurse)
Merge changes from two paths into a new local path. |
void |
mkdir(java.lang.String[] path,
java.lang.String message)
Creates a directory directly in a repository or creates a directory on disk and schedules it for addition. |
void |
move(java.lang.String srcPath,
java.lang.String destPath,
java.lang.String message,
Revision revision,
boolean force)
Moves or renames a file. |
void |
notification(Notify notify)
Sets the notification callback used to send processing information back to the calling program. |
void |
password(java.lang.String password)
Sets the password used for authification. |
PropertyData[] |
properties(java.lang.String path)
Retrieves the properties of an item |
void |
propertyCreate(java.lang.String path,
java.lang.String name,
byte[] value,
boolean recurse)
Create and sets one property of an item with a byte array value |
void |
propertyCreate(java.lang.String path,
java.lang.String name,
java.lang.String value,
boolean recurse)
Create and sets one property of an item with a String value |
PropertyData |
propertyGet(java.lang.String path,
java.lang.String name)
Retrieve one property of one iten |
void |
propertyRemove(java.lang.String path,
java.lang.String name,
boolean recurse)
Remove one property of an item. |
void |
propertySet(java.lang.String path,
java.lang.String name,
byte[] value,
boolean recurse)
Sets one property of an item with a byte array value |
void |
propertySet(java.lang.String path,
java.lang.String name,
java.lang.String value,
boolean recurse)
Sets one property of an item with a String value |
void |
relocate(java.lang.String from,
java.lang.String to,
java.lang.String path,
boolean recurse)
Rewrite the url's in the working copy |
void |
remove(java.lang.String[] path,
java.lang.String message,
boolean force)
Sets a file for deletion. |
void |
resolved(java.lang.String path,
boolean recurse)
Removes the 'conflicted' state on a file. |
void |
revert(java.lang.String path,
boolean recurse)
Reverts a file to a pristine state. |
PropertyData |
revProperty(java.lang.String path,
java.lang.String name,
Revision rev)
Retrieve one revsision property of one item |
void |
setConfigDirectory(java.lang.String configDir)
Set directory for the configuration information |
void |
setPrompt(PromptUserPassword prompt)
Register callback interface to supply username and password on demand |
Status |
singleStatus(java.lang.String path,
boolean onServer)
Returns the status of a single file in the path. |
Status[] |
status(java.lang.String path,
boolean descend,
boolean onServer,
boolean getAll)
List a directory or file of the working copy. |
Status[] |
status(java.lang.String path,
boolean descend,
boolean onServer,
boolean getAll,
boolean noIgnore)
List a directory or file of the working copy. |
long |
update(java.lang.String path,
Revision revision,
boolean recurse)
Updates the directory or file from repository |
void |
username(java.lang.String username)
Sets the username used for authentification. |
Method Detail |
public void dispose()
public java.lang.String getLastPath()
public Status[] status(java.lang.String path, boolean descend, boolean onServer, boolean getAll) throws ClientException
path
- Path to explore.descend
- Recurse into subdirectories if existant.onServer
- Request status information from server.getAll
- get status for uninteristing files (unchanged).public Status[] status(java.lang.String path, boolean descend, boolean onServer, boolean getAll, boolean noIgnore) throws ClientException
path
- Path to explore.descend
- Recurse into subdirectories if existant.onServer
- Request status information from server.getAll
- get status for uninteristing files (unchanged).noIgnore
- get status for normaly ignored files and directories.public DirEntry[] list(java.lang.String url, Revision revision, boolean recurse) throws ClientException
url
- the url to listrevision
- the revision to listrecurse
- recurse into subdirectoriespublic Status singleStatus(java.lang.String path, boolean onServer) throws ClientException
path
- File to gather status.onServer
- Request status information from the server.public void username(java.lang.String username)
username
- the usernamepublic void password(java.lang.String password)
password
- the passwordpublic void setPrompt(PromptUserPassword prompt)
prompt
- the callback interfacepublic LogMessage[] logMessages(java.lang.String path, Revision revisionStart, Revision revisionEnd) throws ClientException
path
- path or url to get the log message for.revisionStart
- first revision to showrevisionEnd
- last revision to showpublic LogMessage[] logMessages(java.lang.String path, Revision revisionStart, Revision revisionEnd, boolean stopOnCopy) throws ClientException
path
- path or url to get the log message for.revisionStart
- first revision to showrevisionEnd
- last revision to showstopOnCopy
- do not continue on copy operationspublic LogMessage[] logMessages(java.lang.String path, Revision revisionStart, Revision revisionEnd, boolean stopOnCopy, boolean discoverPath) throws ClientException
path
- path or url to get the log message for.revisionStart
- first revision to showrevisionEnd
- last revision to showstopOnCopy
- do not continue on copy operationsdiscoverPath
- returns the paths of the changed items in the
returned objectspublic long checkout(java.lang.String moduleName, java.lang.String destPath, Revision revision, boolean recurse) throws ClientException
moduleName
- name of the module to checkout.destPath
- destination directory for checkout.revision
- the revision to checkout.recurse
- whether you want it to checkout files recursively.ClientException
- public void notification(Notify notify)
notify
- listener that the SVN library should call on many
file operations.public void commitMessageHandler(CommitMessage messageHandler)
messageHandler
- callback for entering commit messages
if this is set the message parameter is ignored.public void remove(java.lang.String[] path, java.lang.String message, boolean force) throws ClientException
path
- path or url to be deletedmessage
- if path is a url, this will be the commit message.force
- delete even when there are local modifications.ClientException
- public void revert(java.lang.String path, boolean recurse) throws ClientException
path
- path of the file.recurse
- recurse into subdirectoriesClientException
- public void add(java.lang.String path, boolean recurse) throws ClientException
path
- path to be added.recurse
- recurse into subdirectoriesClientException
- public long update(java.lang.String path, Revision revision, boolean recurse) throws ClientException
path
- target file.revision
- the revision number to checkout.
Revision.HEAD will checkout the
latest revision.recurse
- recursively update.ClientException
- public long commit(java.lang.String[] path, java.lang.String message, boolean recurse) throws ClientException
path
- files to commit.message
- log message.recurse
- whether the operation should be done recursively.ClientException
- public void copy(java.lang.String srcPath, java.lang.String destPath, java.lang.String message, Revision revision) throws ClientException
srcPath
- source path or urldestPath
- destination path or urlmessage
- commit message if destPath is an urlrevision
- source revisionClientException
- public void move(java.lang.String srcPath, java.lang.String destPath, java.lang.String message, Revision revision, boolean force) throws ClientException
srcPath
- source path or urldestPath
- destination path or urlmessage
- commit message if destPath is an urlrevision
- source revisionforce
- even with local modifications.ClientException
- public void mkdir(java.lang.String[] path, java.lang.String message) throws ClientException
path
- directories to be createdmessage
- commit message to used if path contains urlsClientException
- public void cleanup(java.lang.String path) throws ClientException
path
- a local directory.ClientException
- public void resolved(java.lang.String path, boolean recurse) throws ClientException
path
- path to cleanuprecurse
- recurce into subdirectoriesClientException
- public long doExport(java.lang.String srcPath, java.lang.String destPath, Revision revision, boolean force) throws ClientException
srcPath
- the url of the repository path to be exporteddestPath
- a destination path that must not already exist.revision
- the revsion to be exportedforce
- set if it is ok to overwrite local filesClientException
- public long doSwitch(java.lang.String path, java.lang.String url, Revision revision, boolean recurse) throws ClientException
path
- the working copy pathurl
- the new url for the working copyrevision
- the new base revision of working copyrecurse
- traverse into subdirectoriesClientException
- public void doImport(java.lang.String path, java.lang.String url, java.lang.String message, boolean recurse) throws ClientException
path
- the local pathurl
- the target urlmessage
- the log message.recurse
- traverse into subdirectoriesClientException
- public void merge(java.lang.String path1, Revision revision1, java.lang.String path2, Revision revision2, java.lang.String localPath, boolean force, boolean recurse) throws ClientException
path1
- first path or urlrevision1
- first revisionpath2
- second path or urlrevision2
- second revisionlocalPath
- target local pathforce
- overwrite local changesrecurse
- traverse into subdirectoriesClientException
- public void diff(java.lang.String target1, Revision revision1, java.lang.String target2, Revision revision2, java.lang.String outFileName, boolean recurse) throws ClientException
target1
- first path or urlrevision1
- first revisiontarget2
- second path or urlrevision2
- second revisionoutFileName
- file name where difference are writtenrecurse
- traverse into subdirectoriesClientException
- public PropertyData[] properties(java.lang.String path) throws ClientException
path
- the path of the itempublic void propertySet(java.lang.String path, java.lang.String name, java.lang.String value, boolean recurse) throws ClientException
path
- path of the itemname
- name of the propertyvalue
- new value of the propertyrecurse
- set property also on the subdirectoriesClientException
- public void propertySet(java.lang.String path, java.lang.String name, byte[] value, boolean recurse) throws ClientException
path
- path of the itemname
- name of the propertyvalue
- new value of the propertyrecurse
- set property also on the subdirectoriesClientException
- public void propertyRemove(java.lang.String path, java.lang.String name, boolean recurse) throws ClientException
path
- path of the itemname
- name of the propertyrecurse
- remove the property also on subdirectoriesClientException
- public void propertyCreate(java.lang.String path, java.lang.String name, java.lang.String value, boolean recurse) throws ClientException
path
- path of the itemname
- name of the propertyvalue
- new value of the propertyrecurse
- set property also on the subdirectoriesClientException
- public void propertyCreate(java.lang.String path, java.lang.String name, byte[] value, boolean recurse) throws ClientException
path
- path of the itemname
- name of the propertyvalue
- new value of the propertyrecurse
- set property also on the subdirectoriesClientException
- public PropertyData revProperty(java.lang.String path, java.lang.String name, Revision rev) throws ClientException
path
- path of the itemname
- name of the propertyrev
- revision to retrieveClientException
- public PropertyData propertyGet(java.lang.String path, java.lang.String name) throws ClientException
path
- path of the itemname
- name of propertyClientException
- public byte[] fileContent(java.lang.String path, Revision revision) throws ClientException
path
- the path of the filerevision
- the revision to retrieveClientException
- public void relocate(java.lang.String from, java.lang.String to, java.lang.String path, boolean recurse) throws ClientException
from
- old urlto
- new urlpath
- working copy pathrecurse
- recurse into subdirectoriesClientException
- public byte[] blame(java.lang.String path, Revision revisionStart, Revision revisionEnd) throws ClientException
path
- the pathrevisionStart
- the first revision to showrevisionEnd
- the last revision to showClientException
- public void blame(java.lang.String path, Revision revisionStart, Revision revisionEnd, BlameCallback callback) throws ClientException
path
- the pathrevisionStart
- the first revision to showrevisionEnd
- the last revision to showcallback
- callback to receive the file content and the other
informationClientException
- public void setConfigDirectory(java.lang.String configDir) throws ClientException
configDir
- path of the directoryClientException
- public java.lang.String getConfigDirectory() throws ClientException
ClientException
- public void cancelOperation() throws ClientException
ClientException
- public Info info(java.lang.String path) throws ClientException
path
- path of the itemClientException
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |