Overview Package Tree Index Deprecated About
 SVNKit Home
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.tmatesoft.svn.core

Class SVNLock

public class SVNLock
extends Object
The SVNLock class represents a file lock. It holds information on a lock path, token, owner, comment, creation and expiration dates.
Version:
1.1.1
Author:
TMate Software Ltd.
Since:
SVN 1.2
See Also:
Examples

Constructor Summary

SVNLock(String path, String id, String owner, String comment, Date created, Date expires)
Constructs an SVNLock object.

Method Summary

String
getComment()
Gets the lock comment.
Date
getCreationDate()
Gets the creation datestamp of this lock.
Date
getExpirationDate()
Gets the expiration datestamp of this lock.
String
getID()
Gets the lock token.
String
getOwner()
Gets the lock owner.
String
getPath()
Gets the path of the file for which this lock was created.
String
toString()
Returns a string representation of this object.

Constructor Details

SVNLock

public SVNLock(String path,
               String id,
               String owner,
               String comment,
               Date created,
               Date expires)
Constructs an SVNLock object.
Parameters:
path - a file path, relative to the repository root directory
id - a string token identifying the lock
owner - the owner of the lock
comment - a comment message for the lock (optional)
created - a datestamp when the lock was created
expires - a datestamp when the lock expires, i.e. the file is unlocked (optional)

Method Details

getComment

public String getComment()
Gets the lock comment.
Returns:
a lock comment message

getCreationDate

public Date getCreationDate()
Gets the creation datestamp of this lock.
Returns:
a datestamp representing the moment in time when this lock was created

getExpirationDate

public Date getExpirationDate()
Gets the expiration datestamp of this lock.
Returns:
a datestamp representing the moment in time when the this lock expires

getID

public String getID()
Gets the lock token.
Returns:
a unique string identifying this lock

getOwner

public String getOwner()
Gets the lock owner.
Returns:
the owner of this lock

getPath

public String getPath()
Gets the path of the file for which this lock was created. The path is relative to the repository root directory.
Returns:
the path of the locked file

toString

public String toString()
Returns a string representation of this object.
Returns:
a string representation of this lock object

Overview Package Tree Index Deprecated About
Copyright © 2004-2006 TMate Software Ltd. All Rights Reserved.