|
SVNKit Home | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.tmatesoft.svn.core.wc.SVNBasicClient
org.tmatesoft.svn.core.wc.admin.SVNLookClient
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' |
Nested Class Summary |
Nested classes inherited from class org.tmatesoft.svn.core.wc.SVNBasicClient |
SVNBasicClient.RepositoryReference, SVNBasicClient.SVNRepositoryLocation |
Field Summary |
Fields inherited from interface org.tmatesoft.svn.core.wc.ISVNEventHandler |
UNKNOWN |
Fields inherited from interface org.tmatesoft.svn.core.ISVNCanceller |
NULL |
Constructor Summary | |
SVNLookClient(ISVNAuthenticationManager authManager,
ISVNOptions options)
Creates a new instance of SVNLookClient given an authentication manager and global options keeper. |
|
SVNLookClient(ISVNRepositoryPool repositoryPool,
ISVNOptions options)
Creates a new instance of SVNLookClient given an SVNRepository }
drivers provider and global options keeper. |
Method Summary | |
void |
doCat(File repositoryRoot,
String path,
String transactionName,
OutputStream out)
Fetches file contents for the specified path in the given transaction. |
void |
doCat(File repositoryRoot,
String path,
SVNRevision revision,
OutputStream out)
Fetches file contents for the specified revision and path. |
String |
doGetAuthor(File repositoryRoot,
String transactionName)
Returns author information for the given transaction. |
String |
doGetAuthor(File repositoryRoot,
SVNRevision revision)
Returns author information for the given revision. |
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. |
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. |
void |
doGetChangedDirectories(File repositoryRoot,
String transactionName,
ISVNChangedDirectoriesHandler handler)
Passes paths of directories changed in the given transaction to the provided handler. |
void |
doGetChangedDirectories(File repositoryRoot,
SVNRevision revision,
ISVNChangedDirectoriesHandler handler)
Passes paths of directories changed in the given revision to the provided handler. |
Date |
doGetDate(File repositoryRoot,
String transactionName)
Returns datestamp information for the given transaction. |
Date |
doGetDate(File repositoryRoot,
SVNRevision revision)
Returns datestamp information for the given revision. |
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. |
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. |
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. |
SVNLogEntry |
doGetInfo(File repositoryRoot,
String transactionName)
Retrieves author, timestamp and log message information from the repository for the given transaction name. |
SVNLogEntry |
doGetInfo(File repositoryRoot,
SVNRevision revision)
Retrieves author, timestamp and log message information from the repository for the given revision. |
SVNLock |
doGetLock(File repositoryRoot,
String path)
Retrieves lock information for the specified path. |
String |
doGetLog(File repositoryRoot,
String transactionName)
Returns log information for the given transaction. |
String |
doGetLog(File repositoryRoot,
SVNRevision revision)
Returns log information for the given revision. |
Map |
doGetProperties(File repositoryRoot,
String path,
String transactionName)
Returns versioned properties for the specified path in the given transaction. |
Map |
doGetProperties(File repositoryRoot,
String path,
SVNRevision revision)
Returns versioned properties for the specified path in the given revision. |
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. |
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. |
Map |
doGetRevisionProperties(File repositoryRoot,
String transactionName)
Returns revision properties for the given transaction. |
Map |
doGetRevisionProperties(File repositoryRoot,
SVNRevision revision)
Returns revision properties in the given revision. |
String |
doGetRevisionProperty(File repositoryRoot,
String propName,
String transactionName)
Returns the value of a revision property for the given transaction. |
String |
doGetRevisionProperty(File repositoryRoot,
String propName,
SVNRevision revision)
Returns the value of a revision property in the given revision. |
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. |
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. |
String |
doGetUUID(File repositoryRoot)
Returns the uuid of the repository. |
long |
doGetYoungestRevision(File repositoryRoot)
Returns the latest revision of the repository. |
ISVNGNUDiffGenerator |
getDiffGenerator()
Returns a diff generator to be used in doGetDiff() methods of this class.
|
void |
setDiffGenerator(ISVNGNUDiffGenerator diffGenerator)
Sets a diff generator to be used in doGetDiff() methods of this class. |
Methods inherited from class org.tmatesoft.svn.core.wc.SVNBasicClient |
checkCancelled, createRepository, createRepository, createRepository, createWCAccess, createWCAccess, dispatchEvent, dispatchEvent, getDebugLog, getEventDispatcher, getLocations, getOptions, getRepositoryPool, getRevisionNumber, getURL, handleEvent, isIgnoreExternals, isLeaveConflictsUnresolved, setDebugLog, setEventHandler, setEventPathPrefix, setIgnoreExternals, setLeaveConflictsUnresolved, setOptions, sleepForTimeStamp |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public SVNLookClient(ISVNAuthenticationManager authManager, ISVNOptions options)
authManager
- a manager which provides authentication
credentialsoptions
- a global config options providerpublic SVNLookClient(ISVNRepositoryPool repositoryPool, ISVNOptions options)
SVNRepository
}
drivers provider and global options keeper.
repositoryPool
- a repository connectors keeperoptions
- a global config options providerMethod Detail |
public SVNLogEntry doGetInfo(File repositoryRoot, SVNRevision revision) throws SVNException
SVNLogEntry
object, that is only the following methods of SVNLogEntry
return valid information:
repositoryRoot
- a repository root directory pathrevision
- a revision number
SVNException
- no repository is found at
repositoryRoot
public SVNLogEntry doGetInfo(File repositoryRoot, String transactionName) throws SVNException
SVNLogEntry
object, that is only the following methods of SVNLogEntry
return valid information:
repositoryRoot
- a repository root directory pathtransactionName
- a transaction name
SVNException
- repositoryRoot
public long doGetYoungestRevision(File repositoryRoot) throws SVNException
repositoryRoot
- a repository root directory path
SVNException
- no repository is found at
repositoryRoot
public String doGetUUID(File repositoryRoot) throws SVNException
repositoryRoot
- a repository root directory path
SVNException
- no repository is found at
repositoryRoot
public String doGetAuthor(File repositoryRoot, SVNRevision revision) throws SVNException
repositoryRoot
- a repository root directory pathrevision
- a revision number
SVNException
- no repository is found at
repositoryRoot
public String doGetAuthor(File repositoryRoot, String transactionName) throws SVNException
repositoryRoot
- a repository root directory pathtransactionName
- a transaction name
SVNException
- repositoryRoot
public void doCat(File repositoryRoot, String path, SVNRevision revision, OutputStream out) throws SVNException
path
must be absolute, that is it must
start with '/'
. The provided output stream is
not closed within this method.
repositoryRoot
- a repository root directory pathpath
- an absolute file pathrevision
- a revision numberout
- an output stream to write contents to
SVNException
- repositoryRoot
path
is not found or
is not a file
public void doCat(File repositoryRoot, String path, String transactionName, OutputStream out) throws SVNException
path
must be absolute, that is it
must start with '/'
. The provided output stream
is not closed within this method.
repositoryRoot
- a repository root directory pathpath
- an absolute file pathtransactionName
- a transaction nameout
- an output stream to write contents to
SVNException
- repositoryRoot
path
is not found or
is not a file
public Date doGetDate(File repositoryRoot, SVNRevision revision) throws SVNException
repositoryRoot
- a repository root directory pathrevision
- a revision number
SVNException
- no repository is found at
repositoryRoot
public Date doGetDate(File repositoryRoot, String transactionName) throws SVNException
repositoryRoot
- a repository root directory pathtransactionName
- a transaction name
SVNException
- repositoryRoot
public String doGetLog(File repositoryRoot, SVNRevision revision) throws SVNException
repositoryRoot
- a repository root directory pathrevision
- a revision number
SVNException
- no repository is found at
repositoryRoot
public String doGetLog(File repositoryRoot, String transactionName) throws SVNException
repositoryRoot
- a repository root directory pathtransactionName
- a transaction name
SVNException
- repositoryRoot
public void doGetChanged(File repositoryRoot, SVNRevision revision, ISVNChangeEntryHandler handler, boolean includeCopyInfo) throws SVNException
repositoryRoot
- a repository root directory pathrevision
- a revision numberhandler
- a changed path handlerincludeCopyInfo
- if true copy-from
information is also provided for copied paths
SVNException
- no repository is found at
repositoryRoot
public void doGetChanged(File repositoryRoot, String transactionName, ISVNChangeEntryHandler handler, boolean includeCopyInfo) throws SVNException
repositoryRoot
- a repository root directory pathtransactionName
- a transaction namehandler
- a changed path handlerincludeCopyInfo
- if true copy-from
information is also provided for copied paths
SVNException
- repositoryRoot
public void doGetChangedDirectories(File repositoryRoot, SVNRevision revision, ISVNChangedDirectoriesHandler handler) throws SVNException
'/'
).
repositoryRoot
- a repository root directory pathrevision
- a revision numberhandler
- a path handler
SVNException
- no repository is found at
repositoryRoot
public void doGetChangedDirectories(File repositoryRoot, String transactionName, ISVNChangedDirectoriesHandler handler) throws SVNException
'/'
).
repositoryRoot
- a repository root directory pathtransactionName
- a transaction namehandler
- a path handler
SVNException
- repositoryRoot
public void doGetHistory(File repositoryRoot, String path, SVNRevision revision, boolean includeIDs, ISVNHistoryHandler handler) throws SVNException
SVNAdminPath
objects and include the following
pieces:
SVNAdminPath.getPath()
to retrieve it)SVNAdminPath.getRevision()
to retrieve it)SVNAdminPath.getNodeID()
to retrieve it)get
methods of SVNAdminPath are
relevant.
path
must be absolute, that is it must start with '/'
.
If path
is null it defaults to
"/"
.
repositoryRoot
- a repository root directory pathpath
- an absolute pathrevision
- a revision numberincludeIDs
- if true a node
revision id is also included for each pathhandler
- a history handler
SVNException
- repositoryRoot
path
is not found
public SVNLock doGetLock(File repositoryRoot, String path) throws SVNException
path
must be absolute, that is it must start with '/'
.
repositoryRoot
- a repository root directory pathpath
- an absolute path
SVNException
- repositoryRoot
path
is not found
public void doGetTree(File repositoryRoot, String path, SVNRevision revision, boolean includeIDs, ISVNTreeHandler handler) throws SVNException
SVNAdminPath
objects and
include the following pieces:
SVNAdminPath.getPath()
to retrieve it)SVNAdminPath.getTreeDepth()
to retrieve it)SVNAdminPath.getNodeID()
to retrieve it)SVNAdminPath.isDir()
to retrieve it)get
methods of SVNAdminPath are
relevant.
path
must be absolute, that is it must start with '/'
.
If path
is null it defaults to
"/"
.
repositoryRoot
- a repository root directory pathpath
- an absolute pathrevision
- a revision numberincludeIDs
- if true a node
revision id is also included for each pathhandler
- a tree handler
SVNException
- repositoryRoot
path
is not found
public void doGetTree(File repositoryRoot, String path, String transactionName, boolean includeIDs, ISVNTreeHandler handler) throws SVNException
SVNAdminPath
objects and
include the following pieces:
SVNAdminPath.getPath()
to retrieve it)SVNAdminPath.getTreeDepth()
to retrieve it)SVNAdminPath.getNodeID()
to retrieve it)SVNAdminPath.isDir()
to retrieve it)get
methods of SVNAdminPath are
relevant.
path
must be absolute, that is it must start with '/'
.
If path
is null it defaults to
"/"
.
repositoryRoot
- a repository root directory pathpath
- an absolute pathtransactionName
- a transaction nameincludeIDs
- if true a node
revision id is also included for each pathhandler
- a tree handler
SVNException
- repositoryRoot
path
is not found
public void doGetDiff(File repositoryRoot, SVNRevision revision, boolean diffDeleted, boolean diffAdded, boolean diffCopyFrom, OutputStream os) throws SVNException
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.
repositoryRoot
- a repository root directory pathrevision
- a revision numberdiffDeleted
- if true
differences for deleted files are included,
otherwise notdiffAdded
- if true
differences for added files are included,
otherwise notdiffCopyFrom
- if true
writes differences against the copy source
(if any), otherwise notos
- an output stream to write differences to
SVNException
- no repository is found at
repositoryRoot
public void doGetDiff(File repositoryRoot, String transactionName, boolean diffDeleted, boolean diffAdded, boolean diffCopyFrom, OutputStream os) throws SVNException
was provided
to
this client a default GNU-style diff generator is used (which
writes differences just like the 'svnlook diff'
command).
repositoryRoot
- a repository root directory pathtransactionName
- a transaction namediffDeleted
- if true
differences for deleted files are included,
otherwise notdiffAdded
- if true
differences for added files are included,
otherwise notdiffCopyFrom
- if true
writes differences against the copy source
(if any), otherwise notos
- an output stream to write differences to
SVNException
- repositoryRoot
public String doGetProperty(File repositoryRoot, String propName, String path, SVNRevision revision) throws SVNException
path
must be absolute, that is it must start with '/'
.
repositoryRoot
- a repository root directory pathpropName
- a property namepath
- an absolute pathrevision
- a revision number
SVNException
- repositoryRoot
path
is not found
public Map doGetProperties(File repositoryRoot, String path, SVNRevision revision) throws SVNException
path
must be absolute, that is it must start with '/'
.
repositoryRoot
- a repository root directory pathpath
- an absolute pathrevision
- a revision number
SVNException
- repositoryRoot
path
is not found
public String doGetProperty(File repositoryRoot, String propName, String path, String transactionName) throws SVNException
path
must be absolute, that is it must start with '/'
.
repositoryRoot
- a repository root directory pathpropName
- a property namepath
- an absolute pathtransactionName
- a transaction name
SVNException
- repositoryRoot
path
is not found
public Map doGetProperties(File repositoryRoot, String path, String transactionName) throws SVNException
path
must be absolute, that is it must start with '/'
.
repositoryRoot
- a repository root directory pathpath
- an absolute pathtransactionName
- a transaction name
SVNException
- repositoryRoot
path
is not found
public String doGetRevisionProperty(File repositoryRoot, String propName, SVNRevision revision) throws SVNException
repositoryRoot
- a repository root directory pathpropName
- a property namerevision
- a revision number
SVNException
- no repository is found at
repositoryRoot
public Map doGetRevisionProperties(File repositoryRoot, SVNRevision revision) throws SVNException
repositoryRoot
- a repository root directory pathrevision
- a revision number
SVNException
- no repository is found at
repositoryRoot
public String doGetRevisionProperty(File repositoryRoot, String propName, String transactionName) throws SVNException
repositoryRoot
- a repository root directory pathpropName
- a property nametransactionName
- a transaction name
SVNException
- repositoryRoot
public Map doGetRevisionProperties(File repositoryRoot, String transactionName) throws SVNException
repositoryRoot
- a repository root directory pathtransactionName
- a transaction name
SVNException
- repositoryRoot
public void setDiffGenerator(ISVNGNUDiffGenerator diffGenerator)
doGetDiff()
methods of this class.
diffGenerator
- getDiffGenerator()
public ISVNGNUDiffGenerator getDiffGenerator()
doGetDiff()
methods of this class.
If no generator was provided by a caller, SVNLookClient uses a default one
that prints differences in a GNU-style.
setDiffGenerator(ISVNGNUDiffGenerator)
|
SVNKit Home | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |