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

java.lang.Object
  extended by com.perforce.p4java.impl.generic.core.ServerResource
      extended by com.perforce.p4java.impl.generic.core.LabelSummary
All Implemented Interfaces:
ILabelSummary, IServerResource
Direct Known Subclasses:
Label

public class LabelSummary
extends ServerResource
implements ILabelSummary

Default implementation of the ILabelSumamry interface.


Field Summary
protected  boolean autoreload
           
protected static String AUTORELOAD_VALUE
           
protected  String description
           
protected  Date lastAccess
           
protected  Date lastUpdate
           
protected  boolean locked
           
protected static String LOCKED_VALUE
           
protected  String name
           
protected static String NOAUTORELOAD_VALUE
           
protected  String ownerName
           
protected  String revisionSpec
           
protected  boolean unloaded
           
protected static String UNLOCKED_VALUE
           
 
Fields inherited from class com.perforce.p4java.impl.generic.core.ServerResource
refreshable, server, updateable
 
Constructor Summary
LabelSummary()
          Default constructor -- set all fields to null or false.
LabelSummary(boolean summaryOnly)
          Construct an empty LabelSummary and appropriately initialize the ServerResource superclass fields according to whether this summary a summary only or part of the full Label class.
LabelSummary(Map<String,Object> map)
          Construct a LabelSummary from a map returned from the Perforce server's getLabelSummaryList.
 
Method Summary
 String getDescription()
          Get the description associated with this label.
 Date getLastAccess()
          Get the date and time of the last 'labelsync' or use of '@label' on this label.
 Date getLastUpdate()
          Get the date and time the label specification was last updated.
 String getName()
          Get the label's name (the label's label, so to speak).
 String getOwnerName()
          Get the name of the owner of this label.
 String getRevisionSpec()
          Get the optional revision specification for this label.
 boolean isAutoReload()
          Return the "autoreload/noautoreload" status for this label.
 boolean isLocked()
          Return the "locked/unlocked" status for this label.
 boolean isUnloaded()
          Return the "unloaded" status for this label.
 void setAutoReload(boolean autoreload)
          Set the "autoreload/noautoreload" status for this label.
 void setDescription(String description)
          Set the description associated with this label.
 void setLastAccess(Date lastAccess)
          Set the date and time of the last 'labelsync' or use of '@label' on this label.
 void setLastUpdate(Date lastUpdate)
          Set the date and time the label specification was last updated.
 void setLocked(boolean locked)
          Set the "locked/unlocked" status for this label.
 void setName(String name)
          Set the label's name.
 void setOwnerName(String ownerName)
          Set the name of the owner of this label.
 void setRevisionSpec(String revisionSpec)
          Set the optional revision specification for this label.
 
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
 

Field Detail

LOCKED_VALUE

protected static final String LOCKED_VALUE
See Also:
Constant Field Values

UNLOCKED_VALUE

protected static final String UNLOCKED_VALUE
See Also:
Constant Field Values

AUTORELOAD_VALUE

protected static final String AUTORELOAD_VALUE
See Also:
Constant Field Values

NOAUTORELOAD_VALUE

protected static final String NOAUTORELOAD_VALUE
See Also:
Constant Field Values

name

protected String name

ownerName

protected String ownerName

lastAccess

protected Date lastAccess

lastUpdate

protected Date lastUpdate

description

protected String description

revisionSpec

protected String revisionSpec

locked

protected boolean locked

unloaded

protected boolean unloaded

autoreload

protected boolean autoreload
Constructor Detail

LabelSummary

public LabelSummary()
Default constructor -- set all fields to null or false.


LabelSummary

public LabelSummary(boolean summaryOnly)
Construct an empty LabelSummary and appropriately initialize the ServerResource superclass fields according to whether this summary a summary only or part of the full Label class.


LabelSummary

public LabelSummary(Map<String,Object> map)
Construct a LabelSummary from a map returned from the Perforce server's getLabelSummaryList.

If the map is null, this is equivalent to calling the default constructor.

Method Detail

getName

public String getName()
Description copied from interface: ILabelSummary
Get the label's name (the label's label, so to speak).

Specified by:
getName in interface ILabelSummary
Returns:
possibly-null label name (should only be null if the underlying label object has just been created on the client and has no server-side counterpart yet).
See Also:
ILabelSummary.getName()

setName

public void setName(String name)
Description copied from interface: ILabelSummary
Set the label's name.

Specified by:
setName in interface ILabelSummary
Parameters:
name - the label's (new) name.
See Also:
ILabelSummary.setName(java.lang.String)

