org.apache.subversion.javahl.types
Class Status

java.lang.Object
  org.apache.subversion.javahl.types.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, String url, NodeKind nodeKind, long revision, long lastChangedRevision, long lastChangedDate, String lastCommitAuthor, Status.Kind textStatus, Status.Kind propStatus, Status.Kind repositoryTextStatus, Status.Kind repositoryPropStatus, boolean locked, boolean copied, boolean isConflicted, boolean switched, boolean fileExternal, Lock localLock, Lock reposLock, long reposLastCmtRevision, long reposLastCmtDate, NodeKind reposKind, String reposLastCmtAuthor, String changelist)
this constructor should only called from JNI code

Method Summary

String	getChangelist()
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
Lock	getLocalLock() Returns the local lock
NodeKind	getNodeKind() Returns the kind of the node (file, directory or unknown, see NodeKind)
String	getPath() Returns the file system path of the item
Status.Kind	getPropStatus() Returns the status of the properties (See Status Kind)
String	getPropStatusDescription() Returns the status of the properties as text
Status.Kind	getRepositoryPropStatus() Returns test status of the properties in the repository (See StatusKind)
Status.Kind	getRepositoryTextStatus() Returns the status of the item in the repository (See StatusKind)
NodeKind	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
long	getRevisionNumber() Returns the revision as a long integer
Status.Kind	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.
boolean	hasRemote() Returns if the resource has a remote counter-part
boolean	isAdded() Returns if the resource just has been added
boolean	isConflicted()
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,
              NodeKind nodeKind,
              long revision,
              long lastChangedRevision,
              long lastChangedDate,
              String lastCommitAuthor,
              Status.Kind textStatus,
              Status.Kind propStatus,
              Status.Kind repositoryTextStatus,
              Status.Kind repositoryPropStatus,
              boolean locked,
              boolean copied,
              boolean isConflicted,
              boolean switched,
              boolean fileExternal,
              Lock localLock,
              Lock reposLock,
              long reposLastCmtRevision,
              long reposLastCmtDate,
              NodeKind 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

isConflicted - if the item is part of a 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

switched - flag if the node has been switched in the path

fileExternal - flag if the node is a file external

localLock - the current lock

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

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.

getLastCommitAuthor

public String getLastCommitAuthor()

Returns the author of the last changed or null

Returns:

name of author if versioned, null otherwise

getTextStatus

public Status.Kind 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 Status.Kind 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 Status.Kind 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 Status.Kind 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

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 NodeKind getNodeKind()

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

Returns:

the node kind

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

getLocalLock

public Lock getLocalLock()

Returns the local lock

Returns:

the local lock

getReposLock

public Lock getReposLock()

Returns the lock as in the repository

Returns:

the lock as in the repository

getReposLastCmtRevision

public Revision.Number getReposLastCmtRevision()

Returns:

The last committed revision, or Revision.SVN_INVALID_REVNUM if up to date.

getReposLastCmtRevisionNumber

public long getReposLastCmtRevisionNumber()

Returns:

The last committed revision as a long integer, or -1 if up to date.

getReposLastCmtDate

public Date getReposLastCmtDate()

Returns:

The last committed date, or null if up to date.

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

getReposKind

public NodeKind getReposKind()

Returns:

The node kind (e.g. file, directory, etc.), or null if up to date.

getReposLastCmtAuthor

public String getReposLastCmtAuthor()

Returns:

The author of the last commit, or null if up to date.

getChangelist

public String getChangelist()

Returns:

the changelist name

isConflicted

public boolean isConflicted()

Returns:

the conflicted state