com.perforce.p4java.impl.generic.core
Class Depot

java.lang.Object
  com.perforce.p4java.impl.generic.core.ServerResource
      com.perforce.p4java.impl.generic.core.Depot

All Implemented Interfaces:

IDepot, IServerResource

public class Depot
extends ServerResource
implements IDepot

Simple default implementation class for the IDepot interface.

Version:

$Id$

Nested Class Summary

Nested classes/interfaces inherited from interface com.perforce.p4java.core.IDepot

IDepot.DepotType

Field Summary

Fields inherited from class com.perforce.p4java.impl.generic.core.ServerResource

refreshable, server, updateable

Constructor Summary

Depot()
Default constructor.

Depot(java.util.Map<java.lang.String,java.lang.Object> map)
Construct a Perforce depot object from a suitable map passed back from the Perforce server as the result of a depot list command.

Method Summary

java.lang.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.
java.lang.String	getDescription() Get the description associated with this depot.
java.lang.String	getMap() Get the depot's path translation information.
java.util.Date	getModDate() Get the date the depot was last modified.
java.lang.String	getName() Get the name of the depot.
java.lang.String	getOwnerName() Get the Perforce user name of the depot's owner.
java.lang.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.
void	setAddress(java.lang.String address)
void	setDepotType(IDepot.DepotType depotType)
void	setDescription(java.lang.String description)
void	setMap(java.lang.String map)
void	setModDate(java.util.Date modDate)
void	setName(java.lang.String name)
void	setOwnerName(java.lang.String ownerName)
void	setSuffix(java.lang.String suffix)

Methods inherited from class com.perforce.p4java.impl.generic.core.ServerResource

canRefresh, canUpdate, complete, refresh, setRefreshable, setServer, update

Methods inherited from class java.lang.Object

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

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

canRefresh, canUpdate, refresh, setServer, update

Constructor Detail

Depot

public Depot()

Default constructor. Sets up default (typically null) metadata values.

Depot

public Depot(java.util.Map<java.lang.String,java.lang.Object> map)

Construct a Perforce depot object from a suitable map passed back from the Perforce server as the result of a depot list command. This constructor is not suitable for depot maps passed back from the individual depot -o command.

Parameters:

map - map passed back from the Perforce server as a result of the depot list command; if null, fields will have default values.

Method Detail

getName

public java.lang.String getName()

Description copied from interface: IDepot

Get the name of the depot.

Specified by:

getName in interface IDepot

setName

public void setName(java.lang.String name)

getOwnerName

public java.lang.String getOwnerName()

Description copied from interface: IDepot

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

Specified by:

getOwnerName in interface IDepot

setOwnerName

public void setOwnerName(java.lang.String ownerName)

getModDate

public java.util.Date getModDate()

Description copied from interface: IDepot

Get the date the depot was last modified.

Specified by:

getModDate in interface IDepot

setModDate

public void setModDate(java.util.Date modDate)

getDescription

public java.lang.String getDescription()

Description copied from interface: IDepot

Get the description associated with this depot.

Specified by:

getDescription in interface IDepot

setDescription

public void setDescription(java.lang.String description)

getDepotType

public IDepot.DepotType getDepotType()

Description copied from interface: IDepot

Get the type of this depot.

Specified by:

getDepotType in interface IDepot

setDepotType

public void setDepotType(IDepot.DepotType depotType)

getAddress

public java.lang.String getAddress()

Description copied from interface: IDepot

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

Specified by:

getAddress in interface IDepot

setAddress

public void setAddress(java.lang.String address)

getSuffix

public java.lang.String getSuffix()

Description copied from interface: IDepot

For spec depots, return the optional suffix (default '.p4s') for the generated paths associated with the depot; for other depot types, return null.

Specified by:

getSuffix in interface IDepot

setSuffix

public void setSuffix(java.lang.String suffix)

getMap

public java.lang.String getMap()

Description copied from interface: IDepot

Get the depot's path translation information.

Specified by:

getMap in interface IDepot

setMap

public void setMap(java.lang.String map)