ClientSummary (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.impl.mapbased.client
Class ClientSummary

java.lang.Object
  com.perforce.p4java.impl.generic.core.ServerResource
      com.perforce.p4java.impl.mapbased.client.ClientSummary

All Implemented Interfaces:: IClientSummary, IServerResource

Direct Known Subclasses:: Client

public class ClientSummary
extends ServerResource
implements IClientSummary
extends ServerResource
implements IClientSummary

Default implementation class for the IClientSummary interface.

Nested Class Summary

Nested classes/interfaces inherited from interface com.perforce.p4java.client.IClientSummary
`IClientSummary.ClientLineEnd, IClientSummary.IClientOptions, IClientSummary.IClientSubmitOptions`

Field Summary
`protected Date`	`accessed`
`protected List<String>`	`alternateRoots`
`protected String`	`description`
`protected String`	`hostName`
`protected IClientSummary.ClientLineEnd`	`lineEnd`
`protected String`	`name`
`protected IClientSummary.IClientOptions`	`options`
`protected String`	`ownerName`
`protected String`	`root`
`protected String`	`serverId`
`protected String`	`stream`
`protected int`	`streamAtChange`
`protected IClientSummary.IClientSubmitOptions`	`submitOptions`
`protected boolean`	`unloaded`
`protected Date`	`updated`

Fields inherited from class com.perforce.p4java.impl.generic.core.ServerResource
`refreshable, server, updateable`

Constructor Summary
`ClientSummary()` Default constructor.
`ClientSummary(boolean summaryOnly)` Construct a new ClientSummary object whose ServerResource fields depend on the passed-in summaryOnly parameter.
`ClientSummary(IClientSummary clientSummary)` Clone a client summary by copying all fields.
`ClientSummary(Map<String,Object> map, boolean summaryOnly)` Server map constructor.
`ClientSummary(String name, Date accessed, Date updated, String description, String hostName, String ownerName, String root, IClientSummary.ClientLineEnd lineEnd, IClientSummary.IClientOptions options, IClientSummary.IClientSubmitOptions submitOptions, List<String> alternateRoots)` Explicit-value constructor.
`ClientSummary(String name, Date accessed, Date updated, String description, String hostName, String ownerName, String root, IClientSummary.ClientLineEnd lineEnd, IClientSummary.IClientOptions options, IClientSummary.IClientSubmitOptions submitOptions, List<String> alternateRoots, String stream)` Explicit-value constructor.

Method Summary
`Date`	`getAccessed()` Gets the date this client was last used in any way.
`List<String>`	`getAlternateRoots()` Get the alternate roots associated with this Perforce client, if any.
`String`	`getDescription()` Returns a short description of the Perforce server client.
`String`	`getHostName()` Returns the name of the associated host, if any.
`IClientSummary.ClientLineEnd`	`getLineEnd()` Get the line end options for this client.
`String`	`getName()` Get the name of this client.
`IClientSummary.IClientOptions`	`getOptions()` Get the Perforce client options associated with this client.
`String`	`getOwnerName()` Get the name of the owner of this Perforce client.
`String`	`getRoot()` Returns the root of this Perforce client.
`String`	`getServerId()` Get the server id associated with this client.
`String`	`getStream()` Get the stream's path in a stream depot, of the form //depotname/streamname, to which this client's view will be dedicated.
`int`	`getStreamAtChange()` Get the changelist id associated with this dynamically generated back-in-time stream client.
`IClientSummary.IClientSubmitOptions`	`getSubmitOptions()` Get the Perforce client changelist submit options associated with this client.
`Date`	`getUpdated()` Get the date the client's specification was last modified.
`boolean`	`isStream()` Convenience method to check if this is a stream client
`boolean`	`isUnloaded()` Return the "unloaded" status for this client.
`void`	`setAccessed(Date accessed)` Set the client's accessed date / time.
`void`	`setAlternateRoots(List<String> alternateRoots)` Set the alternate roots associated with this Perforce client.
`void`	`setDescription(String description)` Set the description associated with this client.
`void`	`setHostName(String hostName)` Set the name of the associated host.
`void`	`setLineEnd(IClientSummary.ClientLineEnd lineEnd)` Set the line end options for this client.
`void`	`setName(String name)` Set the name of this client.
`void`	`setOptions(IClientSummary.IClientOptions options)` Set the client options associated with this client.
`void`	`setOwnerName(String ownerName)` Set the name of the owner of this client.
`void`	`setRoot(String root)` Set the root of this client.
`void`	`setServerId(String serverId)` Set the server id of this client.
`void`	`setStream(String stream)` Set the stream's path in a stream depot, of the form //depotname/streamname, to which this client's view will be dedicated.
`void`	`setStreamAtChange(int streamAtChange)` Set the changelist id associated with this dynamically generated back-in-time stream client.
`void`	`setSubmitOptions(IClientSummary.IClientSubmitOptions submitOptions)` Set the client submit options for this client.
`void`	`setUpdated(Date updated)` Set the client's updated date / time.

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

name

protected String name

accessed

protected Date accessed

updated

protected Date updated

description

protected String description

hostName

protected String hostName

ownerName

protected String ownerName

root

protected String root

lineEnd

protected IClientSummary.ClientLineEnd lineEnd

options

protected IClientSummary.IClientOptions options

submitOptions

protected IClientSummary.IClientSubmitOptions submitOptions

alternateRoots

protected List<String> alternateRoots

stream

protected String stream

serverId

protected String serverId

streamAtChange

protected int streamAtChange

unloaded

protected boolean unloaded

Constructor Detail

ClientSummary

public ClientSummary()

Default constructor. Sets all fields to null except lineEnd, which is set to ClientLineEnd.LOCAL. Sets ServerResource superclass fields to indicate complete and not refereshable or updateable. Intended mostly for use with "pure" ClientSummary objects.

ClientSummary

public ClientSummary(boolean summaryOnly)

Construct a new ClientSummary object whose ServerResource fields depend on the passed-in summaryOnly parameter. If summaryOnly is false, this object is complete, updateable, and refreshable; otherwise, it's complete and neither updateable nor refresheable. Intended mostly for use with extended ClientSummary objects such as the full Client class.

ClientSummary

public ClientSummary(String name,
                     Date accessed,
                     Date updated,
                     String description,
                     String hostName,
                     String ownerName,
                     String root,
                     IClientSummary.ClientLineEnd lineEnd,
                     IClientSummary.IClientOptions options,
                     IClientSummary.IClientSubmitOptions submitOptions,
                     List<String> alternateRoots)

Explicit-value constructor. Intended mostly for use with "pure" ClientSummary objects. Sets ServerResource superclass fields to indicate complete and neither refreshable nor updateable.

ClientSummary

public ClientSummary(String name,
                     Date accessed,
                     Date updated,
                     String description,
                     String hostName,
                     String ownerName,
                     String root,
                     IClientSummary.ClientLineEnd lineEnd,
                     IClientSummary.IClientOptions options,
                     IClientSummary.IClientSubmitOptions submitOptions,
                     List<String> alternateRoots,
                     String stream)

Explicit-value constructor. Intended mostly for use with "pure" ClientSummary objects. Sets ServerResource superclass fields to indicate complete and neither refreshable nor updateable.

ClientSummary

public ClientSummary(IClientSummary clientSummary)

Clone a client summary by copying all fields. If clientSummary is null, this is equivalent to calling the default constructor.

ClientSummary

public ClientSummary(Map<String,Object> map,
                     boolean summaryOnly)

Server map constructor. Attempts to construct a new ClientSummary object from the passed-in map, which is assumed to have come from a Perforce server in response to a client list command. If map is null, this is equivalent to calling the default constructor.

Note that fields set here may be overridden in a full Client constructor, as the field keys and formats can be subtly (and not so subtly) different in maps returned from (say) getClientList() and getClient(). If summaryOnly is false, this map is assumed to be from a full client retrieval, meaning some of the fields retrieved in the full Client constructor are not set here. Otherwise, it attempts to retrieve all known ClientSummary fields.

Method Detail