Package org.tmatesoft.svn.core.wc
Class SVNInfo
java.lang.Object
org.tmatesoft.svn.core.wc.SVNInfo
The SVNInfo class is a wrapper for versioned item's (located either
in a Working Copy or a repository) information details. When running an
info operation invoking a doInfo() method of the SVNWCClient class
all collected item information data is packed inside an SVNInfo object
and depending on the exact doInfo() method being in use is either dispatched to
an implementation of ISVNInfoHandler or just returned by the method (per
single item info operation).
...and providing an info handler implementation to an SVNWCClient's doInfo() method:
2. Or process an SVNInfo like this:
There are two approaches how to process SVNInfo objects:
1. Implementing an ISVNInfoHandler:
import org.tmatesoft.svn.core.wc.ISVNInfoHandler; import org.tmatesoft.svn.core.wc.SVNInfo; ... public class MyCustomInfoHandler implements ISVNInfoHandler { public void handleInfo(SVNInfo info) { //parsing info here ... } }
...and providing an info handler implementation to an SVNWCClient's doInfo() method:
... import org.tmatesoft.svn.core.wc.SVNWCClient; ... SVNWCClient wcClient; ... wcClient.doInfo(...., new MyCustomInfoHandler()); ...
2. Or process an SVNInfo like this:
... SVNInfo info = wcClient.doInfo(new File(myPath), SVNRevision.WORKING); //parsing info here ...
- Since:
- 1.2
- Version:
- 1.3
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
private String
private String
private Date
private SVNRevision
private File
private File
private File
private SVNRevision
private SVNURL
private SVNDepth
private File
private boolean
private SVNNodeKind
private SVNLock
private File
private File
private String
private File
private Date
private SVNURL
private long
private String
private SVNRevision
private String
private Date
private SVNTreeConflictDescription
private SVNURL
private File
private long
-
Constructor Summary
ConstructorsConstructorDescriptionSVNInfo
(File file, SVNURL url, SVNURL rootURL, long revision, SVNNodeKind kind, String uuid, long committedRevision, String committedDate, String author, String schedule, SVNURL copyFromURL, long copyFromRevision, String textTime, String propTime, String checksum, String conflictOld, String conflictNew, String conflictWorking, String propRejectFile, SVNLock lock, SVNDepth depth, String changelistName, long wcSize, SVNTreeConflictDescription treeConflict) SVNInfo
(String path, SVNURL url, SVNRevision revision, SVNNodeKind kind, String uuid, SVNURL reposRootURL, long comittedRevision, Date date, String author, SVNLock lock, SVNDepth depth, long size) -
Method Summary
Modifier and TypeMethodDescriptionstatic SVNInfo
createInfo
(File file, SVNEntry entry) static SVNInfo
createInfo
(File file, SVNTreeConflictDescription tc) static SVNInfo
createInfo
(String path, SVNURL reposRootURL, String uuid, SVNURL url, SVNRevision revision, SVNDirEntry dirEntry, SVNLock lock) Gets the item's last commit author.Gets the name of the changelist the item belongs to.Gets the file item's checksum.Gets the item's last commit date.Gets the item's last committed revision.Gets the temporary file that contains all latest changes from the repository which led to a conflict with local changes.Gets the temporary BASE revision file of that working file that is currently in conflict with changes received from the repository.Gets the temporary '.mine' file with all current local changes to the original file.Gets the revision of the item's ancestor from which the item was copied.Gets the URL (repository location) of the ancestor from which the item was copied.getDepth()
Gets the item's depth.getFile()
Gets the item's local path.getKind()
Gets the item's node kind.getLock()
Gets the file item's lock.getPath()
Gets the item's path (relative to the repository root).Gets the '.prej' file containing details on properties conflicts.Gets the value of the item'sSVNProperty.PROP_TIME
property.Gets the repository root url (where the repository itself is installed).long
Returns the size of the file in the repository.Gets the repository Universal Unique IDentifier (UUID).Gets the item's revision.Gets the item's schedule status.Gets the value of the item'sSVNProperty.TEXT_TIME
property.Returns a tree conflict description on the item represented by this object.getURL()
Gets the item's URL - its repository location.long
Returns the size of the working copy file.boolean
isRemote()
Finds out whether the item for which this SVNInfo is generated is local (located in a user's Working Copy) or remote (located in a repository).void
setMovedFromPath
(File movedFrom) void
setMovedToPath
(File movedTo) void
setWorkingCopyRoot
(File root)
-
Field Details
-
myFile
-
myPath
-
myURL
-
myRevision
-
myKind
-
myRepositoryRootURL
-
myRepositoryUUID
-
myCommittedRevision
-
myCommittedDate
-
myAuthor
-
myLock
-
myIsRemote
private boolean myIsRemote -
mySchedule
-
myCopyFromURL
-
myCopyFromRevision
-
myTextTime
-
myPropTime
-
myChecksum
-
myConflictOldFile
-
myConflictNewFile
-
myConflictWrkFile
-
myPropConflictFile
-
myDepth
-
myChangelistName
-
myWorkingSize
private long myWorkingSize -
myRepositorySize
private long myRepositorySize -
myTreeConflict
-
myWorkingCopyRoot
-
myMovedFromPath
-
myMovedToPath
-
-
Constructor Details
-
SVNInfo
public SVNInfo(File file, SVNURL url, SVNURL rootURL, long revision, SVNNodeKind kind, String uuid, long committedRevision, String committedDate, String author, String schedule, SVNURL copyFromURL, long copyFromRevision, String textTime, String propTime, String checksum, String conflictOld, String conflictNew, String conflictWorking, String propRejectFile, SVNLock lock, SVNDepth depth, String changelistName, long wcSize, SVNTreeConflictDescription treeConflict) -
SVNInfo
public SVNInfo(String path, SVNURL url, SVNRevision revision, SVNNodeKind kind, String uuid, SVNURL reposRootURL, long comittedRevision, Date date, String author, SVNLock lock, SVNDepth depth, long size)
-
-
Method Details
-
createInfo
- Throws:
SVNException
-
createInfo
-
createInfo
public static SVNInfo createInfo(String path, SVNURL reposRootURL, String uuid, SVNURL url, SVNRevision revision, SVNDirEntry dirEntry, SVNLock lock) -
getAuthor
Gets the item's last commit author. This is the value of the item'sSVNProperty.LAST_AUTHOR
property.- Returns:
- the author who last changed (committed) the item
-
getChecksum
Gets the file item's checksum. This is the value of the file item'sSVNProperty.CHECKSUM
property.- Returns:
- the file item's checksum
-
getCommittedDate
Gets the item's last commit date. This is the value of the item'sSVNProperty.COMMITTED_DATE
property.- Returns:
- the item's last commit date
-
getCommittedRevision
Gets the item's last committed revision. This is the value of the item'sSVNProperty.COMMITTED_REVISION
property.- Returns:
- the item's last committed revision.
-
getConflictNewFile
Gets the temporary file that contains all latest changes from the repository which led to a conflict with local changes. This file is at the HEAD revision.Taken from the item's
SVNProperty.CONFLICT_NEW
property.- Returns:
- an autogenerated temporary file just as it is in the latest revision in the repository
-
getConflictOldFile
Gets the temporary BASE revision file of that working file that is currently in conflict with changes received from the repository. This file does not contain the latest user's modifications, only 'pristine' contents.Taken from the item's
SVNProperty.CONFLICT_OLD
property.- Returns:
- an autogenerated temporary file just as the conflicting file was before any modifications to it
-
getConflictWrkFile
Gets the temporary '.mine' file with all current local changes to the original file. That is if the file item is in conflict with changes that came during an update this temporary file is created to get the snapshot of the user's file with only the user's local modifications and nothing more.Taken from the item's
SVNProperty.CONFLICT_WRK
property.- Returns:
- an autogenerated temporary file with only the user's modifications
-
getTreeConflict
Returns a tree conflict description on the item represented by this object.- Returns:
- a tree conflict description object or
null
if no tree conflict exists on this item - Since:
- 1.3
-
getCopyFromRevision
Gets the revision of the item's ancestor from which the item was copied.- Returns:
- the ancestor's revision (taken from the
SVNProperty.COPYFROM_REVISION
property)
-
getCopyFromURL
Gets the URL (repository location) of the ancestor from which the item was copied.- Returns:
- the item ancestor's URL (taken from the
SVNProperty.COPYFROM_URL
property)
-
getFile
Gets the item's local path. Applicable for local info operation invocations, however if an info operation is invoked for remote items, usegetPath()
instead.- Returns:
- the item's local path
-
isRemote
public boolean isRemote()Finds out whether the item for which this SVNInfo is generated is local (located in a user's Working Copy) or remote (located in a repository). It depends on the type of an info operation to perform - that is on anSVNWCClient
's doInfo() method to use. Also applicability of some methods of the SVNInfo class depends on the item's location that can be determined calling this method.- Returns:
- true if the item is located in a repository, otherwise false and the item is in a Working Copy
-
getKind
Gets the item's node kind. Used to find out whether the item is a file, directory, etc.- Returns:
- the item's node kind
-
getLock
Gets the file item's lock. Used to get lock information - lock token, comment, etc.- Returns:
- the file item's lock.
-
getPath
Gets the item's path (relative to the repository root). Applicable for remote info operation invocations, however if an info operation is invoked for Working Copy items, usegetFile()
instead.- Returns:
- the item's path in the repository
-
getPropConflictFile
Gets the '.prej' file containing details on properties conflicts. If the item's properties are in conflict with those that came during an update this file will contain a conflict description. This is the value of the item'sSVNProperty.PROP_REJECT_FILE
property.- Returns:
- the properties conflicts file
-
getPropTime
Gets the value of the item'sSVNProperty.PROP_TIME
property. It corresponds to the last time when properties were committed.- Returns:
- the value of the item's prop-time property
-
getRepositoryRootURL
Gets the repository root url (where the repository itself is installed). Applicable only for remote info operation invocations (for items in a repository).- Returns:
- the repository's root URL
-
getRepositoryUUID
Gets the repository Universal Unique IDentifier (UUID). This is the value of theSVNProperty.UUID
property.- Returns:
- the repository UUID
-
getRevision
Gets the item's revision.- Returns:
- the item's revision
-
getSchedule
Gets the item's schedule status. Schedule status is inapplicable when running a remote info operation (for items in a repository). If it's a local info operation and the return value is null then it corresponds to the SVN's 'normal' schedule status.- Returns:
- the item's schedule status
-
getTextTime
Gets the value of the item'sSVNProperty.TEXT_TIME
property. It corresponds to the last commit time.- Returns:
- the value of the item's text-time property
-
getURL
Gets the item's URL - its repository location.- Returns:
- the item's URL
-
getDepth
Gets the item's depth.- Returns:
- depth value
- Since:
- 1.2.0, SVN 1.5.0
-
getChangelistName
Gets the name of the changelist the item belongs to.- Returns:
- changelist name
- Since:
- 1.2.0, SVN 1.5.0
-
getWorkingSize
public long getWorkingSize()Returns the size of the working copy file. Relevant for file items only.- Returns:
- working file size in bytes
- Since:
- 1.2.0, SVN 1.5.0
-
getRepositorySize
public long getRepositorySize()Returns the size of the file in the repository. Relevant for file items only and in case of a remote operation (i.e. info fetched just from the working copy will always return -1 in this method).- Returns:
- repository file size in bytes
- Since:
- 1.2.0, SVN 1.5.0
-
getWorkingCopyRoot
-
getMovedFromPath
-
getMovedToPath
-
setWorkingCopyRoot
-
setMovedFromPath
-
setMovedToPath
-