org.tigris.subversion.javahl
Class Status

java.lang.Object
  extended by org.tigris.subversion.javahl.Status
All Implemented Interfaces:
Serializable

public class Status
extends Object
implements Serializable

Subversion status API. This describes the status of one subversion item (file or directory) in the working copy. Will be returned by SVNClient.status or SVNClient.singleStatus

See Also:
Serialized Form

Nested Class Summary
static class Status.Kind
          class for kind status of the item or its properties the constants are defined in the interface StatusKind for building reasons
 
Constructor Summary
Status(String path)
          Create an empty status struct
Status(String path, String url, int nodeKind, long revision, long lastChangedRevision, long lastChangedDate, String lastCommitAuthor, int textStatus, int propStatus, int repositoryTextStatus, int repositoryPropStatus, boolean locked, boolean copied, boolean treeConflicted, ConflictDescriptor conflictDescriptor, String conflictOld, String conflictNew, String conflictWorking, String urlCopiedFrom, long revisionCopiedFrom, boolean switched, boolean fileExternal, String lockToken, String lockOwner, String lockComment, long lockCreationDate, Lock reposLock, long reposLastCmtRevision, long reposLastCmtDate, int reposKind, String reposLastCmtAuthor, String changelist)
          this constructor should only called from JNI code
Status(SVNClient aClient, Status aStatus)
          A backward-compat wrapper.
 
Method Summary
 String getChangelist()
           
 ConflictDescriptor getConflictDescriptor()
           
 String getConflictNew()
          Returns in case of conflict, the filename of the most recent repository version
 String getConflictOld()
          Returns in case of conflict, the filename of the common base version
 String getConflictWorking()
          Returns in case of conflict, the filename of the former working copy version
 Date getLastChangedDate()
          Returns the last date the item was changed or null
 long getLastChangedDateMicros()
          Returns the last date the item was changed measured in the number of microseconds since 00:00:00 January 1, 1970 UTC.
 Revision.Number getLastChangedRevision()
          Returns the last revision the file was changed as a Revision object
 long getLastChangedRevisionNumber()
          Returns the last revision the file was changed as a long integer
 String getLastCommitAuthor()
          Returns the author of the last changed or null
 String getLockComment()
          Returns the lock comment
 Date getLockCreationDate()
          Returns the lock creation date
 long getLockCreationDateMicros()
          Returns the lock creation date measured in the number of microseconds since 00:00:00 January 1, 1970 UTC.
 String getLockOwner()
          Returns the lock owner
 String getLockToken()
          Returns the lock token
 int getNodeKind()
          Returns the kind of the node (file, directory or unknown, see NodeKind)
 String getPath()
          Returns the file system path of the item
 int getPropStatus()
          Returns the status of the properties (See Status Kind)
 String getPropStatusDescription()
          Returns the status of the properties as text
 int getRepositoryPropStatus()
          Returns test status of the properties in the repository (See StatusKind)
 int getRepositoryTextStatus()
          Returns the status of the item in the repository (See StatusKind)
 int getReposKind()
           
 String getReposLastCmtAuthor()
           
 Date getReposLastCmtDate()
           
 long getReposLastCmtDateMicros()
          Return the last committed date measured in the number of microseconds since 00:00:00 January 1, 1970 UTC.
 Revision.Number getReposLastCmtRevision()
           
 long getReposLastCmtRevisionNumber()
           
 Lock getReposLock()
          Returns the lock as in the repository
 Revision.Number getRevision()
          Returns the revision as a Revision object
 Revision.Number getRevisionCopiedFrom()
          Returns if copied the source revision as a Revision object
 long getRevisionCopiedFromNumber()
          Returns if copied the source revision as s long integer
 long getRevisionNumber()
          Returns the revision as a long integer
 int getTextStatus()
          Returns the status of the item (See StatusKind)
 String getTextStatusDescription()
          Returns the status of the item as text.
 String getUrl()
          Returns the URI to where the item might exist in the repository.
 String getUrlCopiedFrom()
          Returns if copied the copy source url or null
 boolean hasRemote()
          Returns if the resource has a remote counter-part
 boolean hasTreeConflict()
           
 boolean isAdded()
          Returns if the resource just has been added
 boolean isCopied()
          Returns if the item has been copied
 boolean isDeleted()
          Returns if the resource is schedules for delete
 boolean isFileExternal()
          Returns if the item is a file external
 boolean isIgnored()
          Returns if the resource is ignored by svn (only returned if noIgnore is set on SVNClient.list)
 boolean isLocked()
          Returns if the item is locked (running or aborted subversion operation)
 boolean isManaged()
          Returns if is managed by svn (added, normal, modified ...)
 boolean isMerged()
          Returns if the resource has been merged
 boolean isModified()
          Returns if the resource itself is modified
 boolean isSwitched()
          Returns if the repository url has been switched
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Status

