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.impl.generic.core
Class Depot

java.lang.Object
  extended by com.perforce.p4java.impl.generic.core.ServerResource
      extended by 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(Map<String,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.
Depot(String name, String ownerName, Date modDate, String description, IDepot.DepotType depotType, String address, String suffix, String map)
          Explicit-value constructor.
 
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.
 void setAddress(String address)
           
 void setDepotType(IDepot.DepotType depotType)
           
 void setDescription(String description)
           
 void setMap(String map)
           
 void setModDate(Date modDate)
           
 void setName(String name)
           
 void setOwnerName(String ownerName)
           
 void setSuffix(String suffix)
           
 
Methods inherited from class com.perforce.p4java.impl.generic.core.ServerResource
canRefresh, canUpdate, complete, refresh, setRefreshable, setServer, update, update, 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, update, update
 

Constructor Detail

Depot

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

Depot

public Depot(String name,
             String ownerName,
             Date modDate,
             String description,
             IDepot.DepotType depotType,
             String address,
             String suffix,
             String map)
Explicit-value constructor.

Depot

public Depot(Map<String,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.

Parameters:
map - map passed back from the Perforce server as a result of the depot list or depot -o commands; if null, fields will have default values.
Method Detail

getName

public String getName()
Description copied from interface: IDepot
Get the name of the depot.

Specified by:
getName in interface IDepot

setName

public void setName(String name)

getOwnerName

public 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(String ownerName)

getModDate

public 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(Date modDate)

getDescription

public String getDescription()
Description copied from interface: IDepot
Get the description associated with this depot.

Specified by:
getDescription in interface IDepot

setDescription

public void setDescription(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 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(String address)

getSuffix

public 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(String suffix)

getMap

public String getMap()
Description copied from interface: IDepot
Get the depot's path translation information.

Specified by:
getMap in interface IDepot

setMap

public void setMap(String map)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2015 Perforce Software. All Rights Reserved.