com.perforce.p4java.core
Interface IDepot

All Superinterfaces:

IServerResource

All Known Implementing Classes:

Depot

public interface IDepot
extends IServerResource

Provides an interface onto, and a set of methods to access a specific Perforce depot contained in a Perforce server. See the main Perforce documentation and help system for a full discussion of depots and associated metadata and usage models.

IDepot objects are not updateable or refreshable, and are currently "complete" in all implementations. There are no setter methods here as depots are intentionally read-only in P4Java.

Nested Class Summary

static class

IDepot.DepotType

Method Summary

String	getAddress() For remote depots, return the (remote) address of the depot; for other types of depot, will return null.
IDepot.DepotType	getDepotType() Get the type of this depot.
String	getDescription() Get the description associated with this depot.
String	getMap() Get the depot's path translation information.
Date	getModDate() Get the date the depot was last modified.
String	getName() Get the name of the depot.
String	getOwnerName() Get the Perforce user name of the depot's owner.
ViewMap<IMapEntry>	getSpecMap() For spec depots, the optional description of which specs should be saved, as one or more patterns.
String	getStreamDepth() For stream depots, the optional depth to be used for stream paths in the depot, where depth equates to the number of slashes following the depot name of a stream.
String	getSuffix() For spec depots, the optional suffix to be used for generated paths.

Methods inherited from interface com.perforce.p4java.core.IServerResource

canRefresh, canUpdate, refresh, setServer, update, update, update

Method Detail

getName

String getName()

Get the name of the depot.

getOwnerName

String getOwnerName()

Get the Perforce user name of the depot's owner.

getModDate

Date getModDate()

Get the date the depot was last modified.

getDescription

String getDescription()

Get the description associated with this depot.

getDepotType

IDepot.DepotType getDepotType()

Get the type of this depot.

getAddress

String getAddress()

For remote depots, return the (remote) address of the depot; for other types of depot, will return null.

getSuffix

String getSuffix()

For spec depots, the optional suffix to be used for generated paths. The default is '.p4s'.

getStreamDepth

String getStreamDepth()

For stream depots, the optional depth to be used for stream paths in the depot, where depth equates to the number of slashes following the depot name of a stream. This field is referenced when streams are being created. The default is '1', matching the traditional stream name. For example, "//stream_test/1". This value may not be updated once streams or archive data exist within the depot.

getMap

String getMap()

Get the depot's path translation information.

getSpecMap

ViewMap<IMapEntry> getSpecMap()

For spec depots, the optional description of which specs should be saved, as one or more patterns. See example below.

 //spec/...
 -//spec/user/qa-*
 -//spec/client/qa-*