IDepot (Perforce Java API 2015.1.1210280 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.perforce.p4java.core
Interface IDepot

All Superinterfaces:: IServerResource

All Known Implementing Classes:: Depot

public interface IDepot
extends IServerResource
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.
`String`	`getSuffix()` For spec depots, return the optional suffix (default '.p4s') for the generated paths associated with the depot; for other depot types, return null.

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, return the optional suffix (default '.p4s') for the generated paths associated with the depot; for other depot types, return null.

getMap

String getMap()

Get the depot's path translation information.