public Status(String path,
              String url,
              int nodeKind,
              long revision,
              long lastChangedRevision,
              long lastChangedDate,
              String lastCommitAuthor,
              int textStatus,
              int propStatus,
              int repositoryTextStatus,
              int repositoryPropStatus,
              boolean locked,
              boolean copied,
              boolean treeConflicted,
              ConflictDescriptor conflictDescriptor,
              String conflictOld,
              String conflictNew,
              String conflictWorking,
              String urlCopiedFrom,
              long revisionCopiedFrom,
              boolean switched,
              boolean fileExternal,
              String lockToken,
              String lockOwner,
              String lockComment,
              long lockCreationDate,
              Lock reposLock,
              long reposLastCmtRevision,
              long reposLastCmtDate,
              int reposKind,
              String reposLastCmtAuthor,
              String changelist)
this constructor should only called from JNI code

Parameters:
path - the file system path of item
url - the url of the item
nodeKind - kind of item (directory, file or unknown
revision - the revision number of the base
lastChangedRevision - the last revision this item was changed
lastChangedDate - the last date this item was changed
lastCommitAuthor - the author of the last change
textStatus - the file or directory status (See StatusKind)
propStatus - the property status (See StatusKind)
repositoryTextStatus - the file or directory status of the base
repositoryPropStatus - the property status of the base
locked - if the item is locked (running or aborted operation)
copied - if the item is copy
treeConflicted - if the item is part of a tree conflict
conflictDescriptor - the description of the tree conflict
conflictOld - in case of conflict, the file name of the the common base version
conflictNew - in case of conflict, the file name of new repository version
conflictWorking - in case of conflict, the file name of the former working copy version
urlCopiedFrom - if copied, the url of the copy source
revisionCopiedFrom - if copied, the revision number of the copy source
switched - flag if the node has been switched in the path
fileExternal - flag if the node is a file external
lockToken - the token for the current lock if any
lockOwner - the owner of the current lock is any
lockComment - the comment of the current lock if any
lockCreationDate - the date, the lock was created if any
reposLock - the lock as stored in the repository if any
reposLastCmtRevision - the youngest revision, if out of date
reposLastCmtDate - the last commit date, if out of date
reposKind - the kind of the youngest revision, if out of date
reposLastCmtAuthor - the author of the last commit, if out of date
changelist - the changelist the item is a member of

Status

public Status(String path)
Create an empty status struct


Status

public Status(SVNClient aClient,
              Status aStatus)
A backward-compat wrapper.

Method Detail

getPath

public String getPath()
Returns the file system path of the item

Returns:
path of status entry

getRevision

public Revision.Number getRevision()
Returns the revision as a Revision object

Returns:
revision if versioned, otherwise SVN_INVALID_REVNUM

getRevisionNumber

public long getRevisionNumber()
Returns the revision as a long integer

Returns:
revision if versioned, otherwise SVN_INVALID_REVNUM

getLastChangedDate

public Date getLastChangedDate()
Returns the last date the item was changed or null

Returns:
the last time the item was changed or null if not available

getLastChangedDateMicros

public long getLastChangedDateMicros()
Returns the last date the item was changed measured in the number of microseconds since 00:00:00 January 1, 1970 UTC.

Returns:
the last time the item was changed.
Since:
1.5

getLastCommitAuthor

public String getLastCommitAuthor()
Returns the author of the last changed or null

Returns:
name of author if versioned, null otherwise

getTextStatus

public int getTextStatus()
Returns the status of the item (See StatusKind)

Returns:
file status property enum of the "textual" component.

getTextStatusDescription

public String getTextStatusDescription()
Returns the status of the item as text.

Returns:
english text

getPropStatus

public int getPropStatus()
Returns the status of the properties (See Status Kind)

Returns:
file status property enum of the "property" component.

getPropStatusDescription

public String getPropStatusDescription()
Returns the status of the properties as text

Returns:
english text

getRepositoryTextStatus

public int getRepositoryTextStatus()
Returns the status of the item in the repository (See StatusKind)

Returns:
file status property enum of the "textual" component in the repository.

getRepositoryPropStatus

public int getRepositoryPropStatus()
Returns test status of the properties in the repository (See StatusKind)

Returns:
file status property enum of the "property" component im the repository.

isLocked

public boolean isLocked()
Returns if the item is locked (running or aborted subversion operation)

Returns:
true if locked

isCopied

public boolean isCopied()
Returns if the item has been copied

Returns:
true if copied

getConflictNew

public String getConflictNew()
Returns in case of conflict, the filename of the most recent repository version

Returns:
the filename of the most recent repository version

getConflictOld

public String getConflictOld()
Returns in case of conflict, the filename of the common base version

Returns:
the filename of the common base version

getConflictWorking

public String getConflictWorking()
Returns in case of conflict, the filename of the former working copy version

Returns:
the filename of the former working copy version

getUrl

public String getUrl()
Returns the URI to where the item might exist in the repository. We say "might" because the item might exist in your working copy, but have been deleted from the repository. Or it might exist in the repository, but your working copy might not yet contain it (because the WC is not up to date).

Returns:
URI in repository, or null if the item exists in neither the repository nor the WC.

getLastChangedRevision

public Revision.Number getLastChangedRevision()
Returns the last revision the file was changed as a Revision object

Returns:
last changed revision

getLastChangedRevisionNumber

public long getLastChangedRevisionNumber()
Returns the last revision the file was changed as a long integer

Returns:
last changed revision

getNodeKind

public int getNodeKind()
Returns the kind of the node (file, directory or unknown, see NodeKind)

Returns:
the node kind

getUrlCopiedFrom

public String getUrlCopiedFrom()
Returns if copied the copy source url or null

Returns:
the source url

getRevisionCopiedFrom

public Revision.Number getRevisionCopiedFrom()
Returns if copied the source revision as a Revision object

Returns:
the source revision

getRevisionCopiedFromNumber

public long getRevisionCopiedFromNumber()
Returns if copied the source revision as s long integer

Returns:
the source revision

isSwitched

public boolean isSwitched()
Returns if the repository url has been switched

Returns:
is the item has been switched

isFileExternal

public boolean isFileExternal()
Returns if the item is a file external

Returns:
is the item is a file external

isManaged

public boolean isManaged()
Returns if is managed by svn (added, normal, modified ...)

Returns:
if managed by svn

hasRemote

public boolean hasRemote()
Returns if the resource has a remote counter-part

Returns:
has version in repository

isAdded

public boolean isAdded()
Returns if the resource just has been added

Returns:
if added

isDeleted

public boolean isDeleted()
Returns if the resource is schedules for delete

Returns:
if deleted

isMerged

public boolean isMerged()
Returns if the resource has been merged

Returns:
if merged

isIgnored

public boolean isIgnored()
Returns if the resource is ignored by svn (only returned if noIgnore is set on SVNClient.list)

Returns:
if ignore

isModified

public boolean isModified()
Returns if the resource itself is modified

Returns:
if modified

getLockToken

public String getLockToken()
Returns the lock token

Returns:
the lock token
Since:
1.2

getLockOwner

public String getLockOwner()
Returns the lock owner

Returns:
the lock owner
Since:
1.2

getLockComment

public String getLockComment()
Returns the lock comment

Returns:
the lock comment
Since:
1.2

getLockCreationDate

public Date getLockCreationDate()
Returns the lock creation date

Returns:
the lock creation date
Since:
1.2

getLockCreationDateMicros

public long getLockCreationDateMicros()
Returns the lock creation date measured in the number of microseconds since 00:00:00 January 1, 1970 UTC.

Returns:
the lock creation date
Since:
1.5

getReposLock

public Lock getReposLock()
Returns the lock as in the repository

Returns:
the lock as in the repository
Since:
1.2

getReposLastCmtRevision

public Revision.Number getReposLastCmtRevision()
Returns:
The last committed revision, or Revision.SVN_INVALID_REVNUM if up to date.
Since:
1.3

getReposLastCmtRevisionNumber

public long getReposLastCmtRevisionNumber()
Returns:
The last committed revision as a long integer, or -1 if up to date.
Since:
1.3

getReposLastCmtDate

public Date getReposLastCmtDate()
Returns:
The last committed date, or null if up to date.
Since:
1.3

getReposLastCmtDateMicros

public long getReposLastCmtDateMicros()
Return the last committed date measured in the number of microseconds since 00:00:00 January 1, 1970 UTC.

Returns:
the last committed date
Since:
1.5

getReposKind

public int getReposKind()
Returns:
The node kind (e.g. file, directory, etc.), or null if up to date.
Since:
1.3

getReposLastCmtAuthor

public String getReposLastCmtAuthor()
Returns:
The author of the last commit, or null if up to date.
Since:
1.3

getChangelist

public String getChangelist()
Returns:
the changelist name
Since:
1.5

hasTreeConflict

public boolean hasTreeConflict()
Returns:
the tree conflicted state
Since:
1.6

getConflictDescriptor

public ConflictDescriptor getConflictDescriptor()
Returns:
the conflict descriptor for the tree conflict
Since:
1.6