public class ChangelistSummary extends ServerResource implements IChangelistSummary
IChangelistSummary.Visibility
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
changelistStream |
protected java.lang.String |
clientId |
protected java.util.Date |
date |
protected static java.lang.String |
DATE_FORMAT |
protected java.lang.String |
description |
protected int |
id |
protected boolean |
shelved |
protected ChangelistStatus |
status |
protected java.lang.String |
username |
protected IChangelistSummary.Visibility |
visibility |
refreshable, server, updateable
Constructor and Description |
---|
ChangelistSummary()
Default constructor -- sets all fields to false or null, id to
IChangelist.UNKNOWN, and calls the default ServerResource constructor.
|
ChangelistSummary(boolean complete,
boolean completable,
boolean refreshable,
boolean updateable,
IServer server)
Explicit-value pass-through constructor for the ServerResource fields.
|
ChangelistSummary(IChangelistSummary summary)
Construct a new ChangelistSummary from the passed-in summary.
|
ChangelistSummary(int id,
java.lang.String clientId,
java.lang.String username,
ChangelistStatus status,
java.util.Date date,
java.lang.String description,
boolean shelved)
Explicit-value constructor; calls the default ServerResource constructor.
|
ChangelistSummary(java.util.Map<java.lang.String,java.lang.Object> map,
boolean summaryOnly)
Convenience constructor, equivalent to this(map, summaryOnly, null).
|
ChangelistSummary(java.util.Map<java.lang.String,java.lang.Object> map,
boolean summaryOnly,
IServer server)
Construct a ChangelistSummary from a suitable map returned from
the Perforce server.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getChangelistStream()
// * @see com.perforce.p4java.core.IChangelistSummary#getChangelistStream()
|
java.lang.String |
getClientId()
Get the ID of the Perforce client workspace associated with this changelist.
|
java.util.Date |
getDate()
Get the date the changelist was created or last updated.
|
java.lang.String |
getDescription()
Return the description associated with this changelist.
|
int |
getId()
Return the Perforce changelist's ID.
|
ChangelistStatus |
getStatus()
Get the status of this changelist, if known.
|
java.lang.String |
getUsername()
Get the user name of the user associated with this changelist.
|
IChangelistSummary.Visibility |
getVisibility()
Get the visibility associated with this changelist.
|
boolean |
isShelved()
Does this changelist contain at least one shelved file?
This only applies to changelists whose
IChangelistSummary.getStatus() is
ChangelistStatus.PENDING and that have been returned as
IChangelistSummary objects. |
void |
setClientId(java.lang.String clientId)
Set the client ID.
|
void |
setDate(java.util.Date date)
Set the changelist date.
|
java.lang.String |
setDescription(java.lang.String description)
Set the description string for this changelist.
|
void |
setId(int id)
Set the changelist ID.
|
void |
setShelved(boolean shelved)
Set the shelved status of of this changelist (see isShelved()).
|
void |
setStatus(ChangelistStatus status)
Set the changelist status.
|
void |
setUsername(java.lang.String username)
Set the changelist owner ID.
|
void |
setVisibility(IChangelistSummary.Visibility visibility)
Set the visibility associated with this changelist.
|
canRefresh, canUpdate, clearRawFields, complete, getRawField, getRawFields, hasRawField, parseDate, refresh, setRawField, setRawFields, setRefreshable, setServer, toDateString, update, update, update
protected static final java.lang.String DATE_FORMAT
protected int id
protected java.lang.String clientId
protected java.lang.String username
protected ChangelistStatus status
protected java.util.Date date
protected java.lang.String description
protected boolean shelved
protected IChangelistSummary.Visibility visibility
protected java.lang.String changelistStream
public ChangelistSummary()
public ChangelistSummary(boolean complete, boolean completable, boolean refreshable, boolean updateable, IServer server)
complete
- completecompletable
- completablerefreshable
- refreshableupdateable
- updateableserver
- serverpublic ChangelistSummary(int id, java.lang.String clientId, java.lang.String username, ChangelistStatus status, java.util.Date date, java.lang.String description, boolean shelved)
id
- idclientId
- clientusername
- user namestatus
- statusdate
- datedescription
- descriptionshelved
- shelvedpublic ChangelistSummary(IChangelistSummary summary)
summary
- summary objectpublic ChangelistSummary(java.util.Map<java.lang.String,java.lang.Object> map, boolean summaryOnly)
map
- spec mapsummaryOnly
- summary onlypublic ChangelistSummary(java.util.Map<java.lang.String,java.lang.Object> map, boolean summaryOnly, IServer server)
Note that map keys returned from the Perforce server are sometimes different for summary fields and full fields, so you have to be clear about where the map came from to get accurate results.
map
- spec mapsummaryOnly
- summary onlyserver
- serverpublic int getId()
IChangelistSummary
getId
in interface IChangelistSummary
IChangelistSummary.getId()
public void setId(int id)
IChangelistSummary
setId
in interface IChangelistSummary
id
- new changelist ID.IChangelistSummary.setId(int)
public java.lang.String getClientId()
IChangelistSummary
getClientId
in interface IChangelistSummary
IChangelistSummary.getClientId()
public void setClientId(java.lang.String clientId)
IChangelistSummary
setClientId
in interface IChangelistSummary
clientId
- new client ID.IChangelistSummary.setClientId(java.lang.String)
public java.lang.String getUsername()
IChangelistSummary
getUsername
in interface IChangelistSummary
IChangelistSummary.getUsername()
public void setUsername(java.lang.String username)
IChangelistSummary
setUsername
in interface IChangelistSummary
username
- new owner's user name.IChangelistSummary.setUsername(java.lang.String)
public ChangelistStatus getStatus()
IChangelistSummary
getStatus
in interface IChangelistSummary
IChangelistSummary.getStatus()
public void setStatus(ChangelistStatus status)
IChangelistSummary
setStatus
in interface IChangelistSummary
status
- statuspublic java.util.Date getDate()
IChangelistSummary
getDate
in interface IChangelistSummary
IChangelistSummary.getDate()
public void setDate(java.util.Date date)
IChangelistSummary
setDate
in interface IChangelistSummary
date
- new changelist dateIChangelistSummary.setDate(java.util.Date)
public java.lang.String getDescription()
IChangelistSummary
getDescription
in interface IChangelistSummary
IChangelistSummary.getDescription()
public java.lang.String setDescription(java.lang.String description)
IChangelistSummary
setDescription
in interface IChangelistSummary
description
- non-null new description string.IChangelistSummary.setDescription(java.lang.String)
public boolean isShelved()
IChangelistSummary
IChangelistSummary.getStatus()
is
ChangelistStatus.PENDING
and that have been returned as
IChangelistSummary objects. The value here is unreliable for
full IChangelist objects returned from getChangelist, etc.isShelved
in interface IChangelistSummary
IChangelistSummary.isShelved()
public void setShelved(boolean shelved)
IChangelistSummary
setShelved
in interface IChangelistSummary
shelved
- new shelved value.IChangelistSummary.setShelved(boolean)
public IChangelistSummary.Visibility getVisibility()
IChangelistSummary
getVisibility
in interface IChangelistSummary
IChangelistSummary.getVisibility()
public void setVisibility(IChangelistSummary.Visibility visibility)
IChangelistSummary
setVisibility
in interface IChangelistSummary
visibility
- visabilityIChangelistSummary.setVisibility(com.perforce.p4java.core.IChangelistSummary.Visibility)
public java.lang.String getChangelistStream()
getChangelistStream
in interface IChangelistSummary