getOwnerName

public String getOwnerName()
Description copied from interface: ILabelSummary
Get the name of the owner of this label.

Specified by:
getOwnerName in interface ILabelSummary
Returns:
possibly-null owner name.
See Also:
ILabelSummary.getOwnerName()

setOwnerName

public void setOwnerName(String ownerName)
Description copied from interface: ILabelSummary
Set the name of the owner of this label.

Specified by:
setOwnerName in interface ILabelSummary
Parameters:
ownerName - the new owner name.
See Also:
ILabelSummary.setOwnerName(java.lang.String)

getLastAccess

public Date getLastAccess()
Description copied from interface: ILabelSummary
Get the date and time of the last 'labelsync' or use of '@label' on this label.

Specified by:
getLastAccess in interface ILabelSummary
Returns:
possibly-null Date
See Also:
ILabelSummary.getLastAccess()

setLastAccess

public void setLastAccess(Date lastAccess)
Description copied from interface: ILabelSummary
Set the date and time of the last 'labelsync' or use of '@label' on this label.

Specified by:
setLastAccess in interface ILabelSummary
Parameters:
lastAccess - new last access date.
See Also:
ILabelSummary.setLastAccess(java.util.Date)

getLastUpdate

public Date getLastUpdate()
Description copied from interface: ILabelSummary
Get the date and time the label specification was last updated.

Specified by:
getLastUpdate in interface ILabelSummary
Returns:
possibly-null Date
See Also:
ILabelSummary.getLastUpdate()

setLastUpdate

public void setLastUpdate(Date lastUpdate)
Description copied from interface: ILabelSummary
Set the date and time the label specification was last updated.

Specified by:
setLastUpdate in interface ILabelSummary
Parameters:
lastUpdate - Date last updated.
See Also:
ILabelSummary.setLastUpdate(java.util.Date)

getDescription

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

Specified by:
getDescription in interface ILabelSummary
Returns:
possibly-null description string.
See Also:
ILabelSummary.getDescription()

setDescription

public void setDescription(String description)
Description copied from interface: ILabelSummary
Set the description associated with this label.

Specified by:
setDescription in interface ILabelSummary
Parameters:
description - new label description string.
See Also:
ILabelSummary.setDescription(java.lang.String)

getRevisionSpec

public String getRevisionSpec()
Description copied from interface: ILabelSummary
Get the optional revision specification for this label.

Specified by:
getRevisionSpec in interface ILabelSummary
Returns:
possibly-null revision spec string.
See Also:
ILabelSummary.getRevisionSpec()

setRevisionSpec

public void setRevisionSpec(String revisionSpec)
Description copied from interface: ILabelSummary
Set the optional revision specification for this label.

Specified by:
setRevisionSpec in interface ILabelSummary
Parameters:
revisionSpec - new revision spec string
See Also:
ILabelSummary.setRevisionSpec(java.lang.String)

isLocked

public boolean isLocked()
Description copied from interface: ILabelSummary
Return the "locked/unlocked" status for this label.

Specified by:
isLocked in interface ILabelSummary
Returns:
true iff the label is locked else it is unlocked.
See Also:
ILabelSummary.isLocked()

setLocked

public void setLocked(boolean locked)
Description copied from interface: ILabelSummary
Set the "locked/unlocked" status for this label.

Specified by:
setLocked in interface ILabelSummary
Parameters:
locked - true iff the label is locked else it is unlocked.
See Also:
ILabelSummary.setLocked(boolean)

isAutoReload

public boolean isAutoReload()
Description copied from interface: ILabelSummary
Return the "autoreload/noautoreload" status for this label.

Specified by:
isAutoReload in interface ILabelSummary
Returns:
true iff the label is "autoreload" else it is "noautoreload".
See Also:
ILabelSummary.isAutoReload()

setAutoReload

public void setAutoReload(boolean autoreload)
Description copied from interface: ILabelSummary
Set the "autoreload/noautoreload" status for this label.

Specified by:
setAutoReload in interface ILabelSummary
Parameters:
autoreload - true iff the label is "autoreload" else it is "noautoreload".
See Also:
ILabelSummary.setAutoReload(boolean)

isUnloaded

public boolean isUnloaded()
Description copied from interface: ILabelSummary
Return the "unloaded" status for this label.

Specified by:
isUnloaded in interface ILabelSummary
Returns:
true iff the label is unloaded.
See Also:
ILabelSummary.isUnloaded()


Copyright © 2015 Perforce Software. All Rights Reserved.