Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  package org.tigris.subversion.javahl;

Copyright:
==================================================================== Copyright (c) 2003-2004 CollabNet. All rights reserved. This software is licensed as described in the file COPYING, which you should have received as part of this distribution. The terms are also available at http://subversion.tigris.org/license-1.html. If newer versions of this license are posted there, you may use a newer version instead, at your option. This software consists of voluntary contributions made by many individuals. For exact contribution history, see the revision history and logs, available at http://subversion.tigris.org/. ====================================================================
Endcopyright:
 
 
This interface is the commom interface for all subversion operations. It is implemented by SVNClient and SVNClientSynchronized
 
 public interface SVNClientInterface
 {
    
release the native peer (should not depend on finalize)
 
     void dispose();
    

Returns:
Version information about the underlying native libraries.
 
     public Version getVersion();
    

Returns:
The name of the working copy's administrative directory, which is usually .svn.
Since:
1.3
See also:
Instructions on changing this as a work-around for the behavior of ASP.Net on Windows.
 
     public String getAdminDirectoryName();
    

Parameters:
name The name of the directory to compare.
Returns:
Whether name is that of a working copy administrative directory.
Since:
1.3
 
     public boolean isAdminDirectory(String name);
    
Returns the last destination path submitted.

Deprecated:
Returns:
path in Subversion format.
 
     String getLastPath();
    
List a directory or file of the working copy.

Parameters:
path Path to explore.
descend Recurse into subdirectories if they exist.
onServer Request status information from server.
getAll get status for uninteristing files (unchanged).
Returns:
Array of Status entries.
 
     Status[]status(String pathboolean descendboolean onServer,
                    boolean getAllthrows ClientException;
    
List a directory or file of the working copy.

Parameters:
path Path to explore.
descend Recurse into subdirectories if they exist.
onServer Request status information from server.
getAll get status for uninteristing files (unchanged).
noIgnore get status for normaly ignored files and directories.
Returns:
Array of Status entries.
 
     Status[]status(String pathboolean descendboolean onServer,
                    boolean getAllboolean noIgnorethrows ClientException;
    
List a directory or file of the working copy.

Parameters:
path Path to explore.
descend Recurse into subdirectories if they exist.
onServer Request status information from server.
getAll get status for uninteristing files (unchanged).
noIgnore get status for normaly ignored files and directories.
ignoreExternals if externals are ignored during status
Returns:
Array of Status entries.
Since:
1.2
 
     Status[]status(String pathboolean descendboolean onServer,
                    boolean getAllboolean noIgnoreboolean ignoreExternals)
             throws ClientException;
    
Lists the directory entries of an url on the server.

Parameters:
url the url to list
revision the revision to list
recurse recurse into subdirectories
Returns:
Array of DirEntry objects.
    DirEntry[]list(String urlRevision revisionboolean recurse)
            throws ClientException;
    
Lists the directory entries of an url on the server.

Parameters:
url the url to list
revision the revision to list
pegRevision the revision to interpret url
recurse recurse into subdirectories
Returns:
Array of DirEntry objects.
Since:
1.2
    DirEntry[]list(String urlRevision revisionRevision pegRevision,
                   boolean recurse)
            throws ClientException;
    
Returns the status of a single file in the path.

Parameters:
path File to gather status.
onServer Request status information from the server.
Returns:
the subversion status of the file.
    Status singleStatus(String pathboolean onServerthrows ClientException;
    
Sets the username used for authentication.

Parameters:
username The username, ignored if the empty string. Set to the empty string to clear it.
Throws:
java.lang.IllegalArgumentException If username is null.
See also:
password(java.lang.String)
    void username(String username);
    
Sets the password used for authentication.

Parameters:
password The password, ignored if the empty string. Set to the empty string to clear it.
Throws:
java.lang.IllegalArgumentException If password is null.
See also:
username(java.lang.String)
    void password(String password);
    
Register callback interface to supply username and password on demand

Parameters:
prompt the callback interface
    void setPrompt(PromptUserPassword prompt);
    
Retrieve the log messages for an item

Parameters:
path path or url to get the log message for.
revisionStart first revision to show
revisionEnd last revision to show
Returns:
array of LogMessages
    LogMessage[] logMessages(String pathRevision revisionStart,
                             Revision revisionEndthrows ClientException;
    
Retrieve the log messages for an item

Parameters:
path path or url to get the log message for.
revisionStart first revision to show
revisionEnd last revision to show
stopOnCopy do not continue on copy operations
Returns:
array of LogMessages
    LogMessage[] logMessages(String pathRevision revisionStart,
                             Revision revisionEndboolean stopOnCopy)
            throws ClientException;
    
Retrieve the log messages for an item

Parameters:
path path or url to get the log message for.
revisionStart first revision to show
revisionEnd last revision to show
stopOnCopy do not continue on copy operations
discoverPath returns the paths of the changed items in the returned objects
Returns:
array of LogMessages
    LogMessage[] logMessages(String pathRevision revisionStart,
                             Revision revisionEndboolean stopOnCopy,
                             boolean discoverPath)
            throws ClientException;
    
Retrieve the log messages for an item

Parameters:
path path or url to get the log message for.
revisionStart first revision to show
revisionEnd last revision to show
stopOnCopy do not continue on copy operations
discoverPath returns the paths of the changed items in the returned objects
limit limit the number of log messages (if 0 or less no limit)
Returns:
array of LogMessages
Since:
1.2
    LogMessage[] logMessages(String pathRevision revisionStart,
                             Revision revisionEndboolean stopOnCopy,
                             boolean discoverPathlong limit)
            throws ClientException;
    
Executes a revision checkout.

Parameters:
moduleName name of the module to checkout.
destPath destination directory for checkout.
revision the revision to checkout.
pegRevision the peg revision to interpret the path
recurse whether you want it to checkout files recursively.
ignoreExternals if externals are ignored during checkout
Throws:
ClientException
Since:
1.2
    long checkout(String moduleNameString destPathRevision revision,
                  Revision pegRevisionboolean recurse,
                  boolean ignoreExternalsthrows ClientException;
    
Executes a revision checkout.

Parameters:
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.
Throws:
ClientException
    long checkout(String moduleNameString destPathRevision revision,
                  boolean recurse)
            throws ClientException;
    
Sets the notification callback used to send processing information back to the calling program.

Deprecated:
use notification2 instead
Parameters:
notify listener that the SVN library should call on many file operations.
    void notification(Notify notify);
    
Sets the notification callback used to send processing information back to the calling program.

Parameters:
notify listener that the SVN library should call on many file operations.
Since:
1.2
    void notification2(Notify2 notify);
    
Sets the commit message handler. This allows more complex commit message with the list of the elements to be commited as input.

Parameters:
messageHandler callback for entering commit messages if this is set the message parameter is ignored.
    void commitMessageHandler(CommitMessage messageHandler);
    
Sets a file for deletion.

Parameters:
path path or url to be deleted
message if path is a url, this will be the commit message.
force delete even when there are local modifications.
Throws:
ClientException
    void remove(String[] pathString messageboolean force)
            throws ClientException;
    
Reverts a file to a pristine state.

Parameters:
path path of the file.
recurse recurse into subdirectories
Throws:
ClientException
    void revert(String pathboolean recurse)throws ClientException;
    
Adds a file to the repository.

Parameters:
path path to be added.
recurse recurse into subdirectories
Throws:
ClientException
    void add(String pathboolean recurse)throws ClientException;
    
Adds a file to the repository.

Parameters:
path path to be added.
recurse recurse into subdirectories
force if adding a directory and recurse true and path is a directory, all not already managed files are added.
Throws:
ClientException
Since:
1.2
    void add(String pathboolean recurseboolean force)throws ClientException;
    
Updates the directory or file from repository

Parameters:
path target file.
revision the revision number to update. Revision.HEAD will update to the latest revision.
recurse recursively update.
Throws:
ClientException
    long update(String pathRevision revisionboolean recurse)
            throws ClientException;
    
Updates the directories or files from repository

Parameters:
path array of target files.
revision the revision number to update. Revision.HEAD will update to the latest revision.
recurse recursively update.
ignoreExternals if externals are ignored during update
Throws:
ClientException
Since:
1.2
    long[] update(String[] pathRevision revisionboolean recurse,
                  boolean ignoreExternalsthrows ClientException;
    
Commits changes to the repository.

Parameters:
path files to commit.
message log message.
recurse whether the operation should be done recursively.
Returns:
Returns a long representing the revision. It returns a -1 if the revision number is invalid.
Throws:
ClientException
    long commit(String[] pathString messageboolean recurse)
            throws ClientException;
    
Commits changes to the repository.

Parameters:
path files to commit.
message log message.
recurse whether the operation should be done recursively.
noUnlock do remove any locks
Returns:
Returns a long representing the revision. It returns a -1 if the revision number is invalid.
Throws:
ClientException
    long commit(String[] pathString messageboolean recurse,
                boolean noUnlockthrows ClientException;
    
Copies a versioned file with the history preserved.

Parameters:
srcPath source path or url
destPath destination path or url
message commit message if destPath is an url
revision source revision
Throws:
ClientException
    void copy(String srcPathString destPathString message,
              Revision revisionthrows ClientException;
    
Moves or renames a file.

Parameters:
srcPath source path or url
destPath destination path or url
message commit message if destPath is an url
revision source revision (unused)
force even with local modifications.
Throws:
ClientException
    void move(String srcPathString destPathString message,
              Revision revisionboolean forcethrows ClientException;
    
Moves or renames a file.

Parameters:
srcPath source path or url
destPath destination path or url
message commit message if destPath is an url
force even with local modifications.
Throws:
ClientException
Since:
1.2
    void move(String srcPathString destPathString message,
              boolean forcethrows ClientException;
    
Creates a directory directly in a repository or creates a directory on disk and schedules it for addition.

Parameters:
path directories to be created
message commit message to used if path contains urls
Throws:
ClientException
    void mkdir(String[] pathString messagethrows ClientException;
    
Recursively cleans up a local directory, finishing any incomplete operations, removing lockfiles, etc.

Parameters:
path a local directory.
Throws:
ClientException
    void cleanup(String paththrows ClientException;
    
Removes the 'conflicted' state on a file.

Parameters:
path path to cleanup
recurse recurce into subdirectories
Throws:
ClientException
    void resolved(String pathboolean recursethrows ClientException;
    
Exports the contents of either a subversion repository into a 'clean' directory (meaning a directory with no administrative directories).

Parameters:
srcPath the url of the repository path to be exported
destPath a destination path that must not already exist.
revision the revsion to be exported
force set if it is ok to overwrite local files
Throws:
ClientException
    long doExport(String srcPathString destPathRevision revision,
                  boolean forcethrows ClientException;
    
Exports the contents of either a subversion repository into a 'clean' directory (meaning a directory with no administrative directories).

Parameters:
srcPath the url of the repository path to be exported
destPath a destination path that must not already exist.
revision the revsion to be exported
pegRevision the revision to interpret srcPath
force set if it is ok to overwrite local files
ignoreExternals ignore external during export
recurse recurse to subdirectories
nativeEOL which EOL characters to use during export
Throws:
ClientException
Since:
1.2
    long doExport(String srcPathString destPathRevision revision,
                  Revision pegRevisionboolean forceboolean ignoreExternals,
                  boolean recurseString nativeEOLthrows ClientException;
    
Update local copy to mirror a new url.

Parameters:
path the working copy path
url the new url for the working copy
revision the new base revision of working copy
recurse traverse into subdirectories
Throws:
ClientException
    long doSwitch(String pathString urlRevision revisionboolean recurse)
            throws ClientException;
    
Import a file or directory into a repository directory at head.

Parameters:
path the local path
url the target url
message the log message.
recurse traverse into subdirectories
Throws:
ClientException
    void doImport(String pathString urlString messageboolean recurse)
            throws ClientException;
    
Merge changes from two paths into a new local path.

Parameters:
path1 first path or url
revision1 first revision
path2 second path or url
revision2 second revision
localPath target local path
force overwrite local changes
recurse traverse into subdirectories
Throws:
ClientException
    void merge(String path1Revision revision1String path2,
               Revision revision2String localPathboolean force,
               boolean recursethrows ClientException;
    
Merge changes from two paths into a new local path.

Parameters:
path1 first path or url
revision1 first revision
path2 second path or url
revision2 second revision
localPath target local path
force overwrite local changes
recurse traverse into subdirectories
ignoreAncestry ignore if files are not related
dryRun do not change anything
Throws:
ClientException
Since:
1.2
    void merge(String path1Revision revision1String path2,
               Revision revision2String localPathboolean force,
               boolean recurseboolean ignoreAncestryboolean dryRun)
            throws ClientException;
    
Merge changes from two paths into a new local path.

Parameters:
path path or url
pegRevision revision to interpret path
revision1 first revision
revision2 second revision
localPath target local path
force overwrite local changes
recurse traverse into subdirectories
ignoreAncestry ignore if files are not related
dryRun do not change anything
Throws:
ClientException
Since:
1.2
    void merge(String pathRevision pegRevisionRevision revision1,
               Revision revision2String localPathboolean force,
               boolean recurseboolean ignoreAncestryboolean dryRun)
            throws ClientException;
    
Display the differences between two paths

Parameters:
target1 first path or url
revision1 first revision
target2 second path or url
revision2 second revision
outFileName file name where difference are written
recurse traverse into subdirectories
Throws:
ClientException
    void diff(String target1Revision revision1String target2,
              Revision revision2String outFileNameboolean recurse)
            throws ClientException;
    
Display the differences between two paths

Parameters:
target1 first path or url
revision1 first revision
target2 second path or url
revision2 second revision
outFileName file name where difference are written
recurse traverse into subdirectories
ignoreAncestry ignore if files are not related
noDiffDeleted no output on deleted files
force diff even on binary files
Throws:
ClientException
Since:
1.2
    void diff(String target1Revision revision1String target2,
              Revision revision2String outFileNameboolean recurse
              boolean ignoreAncestryboolean noDiffDeletedboolean force)
            throws ClientException;
    
Display the differences between two paths

Parameters:
target path or url
pegRevision revision tointerpret target
startRevision first Revision to compare
endRevision second Revision to compare
outFileName file name where difference are written
recurse traverse into subdirectories
ignoreAncestry ignore if files are not related
noDiffDeleted no output on deleted files
force diff even on binary files
Throws:
ClientException
Since:
1.2
    void diff(String targetRevision pegRevisionRevision startRevision,
              Revision endRevisionString outFileNameboolean recurse,
              boolean ignoreAncestryboolean noDiffDeletedboolean force)
            throws ClientException;

    
Retrieves the properties of an item

Parameters:
path the path of the item
Returns:
array of property objects
    PropertyData[] properties(String paththrows ClientException;
    
Retrieves the properties of an item

Parameters:
path the path of the item
revision the revision of the item
Returns:
array of property objects
Since:
1.2
    PropertyData[] properties(String pathRevision revision)
            throws ClientException;
    
Retrieves the properties of an item

Parameters:
path the path of the item
revision the revision of the item
pegRevision the revision to interpret path
Returns:
array of property objects
Since:
1.2
    PropertyData[] properties(String pathRevision revision
                              Revision pegRevision)
            throws ClientException;
    
Sets one property of an item with a String value

Parameters:
path path of the item
name name of the property
value new value of the property
recurse set property also on the subdirectories
Throws:
ClientException
    void propertySet(String pathString nameString valueboolean recurse)
            throws ClientException;
    
Sets one property of an item with a String value

Parameters:
path path of the item
name name of the property
value new value of the property
recurse set property also on the subdirectories
force do not check if the value is valid
Throws:
ClientException
Since:
1.2
    void propertySet(String pathString nameString valueboolean recurse,
                     boolean force)
            throws ClientException;
    
Sets one property of an item with a byte array value

Parameters:
path path of the item
name name of the property
value new value of the property
recurse set property also on the subdirectories
Throws:
ClientException
    void propertySet(String pathString namebyte[] valueboolean recurse)
            throws ClientException;
    
Sets one property of an item with a byte array value

Parameters:
path path of the item
name name of the property
value new value of the property
recurse set property also on the subdirectories
force do not check if the value is valid
Throws:
ClientException
Since:
1.2
    void propertySet(String pathString namebyte[] valueboolean recurse,
                     boolean force)
            throws ClientException;
    
Remove one property of an item.

Parameters:
path path of the item
name name of the property
recurse remove the property also on subdirectories
Throws:
ClientException
    void propertyRemove(String pathString nameboolean recurse)
            throws ClientException;
    
Create and sets one property of an item with a String value

Parameters:
path path of the item
name name of the property
value new value of the property
recurse set property also on the subdirectories
Throws:
ClientException
    void propertyCreate(String pathString nameString valueboolean recurse)
            throws ClientException;
    
Create and sets one property of an item with a String value

Parameters:
path path of the item
name name of the property
value new value of the property
recurse set property also on the subdirectories
force do not check if the value is valid
Throws:
ClientException
Since:
1.2
    void propertyCreate(String pathString nameString valueboolean recurse,
                        boolean force)
            throws ClientException;
    
Create and sets one property of an item with a byte array value

Parameters:
path path of the item
name name of the property
value new value of the property
recurse set property also on the subdirectories
Throws:
ClientException
    void propertyCreate(String pathString namebyte[] valueboolean recurse)
            throws ClientException;
    
Create and sets one property of an item with a byte array value

Parameters:
path path of the item
name name of the property
value new value of the property
recurse set property also on the subdirectories
force do not check if the value is valid
Throws:
ClientException
Since:
1.2
    void propertyCreate(String pathString namebyte[] valueboolean recurse,
                        boolean force)
            throws ClientException;
    
Retrieve one revsision property of one item

Parameters:
path path of the item
name name of the property
rev revision to retrieve
Returns:
the Property
Throws:
ClientException
    PropertyData revProperty(String pathString nameRevision rev)
            throws ClientException;
    
Retrieve all revsision properties of one item

Parameters:
path path of the item
rev revision to retrieve
Returns:
the Properties
Throws:
ClientException
Since:
1.2
    PropertyData[] revProperties(String pathRevision rev)
            throws ClientException;
    
set one revsision property of one item

Parameters:
path path of the item
name name of the property
rev revision to retrieve
value value of the property
force use force to set
Throws:
ClientException
Since:
1.2
    void setRevProperty(String pathString nameRevision revString value,
                        boolean force)
            throws ClientException;
    
Retrieve one property of one iten

Parameters:
path path of the item
name name of property
Returns:
the Property
Throws:
ClientException
    PropertyData propertyGet(String pathString namethrows ClientException;
    
Retrieve one property of one iten

Parameters:
path path of the item
name name of property
revision revision of the item
Returns:
the Property
Throws:
ClientException
Since:
1.2
    PropertyData propertyGet(String pathString nameRevision revision)
            throws ClientException;
    
Retrieve one property of one iten

Parameters:
path path of the item
name name of property
revision revision of the item
pegRevision the revision to interpret path
Returns:
the Property
Throws:
ClientException
Since:
1.2
    PropertyData propertyGet(String pathString nameRevision revision,
                             Revision pegRevision)
            throws ClientException;
    
Retrieve the content of a file

Parameters:
path the path of the file
revision the revision to retrieve
Returns:
the content as byte array
Throws:
ClientException
    byte[] fileContent(String pathRevision revisionthrows ClientException;
    
Retrieve the content of a file

Parameters:
path the path of the file
revision the revision to retrieve
pegRevision the revision to interpret path
Returns:
the content as byte array
Throws:
ClientException
Since:
1.2
    byte[] fileContent(String pathRevision revisionRevision pegRevision)
            throws ClientException;
    
Write the file's content to the specified output stream. If you need an InputStream, use a PipedInputStream/PipedOutputStream combination.

Parameters:
path the path of the file
revision the revision to retrieve
pegRevision the revision at which to interpret the path
the stream to write the file's content to
Throws:
ClientException
See also:
PipedOutputStream
PipedInputStream
    void streamFileContent(String pathRevision revisionRevision pegRevision,
                           int bufferSizeOutputStream stream
        throws ClientException;

    
Rewrite the url's in the working copy

Parameters:
from old url
to new url
path working copy path
recurse recurse into subdirectories
Throws:
ClientException
    void relocate(String fromString toString pathboolean recurse)
            throws ClientException;
    
Return for each line of the file, the author and the revision of the last together with the content.

Deprecated:
Parameters:
path the path
revisionStart the first revision to show
revisionEnd the last revision to show
Returns:
the content together with author and revision of last change
Throws:
ClientException
    byte[] blame(String pathRevision revisionStartRevision revisionEnd)
            throws ClientException;
    
Retrieve the content together with the author, the revision and the date of the last change of each line

Parameters:
path the path
revisionStart the first revision to show
revisionEnd the last revision to show
callback callback to receive the file content and the other information
Throws:
ClientException
    void blame(String pathRevision revisionStartRevision revisionEnd,
               BlameCallback callbackthrows ClientException;
    
Retrieve the content together with the author, the revision and the date of the last change of each line

Parameters:
path the path
pegRevision the revision to interpret the path
revisionStart the first revision to show
revisionEnd the last revision to show
callback callback to receive the file content and the other information
Throws:
ClientException
Since:
1.2
    void blame(String pathRevision pegRevisionRevision revisionStart,
               Revision revisionEnd,
               BlameCallback callbackthrows ClientException;
    
Set directory for the configuration information, taking the usual steps to ensure that Subversion's config file templates exist in the specified location.

Parameters:
configDir path of the directory
Throws:
ClientException
    void setConfigDirectory(String configDirthrows ClientException;
    
Get the configuration directory

Returns:
the directory
Throws:
ClientException
    String getConfigDirectory() throws ClientException;
    
cancel the active operation

    void cancelOperation() throws ClientException;

    
Retrieves the working copy information for an item

Parameters:
path path of the item
Returns:
the information object
Throws:
ClientException
    Info info(String paththrows ClientException;

    
Lock a working copy item

Parameters:
path path of the item
comment
force break an existing lock
Throws:
ClientException
Since:
1.2
    void lock(String[] pathString commentboolean force)
            throws ClientException;

    
Unlock a working copy item

Parameters:
path path of the item
force break an existing lock
Throws:
ClientException
Since:
1.2
    void unlock(String[] pathboolean force)
            throws ClientException;

    
Retrieve information about repository or working copy items.

Parameters:
pathOrUrl the path or the url of the item
revision the revision of the item to return
pegRevision the revision to interpret pathOrUrl
recurse flag if to recurse, if the item is a directory
Returns:
the information objects
Since:
1.2
    Info2[] info2(String pathOrUrlRevision revisionRevision pegRevision,
                 boolean recursethrows ClientException;
    
Produce a compact "version number" for a working copy

Parameters:
path path of the working copy
trailUrl to detect switches of the whole working copy
lastChanged last changed rather than current revisions
Returns:
the compact "version number"
Throws:
ClientException
Since:
1.2
    String getVersionInfo(String pathString trailUrlboolean lastChanged)
            throws ClientException;
New to GrepCode? Check out our FAQ X