| java.lang.Object
 org.tmatesoft.svn.core.wc.SVNBasicClient
org.tmatesoft.svn.core.wc.admin.SVNLookClient
| SVNLookClient | | public class SVNLookClient extends SVNBasicClient (Code) | | The SVNLookClient class provides API for examining
different aspects of a Subversion repository. Its functionality
is similar to the one of the Subversion command-line utility
called svnlook. The following table matches methods of
SVNLookClient to the corresponding commands of the
svnlook utility (to make sense what its different methods
are for):
| SVNLookClient |
Subversion |
| doCat() | 'svnlook cat' |
| doGetAuthor() | 'svnlook author' |
| doGetChanged() | 'svnlook changed' |
| doGetChangedDirectories() | 'svnlook dirs-changed' |
| doGetDate() | 'svnlook date' |
| doGetDiff() | 'svnlook diff' |
| doGetHistory() | 'svnlook history' |
| doGetInfo() | 'svnlook info' |
| doGetLock() | 'svnlook lock' |
| doGetLog() | 'svnlook log' |
| doGetProperties() | 'svnlook proplist' |
| doGetProperty() | 'svnlook propget' |
| doGetRevisionProperties() | 'svnlook proplist --revprop' |
| doGetRevisionProperty() | 'svnlook propget --revprop' |
| doGetTree() | 'svnlook tree' |
| doGetUUID() | 'svnlook uuid' |
| doGetYoungestRevision() | 'svnlook youngest' |
version:
1.1.1
author:
TMate Software Ltd.
since:
1.1.1 |
| Method Summary | |
| public void | doCat(File repositoryRoot, String path, SVNRevision revision, OutputStream out)
Fetches file contents for the specified revision and path. | | public void | doCat(File repositoryRoot, String path, String transactionName, OutputStream out)
Fetches file contents for the specified path in the given
transaction. | | public String | doGetAuthor(File repositoryRoot, SVNRevision revision)
Returns author information for the given revision. | | public String | doGetAuthor(File repositoryRoot, String transactionName)
Returns author information for the given transaction. | | public void | doGetChanged(File repositoryRoot, SVNRevision revision, ISVNChangeEntryHandler handler, boolean includeCopyInfo)
Traverses changed paths for the given revision invoking
the passed handler on each changed path. | | public void | doGetChanged(File repositoryRoot, String transactionName, ISVNChangeEntryHandler handler, boolean includeCopyInfo)
Traverses changed paths for the given transaction invoking
the passed handler on each changed path. | | public void | doGetChangedDirectories(File repositoryRoot, SVNRevision revision, ISVNChangedDirectoriesHandler handler)
Passes paths of directories changed in the given revision to the provided handler. | | public void | doGetChangedDirectories(File repositoryRoot, String transactionName, ISVNChangedDirectoriesHandler handler)
Passes paths of directories changed in the given transaction to the provided handler. | | public Date | doGetDate(File repositoryRoot, SVNRevision revision)
Returns datestamp information for the given revision. | | public Date | doGetDate(File repositoryRoot, String transactionName)
Returns datestamp information for the given transaction. | | public void | doGetDiff(File repositoryRoot, SVNRevision revision, boolean diffDeleted, boolean diffAdded, boolean diffCopyFrom, OutputStream os)
Writes differences of changed files and properties for the
given revision to the provided output stream. | | public void | doGetDiff(File repositoryRoot, String transactionName, boolean diffDeleted, boolean diffAdded, boolean diffCopyFrom, OutputStream os)
Writes differences of changed files and properties for the
given transaction to the provided output stream. | | public void | doGetHistory(File repositoryRoot, String path, SVNRevision revision, boolean includeIDs, ISVNHistoryHandler handler)
Passes history information for the specified path and revision to the provided handler.
This information is provided as
SVNAdminPath objects and include the following
pieces:
For history retrieval only these listed get methods of SVNAdminPath are
relevant. | | public SVNLogEntry | doGetInfo(File repositoryRoot, SVNRevision revision)
Retrieves author, timestamp and log message information from
the repository for the given revision. | | public SVNLogEntry | doGetInfo(File repositoryRoot, String transactionName)
Retrieves author, timestamp and log message information from
the repository for the given transaction name. | | public SVNLock | doGetLock(File repositoryRoot, String path)
Retrieves lock information for the specified path. | | public String | doGetLog(File repositoryRoot, SVNRevision revision)
Returns log information for the given revision. | | public String | doGetLog(File repositoryRoot, String transactionName)
Returns log information for the given transaction. | | public Map | doGetProperties(File repositoryRoot, String path, SVNRevision revision)
Returns versioned properties for the specified path in the
given revision. | | public Map | doGetProperties(File repositoryRoot, String path, String transactionName)
Returns versioned properties for the specified path in the
given transaction. | | public String | doGetProperty(File repositoryRoot, String propName, String path, SVNRevision revision)
Returns the value of a versioned property for the specified path in the
given revision. | | public String | doGetProperty(File repositoryRoot, String propName, String path, String transactionName)
Returns the value of a versioned property for the specified path in the
given transaction. | | public Map | doGetRevisionProperties(File repositoryRoot, SVNRevision revision)
Returns revision properties in the given revision. | | public Map | doGetRevisionProperties(File repositoryRoot, String transactionName)
Returns revision properties for the given transaction. | | public String | doGetRevisionProperty(File repositoryRoot, String propName, SVNRevision revision)
Returns the value of a revision property in the given revision. | | public String | doGetRevisionProperty(File repositoryRoot, String propName, String transactionName)
Returns the value of a revision property for the given transaction. | | public void | doGetTree(File repositoryRoot, String path, SVNRevision revision, boolean includeIDs, ISVNTreeHandler handler)
Traverses repository tree starting at the specified path in the
given revision and invoking the provided handler on each path.
Path information is provided as
SVNAdminPath objects and
include the following pieces:
For tree retrieval only these listed get methods of SVNAdminPath are
relevant. | | public void | doGetTree(File repositoryRoot, String path, String transactionName, boolean includeIDs, ISVNTreeHandler handler)
Traverses repository tree starting at the specified path in the
given transaction and invoking the provided handler on each path.
Path information is provided as
SVNAdminPath objects and
include the following pieces:
For tree retrieval only these listed get methods of SVNAdminPath are
relevant. | | public String | doGetUUID(File repositoryRoot)
Returns the uuid of the repository. | | public long | doGetYoungestRevision(File repositoryRoot)
Returns the latest revision of the repository. | | public ISVNGNUDiffGenerator | getDiffGenerator()
Returns a diff generator to be used in doGetDiff() methods of this class. | | public void | setDiffGenerator(ISVNGNUDiffGenerator diffGenerator)
Sets a diff generator to be used in doGetDiff() methods of this class. |
| SVNLookClient | | public SVNLookClient(ISVNAuthenticationManager authManager, ISVNOptions options)(Code) | | Creates a new instance of SVNLookClient
given an authentication manager and global
options keeper.
Parameters:
authManager - a manager which provides authenticationcredentials
Parameters:
options - a global config options provider |
| doCat | | public void doCat(File repositoryRoot, String path, SVNRevision revision, OutputStream out) throws SVNException(Code) | | Fetches file contents for the specified revision and path.
path must be absolute, that is it must
start with '/'. The provided output stream is
not closed within this method.
Parameters:
repositoryRoot - a repository root directory path
Parameters:
path - an absolute file path
Parameters:
revision - a revision number
Parameters:
out - an output stream to write contents to
throws:
SVNException - - no repository is found at
repositoryRoot - if
path is not found oris not a file
|
| doCat | | public void doCat(File repositoryRoot, String path, String transactionName, OutputStream out) throws SVNException(Code) | | Fetches file contents for the specified path in the given
transaction. path must be absolute, that is it
must start with '/'. The provided output stream
is not closed within this method.
Parameters:
repositoryRoot - a repository root directory path
Parameters:
path - an absolute file path
Parameters:
transactionName - a transaction name
Parameters:
out - an output stream to write contents to
throws:
SVNException - - no repository is found at
repositoryRoot - if
path is not found oris not a file - if the specified transaction is not found
|
| doGetAuthor | | public String doGetAuthor(File repositoryRoot, SVNRevision revision) throws SVNException(Code) | | Returns author information for the given revision.
Parameters:
repositoryRoot - a repository root directory path
Parameters:
revision - a revision number a revision author
throws:
SVNException - no repository is found at repositoryRoot |
| doGetAuthor | | public String doGetAuthor(File repositoryRoot, String transactionName) throws SVNException(Code) | | Returns author information for the given transaction.
Parameters:
repositoryRoot - a repository root directory path
Parameters:
transactionName - a transaction name a transaction owner
throws:
SVNException - - no repository is found at
repositoryRoot - if the specified transaction is not found
|
| doGetChanged | | public void doGetChanged(File repositoryRoot, SVNRevision revision, ISVNChangeEntryHandler handler, boolean includeCopyInfo) throws SVNException(Code) | | Traverses changed paths for the given revision invoking
the passed handler on each changed path.
Parameters:
repositoryRoot - a repository root directory path
Parameters:
revision - a revision number
Parameters:
handler - a changed path handler
Parameters:
includeCopyInfo - if true copy-from information is also provided for copied paths
throws:
SVNException - no repository is found at repositoryRoot |
| doGetChanged | | public void doGetChanged(File repositoryRoot, String transactionName, ISVNChangeEntryHandler handler, boolean includeCopyInfo) throws SVNException(Code) | | Traverses changed paths for the given transaction invoking
the passed handler on each changed path.
Parameters:
repositoryRoot - a repository root directory path
Parameters:
transactionName - a transaction name
Parameters:
handler - a changed path handler
Parameters:
includeCopyInfo - if true copy-from information is also provided for copied paths
throws:
SVNException - - no repository is found at
repositoryRoot - if the specified transaction is not found
|
| doGetChangedDirectories | | public void doGetChangedDirectories(File repositoryRoot, SVNRevision revision, ISVNChangedDirectoriesHandler handler) throws SVNException(Code) | | Passes paths of directories changed in the given revision to the provided handler.
Paths are absolute (start with '/').
Parameters:
repositoryRoot - a repository root directory path
Parameters:
revision - a revision number
Parameters:
handler - a path handler
throws:
SVNException - no repository is found at repositoryRoot |
| doGetChangedDirectories | | public void doGetChangedDirectories(File repositoryRoot, String transactionName, ISVNChangedDirectoriesHandler handler) throws SVNException(Code) | | Passes paths of directories changed in the given transaction to the provided handler.
Paths are absolute (start with '/').
Parameters:
repositoryRoot - a repository root directory path
Parameters:
transactionName - a transaction name
Parameters:
handler - a path handler
throws:
SVNException - - no repository is found at
repositoryRoot - if the specified transaction is not found
|
| doGetDate | | public Date doGetDate(File repositoryRoot, SVNRevision revision) throws SVNException(Code) | | Returns datestamp information for the given revision.
Parameters:
repositoryRoot - a repository root directory path
Parameters:
revision - a revision number a datestamp
throws:
SVNException - no repository is found at repositoryRoot |
| doGetDate | | public Date doGetDate(File repositoryRoot, String transactionName) throws SVNException(Code) | | Returns datestamp information for the given transaction.
Parameters:
repositoryRoot - a repository root directory path
Parameters:
transactionName - a transaction name a datestamp
throws:
SVNException - - no repository is found at
repositoryRoot - if the specified transaction is not found
|
| doGetDiff | | public void doGetDiff(File repositoryRoot, SVNRevision revision, boolean diffDeleted, boolean diffAdded, boolean diffCopyFrom, OutputStream os) throws SVNException(Code) | | Writes differences of changed files and properties for the
given revision to the provided output stream. If no special diff generator
SVNLookClient.setDiffGenerator(ISVNGNUDiffGenerator) was provided to
this client a default GNU-style diff generator is used (which
writes differences just like the 'svnlook diff' command).
The provided output stream is not closed within this method.
Parameters:
repositoryRoot - a repository root directory path
Parameters:
revision - a revision number
Parameters:
diffDeleted - if true differences for deleted files are included, otherwise not
Parameters:
diffAdded - if true differences for added files are included, otherwise not
Parameters:
diffCopyFrom - if true writes differences against the copy source (if any), otherwise not
Parameters:
os - an output stream to write differences to
throws:
SVNException - no repository is found at repositoryRoot |
| doGetDiff | | public void doGetDiff(File repositoryRoot, String transactionName, boolean diffDeleted, boolean diffAdded, boolean diffCopyFrom, OutputStream os) throws SVNException(Code) | | Writes differences of changed files and properties for the
given transaction to the provided output stream. If no special diff generator
SVNLookClient.setDiffGenerator(ISVNGNUDiffGenerator) was provided to
this client a default GNU-style diff generator is used (which
writes differences just like the 'svnlook diff' command).
Parameters:
repositoryRoot - a repository root directory path
Parameters:
transactionName - a transaction name
Parameters:
diffDeleted - if true differences for deleted files are included, otherwise not
Parameters:
diffAdded - if true differences for added files are included, otherwise not
Parameters:
diffCopyFrom - if true writes differences against the copy source (if any), otherwise not
Parameters:
os - an output stream to write differences to
throws:
SVNException - - no repository is found at
repositoryRoot - if the specified transaction is not found
|
| doGetHistory | | public void doGetHistory(File repositoryRoot, String path, SVNRevision revision, boolean includeIDs, ISVNHistoryHandler handler) throws SVNException(Code) | | Passes history information for the specified path and revision to the provided handler.
This information is provided as
SVNAdminPath objects and include the following
pieces:
For history retrieval only these listed get methods of SVNAdminPath are
relevant.
path must be absolute, that is it must start with '/'.
If path is null it defaults to
"/".
Parameters:
repositoryRoot - a repository root directory path
Parameters:
path - an absolute path
Parameters:
revision - a revision number
Parameters:
includeIDs - if true a node revision id is also included for each path
Parameters:
handler - a history handler
throws:
SVNException - - no repository is found at
repositoryRoot - if
path is not found
|
| doGetInfo | | public SVNLogEntry doGetInfo(File repositoryRoot, SVNRevision revision) throws SVNException(Code) | | Retrieves author, timestamp and log message information from
the repository for the given revision. This information is
provided in a single
org.tmatesoft.svn.core.SVNLogEntry
object, that is only the following methods of SVNLogEntry
return valid information:
Parameters:
repositoryRoot - a repository root directory path
Parameters:
revision - a revision number revision info
throws:
SVNException - no repository is found at repositoryRoot |
| doGetInfo | | public SVNLogEntry doGetInfo(File repositoryRoot, String transactionName) throws SVNException(Code) | | Retrieves author, timestamp and log message information from
the repository for the given transaction name. This information is
provided in a single
org.tmatesoft.svn.core.SVNLogEntry
object, that is only the following methods of SVNLogEntry
return valid information:
Parameters:
repositoryRoot - a repository root directory path
Parameters:
transactionName - a transaction name transaction info
throws:
SVNException - - no repository is found at
repositoryRoot - if the specified transaction is not found
|
| doGetLock | | public SVNLock doGetLock(File repositoryRoot, String path) throws SVNException(Code) | | Retrieves lock information for the specified path.
path must be absolute, that is it must start with '/'.
Parameters:
repositoryRoot - a repository root directory path
Parameters:
path - an absolute path an object containing details of a lock or null if the path is not locked
throws:
SVNException - - no repository is found at
repositoryRoot - if
path is not found
|
| doGetLog | | public String doGetLog(File repositoryRoot, SVNRevision revision) throws SVNException(Code) | | Returns log information for the given revision.
Parameters:
repositoryRoot - a repository root directory path
Parameters:
revision - a revision number a log message
throws:
SVNException - no repository is found at repositoryRoot |
| doGetLog | | public String doGetLog(File repositoryRoot, String transactionName) throws SVNException(Code) | | Returns log information for the given transaction.
Parameters:
repositoryRoot - a repository root directory path
Parameters:
transactionName - a transaction name a log message
throws:
SVNException - - no repository is found at
repositoryRoot - if the specified transaction is not found
|
| doGetProperties | | public Map doGetProperties(File repositoryRoot, String path, SVNRevision revision) throws SVNException(Code) | | Returns versioned properties for the specified path in the
given revision.
path must be absolute, that is it must start with '/'.
Parameters:
repositoryRoot - a repository root directory path
Parameters:
path - an absolute path
Parameters:
revision - a revision number name (String) to value (String) mappings
throws:
SVNException - - no repository is found at
repositoryRoot - if
path is not found
|
| doGetProperties | | public Map doGetProperties(File repositoryRoot, String path, String transactionName) throws SVNException(Code) | | Returns versioned properties for the specified path in the
given transaction.
path must be absolute, that is it must start with '/'.
Parameters:
repositoryRoot - a repository root directory path
Parameters:
path - an absolute path
Parameters:
transactionName - a transaction name name (String) to value (String) mappings
throws:
SVNException - - no repository is found at
repositoryRoot - if
path is not found - if the specified transaction is not found
|
| doGetProperty | | public String doGetProperty(File repositoryRoot, String propName, String path, SVNRevision revision) throws SVNException(Code) | | Returns the value of a versioned property for the specified path in the
given revision.
path must be absolute, that is it must start with '/'.
Parameters:
repositoryRoot - a repository root directory path
Parameters:
propName - a property name
Parameters:
path - an absolute path
Parameters:
revision - a revision number the value of a property
throws:
SVNException - - no repository is found at
repositoryRoot - if
path is not found
|
| doGetProperty | | public String doGetProperty(File repositoryRoot, String propName, String path, String transactionName) throws SVNException(Code) | | Returns the value of a versioned property for the specified path in the
given transaction.
path must be absolute, that is it must start with '/'.
Parameters:
repositoryRoot - a repository root directory path
Parameters:
propName - a property name
Parameters:
path - an absolute path
Parameters:
transactionName - a transaction name the value of a property
throws:
SVNException - - no repository is found at
repositoryRoot - if
path is not found - if the specified transaction is not found
|
| doGetRevisionProperties | | public Map doGetRevisionProperties(File repositoryRoot, SVNRevision revision) throws SVNException(Code) | | Returns revision properties in the given revision.
Parameters:
repositoryRoot - a repository root directory path
Parameters:
revision - a revision number name (String) to value (String) mappings
throws:
SVNException - no repository is found at repositoryRoot |
| doGetRevisionProperties | | public Map doGetRevisionProperties(File repositoryRoot, String transactionName) throws SVNException(Code) | | Returns revision properties for the given transaction.
Parameters:
repositoryRoot - a repository root directory path
Parameters:
transactionName - a transaction name name (String) to value (String) mappings
throws:
SVNException - - no repository is found at
repositoryRoot - if the specified transaction is not found
|
| doGetRevisionProperty | | public String doGetRevisionProperty(File repositoryRoot, String propName, SVNRevision revision) throws SVNException(Code) | | Returns the value of a revision property in the given revision.
Parameters:
repositoryRoot - a repository root directory path
Parameters:
propName - a property name
Parameters:
revision - a revision number the value of a revision property
throws:
SVNException - no repository is found at repositoryRoot |
| doGetRevisionProperty | | public String doGetRevisionProperty(File repositoryRoot, String propName, String transactionName) throws SVNException(Code) | | Returns the value of a revision property for the given transaction.
Parameters:
repositoryRoot - a repository root directory path
Parameters:
propName - a property name
Parameters:
transactionName - a transaction name the value of a revision property
throws:
SVNException - - no repository is found at
repositoryRoot - if the specified transaction is not found
|
| doGetTree | | public void doGetTree(File repositoryRoot, String path, SVNRevision revision, boolean includeIDs, ISVNTreeHandler handler) throws SVNException(Code) | | Traverses repository tree starting at the specified path in the
given revision and invoking the provided handler on each path.
Path information is provided as
SVNAdminPath objects and
include the following pieces:
For tree retrieval only these listed get methods of SVNAdminPath are
relevant.
path must be absolute, that is it must start with '/'.
If path is null it defaults to
"/".
Parameters:
repositoryRoot - a repository root directory path
Parameters:
path - an absolute path
Parameters:
revision - a revision number
Parameters:
includeIDs - if true a node revision id is also included for each path
Parameters:
handler - a tree handler
throws:
SVNException - - no repository is found at
repositoryRoot - if
path is not found
|
| doGetTree | | public void doGetTree(File repositoryRoot, String path, String transactionName, boolean includeIDs, ISVNTreeHandler handler) throws SVNException(Code) | | Traverses repository tree starting at the specified path in the
given transaction and invoking the provided handler on each path.
Path information is provided as
SVNAdminPath objects and
include the following pieces:
For tree retrieval only these listed get methods of SVNAdminPath are
relevant.
path must be absolute, that is it must start with '/'.
If path is null it defaults to
"/".
Parameters:
repositoryRoot - a repository root directory path
Parameters:
path - an absolute path
Parameters:
transactionName - a transaction name
Parameters:
includeIDs - if true a node revision id is also included for each path
Parameters:
handler - a tree handler
throws:
SVNException - - no repository is found at
repositoryRoot - if
path is not found - if the specified transaction is not found
|
| doGetUUID | | public String doGetUUID(File repositoryRoot) throws SVNException(Code) | | Returns the uuid of the repository.
Parameters:
repositoryRoot - a repository root directory path an uuid
throws:
SVNException - no repository is found at repositoryRoot |
| doGetYoungestRevision | | public long doGetYoungestRevision(File repositoryRoot) throws SVNException(Code) | | Returns the latest revision of the repository.
Parameters:
repositoryRoot - a repository root directory path a revision number
throws:
SVNException - no repository is found at repositoryRoot |
| Methods inherited from org.tmatesoft.svn.core.wc.SVNBasicClient | public void checkCancelled() throws SVNCancelException(Code)(Java Doc)
protected SVNRepository createRepository(SVNURL url, boolean mayReuse) throws SVNException(Code)(Java Doc)
protected SVNRepository createRepository(SVNURL url, File path, SVNRevision pegRevision, SVNRevision revision) throws SVNException(Code)(Java Doc)
protected SVNRepository createRepository(SVNURL url, File path, SVNRevision pegRevision, SVNRevision revision, long[] pegRev) throws SVNException(Code)(Java Doc)
protected SVNWCAccess createWCAccess()(Code)(Java Doc)
protected SVNWCAccess createWCAccess(String pathPrefix)(Code)(Java Doc)
protected void dispatchEvent(SVNEvent event) throws SVNException(Code)(Java Doc)
protected void dispatchEvent(SVNEvent event, double progress) throws SVNException(Code)(Java Doc)
public ISVNDebugLog getDebugLog()(Code)(Java Doc)
protected ISVNEventHandler getEventDispatcher()(Code)(Java Doc)
protected SVNRepositoryLocation[] getLocations(SVNURL url, File path, SVNRepository repository, SVNRevision revision, SVNRevision start, SVNRevision end) throws SVNException(Code)(Java Doc)
public ISVNOptions getOptions()(Code)(Java Doc)
protected ISVNRepositoryPool getRepositoryPool()(Code)(Java Doc)
protected long getRevisionNumber(SVNRevision revision, SVNRepository repository, File path) throws SVNException(Code)(Java Doc)
protected SVNURL getURL(File path) throws SVNException(Code)(Java Doc)
public void handleEvent(SVNEvent event, double progress) throws SVNException(Code)(Java Doc)
public boolean isIgnoreExternals()(Code)(Java Doc)
public boolean isLeaveConflictsUnresolved()(Code)(Java Doc)
public void setDebugLog(ISVNDebugLog log)(Code)(Java Doc)
public void setEventHandler(ISVNEventHandler dispatcher)(Code)(Java Doc)
public void setEventPathPrefix(String prefix)(Code)(Java Doc)
public void setIgnoreExternals(boolean ignore)(Code)(Java Doc)
public void setLeaveConflictsUnresolved(boolean leave)(Code)(Java Doc)
public void setOptions(ISVNOptions options)(Code)(Java Doc)
protected void sleepForTimeStamp()(Code)(Java Doc)
|
|
|