org.tmatesoft.svn.core.wc.admin
Class SVNAdminPath

java.lang.Object
  org.tmatesoft.svn.core.wc.admin.SVNAdminPath

public class SVNAdminPath
extends java.lang.Object

The SVNAdminPath is used to pass path information to ISVNHistoryHandler and ISVNTreeHandler

Since:

1.2

Constructor Summary

SVNAdminPath(java.lang.String path, java.lang.String nodeID, int treeDepth, boolean isDir)
Constructs a new instance of this class that is intended for ISVNTreeHandler.

SVNAdminPath(java.lang.String path, java.lang.String nodeID, long revision)
Constructs a new instance of this class that is intended for ISVNHistoryHandler.

Method Summary

java.lang.String	getNodeID() Returns a node revision id.
java.lang.String	getPath() Returns an absolute path.
long	getRevision() Returns a revision number.
int	getTreeDepth() Returns a tree depth for this path which is relative to the depth of the SVNLookClient.doGetTree(...)
boolean	isDir() Says whether path is a directory or a file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SVNAdminPath

public SVNAdminPath(java.lang.String path,
                    java.lang.String nodeID,
                    long revision)

Constructs a new instance of this class that is intended for ISVNHistoryHandler.

Parameters:

path - an absolute repository path

nodeID - a node revision id (optional)

revision - a revision

SVNAdminPath

public SVNAdminPath(java.lang.String path,
                    java.lang.String nodeID,
                    int treeDepth,
                    boolean isDir)

Constructs a new instance of this class that is intended for ISVNTreeHandler.

Parameters:

path - an absolute repository path

nodeID - a node revision id (optional)

treeDepth - the depth at which path is located in the tree

isDir - says whether path is a directory or a file

Method Detail

isDir

public boolean isDir()

Says whether path is a directory or a file. This information is relevant only for ISVNTreeHandler.

Returns:

true for a directory, false for a file

getNodeID

public java.lang.String getNodeID()

Returns a node revision id. This information is relevant for both ISVNTreeHandler and ISVNHistoryHandler.

Returns:

a node revision id

getPath

public java.lang.String getPath()

Returns an absolute path.

Returns:

an absolute path that starts with '/'

getRevision

public long getRevision()

Returns a revision number. This information is relevant only for ISVNHistoryHandler.

Returns:

a revision number

getTreeDepth

public int getTreeDepth()

Returns a tree depth for this path which is relative to the depth of the SVNLookClient.doGetTree(...) target path. Target path which is passed to SVNLookClient.doGetTree(...) starts at depth 0. Then depth is incremented with every other segment of path.

This information is relevant only for ISVNTreeHandler.

Returns:

a tree depth