Package com.perforce.p4java.impl.mapbased.client

Class Client

  • All Implemented Interfaces:
    IWhereDelegator, IClient, IClientSummary, IServerResource
    public class Client
extends ClientSummary
implements IClient
    Default implementation of the generic parts of an IClient interface.

    Note that this version is very much tied to the map-based server implementation, and can (generally) only be used with that server type. This is not an onerous requirement, however, as all IServer objects returned from the ServerFactory are map-based implementations.

    • Field Detail

      • MERGE_TMP_FILENAME_KEY

        public static final java.lang.String MERGE_TMP_FILENAME_KEY
        See Also:
        Constant Field Values

      • MERGE_START_FROM_REV_KEY

        public static final java.lang.String MERGE_START_FROM_REV_KEY
        See Also:
        Constant Field Values

      • MERGE_END_FROM_REV_KEY

        public static final java.lang.String MERGE_END_FROM_REV_KEY
        See Also:
        Constant Field Values

      • DEFAULT_DESCRIPTION

        public static final java.lang.String DEFAULT_DESCRIPTION
        What a new client created by the newClient method uses as a description if nothing is passed in explicitly.
        See Also:
        Constant Field Values

    • Constructor Detail

      • Client

        @Deprecated
public Client()
        Deprecated.
        Default constructor. Clients constructed with this constructor will need a suitable setServer call to set the underlying server link before being able to do much beyond setting local fields. Note that we also need to set the various IServerResource fields appropriately, as IClientSummary objects are not completable, refreshable, or updateable, but full IClient objects are (at least) refreshable and updateable.

        ClientSummary fields are set as noted in the ClientSummary default constructor comments.

      • Client

        public Client​(IServer server)
        Note that any IServer object returned by the ServerFactory will work for the serverImpl parameter; if not, a suitable cast exception will be thrown.

        ClientSummary fields are set as noted in the ClientSummary default constructor comments.

        Parameters:
        server - an IServer server returned from the server factory.

      • Client

        public Client​(java.lang.String name,
              java.util.Date accessed,
              java.util.Date updated,
              java.lang.String description,
              java.lang.String hostName,
              java.lang.String ownerName,
              java.lang.String root,
              IClientSummary.ClientLineEnd lineEnd,
              IClientSummary.IClientOptions options,
              IClientSummary.IClientSubmitOptions submitOptions,
              java.util.List<java.lang.String> alternateRoots,
              IServer serverImpl,
              ClientView clientView)
        Construct a new Client object from explicit fields.

        Note that any IServer object returned by the ServerFactory will work for the serverImpl parameter; if not, a suitable cast exception will be thrown.

        Parameters:
        name - name
        accessed - accessed
        updated - updated
        description - description
        hostName - hostName
        ownerName - ownerName
        root - root
        lineEnd - lineEnd
        options - options
        submitOptions - submitOptions
        alternateRoots - alternateRoots
        serverImpl - serverImpl
        clientView - clientView

      • Client

        public Client​(java.lang.String name,
              java.util.Date accessed,
              java.util.Date updated,
              java.lang.String description,
              java.lang.String hostName,
              java.lang.String ownerName,
              java.lang.String root,
              IClientSummary.ClientLineEnd lineEnd,
              IClientSummary.IClientOptions options,
              IClientSummary.IClientSubmitOptions submitOptions,
              java.util.List<java.lang.String> alternateRoots,
              IServer serverImpl,
              ClientView clientView,
              java.lang.String stream,
              java.lang.String type)
        Construct a new Client object from explicit fields.

        Note that any IServer object returned by the ServerFactory will work for the serverImpl parameter; if not, a suitable cast exception will be thrown.

        Parameters:
        name - name
        accessed - accessed
        updated - updated
        description - description
        hostName - hostName
        ownerName - ownerName
        root - root
        lineEnd - lineEnd
        options - options
        submitOptions - submitOptions
        alternateRoots - alternateRoots
        serverImpl - serverImpl
        clientView - clientView
        stream - stream
        type - type

      • Client

        public Client​(IServer serverImpl,
              java.util.Map<java.lang.String,​java.lang.Object> map)
        Construct a suitable Client object from an IServer and a map returned from the Perforce server. If map is null, this is equivalent to calling the Client(IServer serverImpl) constructor.

        Note that any IServer object returned by the ServerFactory will work for the serverImpl parameter; if not, a suitable cast exception will be thrown.

        Parameters:
        serverImpl - serverImpl
        map - map

      • Client

        public Client​(IClientSummary clientSummary,
              boolean refresh)
       throws ConnectionException,
              RequestException,
              AccessException
        Construct a new Client object using the passed-in client summary object as a partial template. Note that this client object will need to have its serverImpl before any refreshes, updates, etc., are done against it.

        If summary is null, this is equivalent to calling the default constructor. If clientSummary is not null, and refresh is false, the relevant ClientSummary superclass is initialized by copying the passed-in summary fields. If clientSummary is not null and refresh is true, the Client is constructed by calling refresh() using the clientSummary's name; if refresh is false, the client view will be as for the default constructor.

        Parameters:
        clientSummary - clientSummary
        refresh - refresh
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        RequestException - if the Perforce server encounters an error during its processing of the request
        AccessException - if the Perforce server denies access to the caller

      • Client

        public Client​(IClientSummary clientSummary,
              IServer serverImpl,
              boolean refresh)
       throws ConnectionException,
              RequestException,
              AccessException
        Construct a new Client object using the passed-in client summary object as a partial template along with the passed-in IServer object.

        Note that any IServer object returned by the ServerFactory will work for the serverImpl parameter; if not, a suitable cast exception will be thrown.

        If summary is null, this is equivalent to calling the default constructor. If clientSummary is not null, and refresh is false, the relevant ClientSummary superclass is initialized by copying the passed-in summary fields. If clientSummary is not null and refresh is true, the Client is constructed by calling refresh() using the clientSummary's name; if refresh is false, the client view will be as for the default constructor.

        Parameters:
        clientSummary - clientSummary
        serverImpl - serverImpl
        refresh - refresh
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        RequestException - if the Perforce server encounters an error during its processing of the request
        AccessException - if the Perforce server denies access to the caller

    • Method Detail

      • newClient

        public static Client newClient​(IOptionsServer server,
                               java.lang.String name,
                               java.lang.String description,
                               java.lang.String root,
                               java.lang.String[] paths)
        Convenience method to return a new Client object with certain default values filled in.

        Only the fields corresponding to the parameters here can be explicitly set on creation; all others are given defaults that can be changed or added later. These defaults are as given for the default Client and ClientSummary constructors; exceptions include the client's user name, which is set to server.getUserName (which may cause issues later down the line if that wasn't set).

        Note that this object is a local object only -- you must subsequently call the server's createClient method to also create it on the server (or use the Factory.createClient convenience method).

        Note that this method is pretty simple-minded about client names, paths, etc. -- anything that contains unexpected spaces or weird characters (etc.) may cause it to get confused, in which case you're better off constructing things by hand or pre-massaging parameters yourself.

        Parameters:
        server - non-null IOptionsServer to be associated with the client.
        name - non-null client name.
        description - if not null, the client description field to be used; if null, DEFAULT_DESCRIPTION will be used as a default.
        root - if not null, use this as the new client's root; if null, use the server's working directory if its getWorkingDirectory method returns non-null, otherwise use the JVM's current working directory as determine by the user.dir system property.
        paths - if not null, use this as the list of view map depot / client paths, in the order given, and according to the format in MapEntry.parseViewMappingString; defaults to a single entry, "//depot/... //clientname/depot/..." if not given.
        Returns:
        new non-null local Client object.

      • getServer

        public IServer getServer()
        Description copied from interface: IClient
        Return the IServer object representing the Perforce server associated with this Perforce client.
        Specified by:
        getServer in interface IClient
        Returns:
        the IServer object representing the server associated with this client, or null if no such server exists or has been set for this client.
        See Also:
        IClient.getServer()

      • update

        public void update()
            throws ConnectionException,
                   RequestException,
                   AccessException
        Description copied from interface: IServerResource
        Update the Perforce server object associated with the underlying P4Java object, if possible. The semantics of server updates are generally object-specific and will be spelled out for each participating object.

        The results of calling this method on objects whose canUpdate method returns false are undefined (but will generally result in a UnimplementedError being thrown).

        Specified by:
        update in interface IServerResource
        Overrides:
        update in class ServerResource
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        RequestException - if the Perforce server encounters an error during its processing of the request
        AccessException - if the Perforce server denies access to the caller
        See Also:
        ServerResource.update()

      • update

        public void update​(boolean force)
            throws ConnectionException,
                   RequestException,
                   AccessException
        Description copied from interface: IServerResource
        Force (if true) update the Perforce server object associated with the underlying P4Java object, if possible. The semantics of server updates are generally object-specific and will be spelled out for each participating object.

        Note, in order to force the change it may require super user / admin privileges to work properly.

        The results of calling this method on objects whose canUpdate method returns false are undefined (but will generally result in a UnimplementedError being thrown).

        Specified by:
        update in interface IServerResource
        Overrides:
        update in class ServerResource
        Parameters:
        force - if true, force the update of the object on the server.
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        RequestException - if the Perforce server encounters an error during its processing of the request
        AccessException - if the Perforce server denies access to the caller
        See Also:
        ServerResource.update(boolean)

      • getClientView

        public ClientView getClientView()
        Description copied from interface: IClient
        Get the Perforce client view associated with this client, if any.
        Specified by:
        getClientView in interface IClient
        Returns:
        the Perforce client view associated with this client, if any; null otherwise.
        See Also:
        IClient.getClientView()

      • getChangeView

        public java.util.ArrayList<java.lang.String> getChangeView()
        Description copied from interface: IClient
        Get the Perforce change view associated with this client, if any.
        Specified by:
        getChangeView in interface IClient
        Returns:
        the Perforce change view associated with this client, if any; null otherwise.

      • setChangeView

        public void setChangeView​(java.util.ArrayList<java.lang.String> changeView)
        Description copied from interface: IClient
        Set the Perforce client change view associated with this client.
        Specified by:
        setChangeView in interface IClient
        Parameters:
        changeView - new List of change views for the client.

      • sync

        public java.util.List<IFileSpec> sync​(java.util.List<IFileSpec> fileSpecs,
                                      boolean forceUpdate,
                                      boolean noUpdate,
                                      boolean clientBypass,
                                      boolean serverBypass)
                               throws ConnectionException,
                                      RequestException,
                                      AccessException
        Description copied from interface: IClient
        Sync a Perforce client workspace against the Perforce server.

        Note that this method will fail (throw a RequestException) unless the client is the associated IServer object's current client.

        Specified by:
        sync in interface IClient
        Parameters:
        fileSpecs - files to be synchronized; if empty, synchronize all client files.
        forceUpdate - if true, forces resynchronization even if the client already has the file, and clobbers writable files. This flag doesn't affect open files. Corresponds to the p4 sync "-f" flag.
        noUpdate - causes sync not to update the client workspace, but to display what normally would be updated. Corresponds to the p4 sync "-n" flag.
        clientBypass - bypasses the client file update. It can be used to make the server believe that a client workspace already has the file. Corresponds to the p4 sync "-k" flag.
        serverBypass - populates the client workspace, but does not update the server to reflect those updates. Any file that is already synced or opened will be bypassed with a warning message. Corresponds to the p4 sync "-p" flag.
        Returns:
        non-null list of affected files as IFileSpec elements
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        RequestException - if the Perforce server encounters an error during its processing of the request
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IClient.sync(java.util.List, boolean, boolean, boolean, boolean)

      • sync

        public void sync​(java.util.List<IFileSpec> fileSpecs,
                 SyncOptions syncOpts,
                 IStreamingCallback callback,
                 int key)
          throws P4JavaException
        Description copied from interface: IClient
        Sync a Perforce client workspace against the Perforce server.

        Note that this method takes an IStreamingCallback parameter, and the results are sent to the user using the IStreamingCallback handleResult method; see the IStreamingCallback Javadoc for details. The payload passed to handleResult is usually the raw map gathered together deep in the RPC protocol layer, and the user is assumed to have the knowledge and technology to be able to parse it and use it.

        Specified by:
        sync in interface IClient
        Parameters:
        fileSpecs - files to be synchronized; if empty, synchronize all client files.
        syncOpts - SyncOptions object describing sync options; see SyncOptions comments.
        callback - a non-null IStreamingCallback to be used to process the incoming results.
        key - an opaque integer key that is passed to the IStreamingCallback callback methods to identify the action as being associated with this specific call.
        Throws:
        P4JavaException - if any processing errors occur during exection.
        See Also:
        IClient.sync(java.util.List, com.perforce.p4java.option.client.SyncOptions, com.perforce.p4java.server.callback.IStreamingCallback, int)

      • syncParallel

        public void syncParallel​(java.util.List<IFileSpec> fileSpecs,
                         SyncOptions syncOpts,
                         IStreamingCallback callback,
                         int key,
                         ParallelSyncOptions pSyncOpts)
                  throws P4JavaException
        Description copied from interface: IClient
        Sync a Perforce client workspace against the Perforce server in parallel.

        Note that this method takes an IStreamingCallback parameter, and the results are sent to the user using the IStreamingCallback handleResult method; see the IStreamingCallback Javadoc for details. The payload passed to handleResult is usually the raw map gathered together deep in the RPC protocol layer, and the user is assumed to have the knowledge and technology to be able to parse it and use it.

        Specified by:
        syncParallel in interface IClient
        Parameters:
        fileSpecs - files to be synchronized; if empty, synchronize all client files.
        syncOpts - SyncOptions object describing standard sync options; see SyncOptions comments.
        callback - a non-null IStreamingCallback to be used to process the incoming results.
        key - an opaque integer key that is passed to the IStreamingCallback callback methods to identify the action as being associated with this specific call.
        pSyncOpts - The --parallel flag specifies options for for parallel file transfer
        Throws:
        P4JavaException - on error
        See Also:
        IClient.sync(java.util.List, com.perforce.p4java.option.client.SyncOptions, com.perforce.p4java.server.callback.IStreamingCallback, int)

      • labelSync

        public java.util.List<IFileSpec> labelSync​(java.util.List<IFileSpec> fileSpecs,
                                           java.lang.String labelName,
                                           boolean noUpdate,
                                           boolean addFiles,
                                           boolean deleteFiles)
                                    throws ConnectionException,
                                           RequestException,
                                           AccessException
        Description copied from interface: IClient
        Perform a label sync operation for this client. See the main Perforce documentation for an explanation of the labelsync operation.
        Specified by:
        labelSync in interface IClient
        Parameters:
        fileSpecs - if non-null, the list of files dor this operation
        labelName - non-null name of the label to be sync'd
        noUpdate - if true, just show what would result with the labelsync rather than actually doing it
        addFiles - if true, add the files in fileSpecs to the label
        deleteFiles - if true, delete the files in fileSpecs from the label
        Returns:
        non-null list of affected files as IFileSpec elements
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        RequestException - if the Perforce server encounters an error during its processing of the request
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IClient.labelSync(java.util.List, java.lang.String, boolean, boolean, boolean)

      • createChangelist

        public IChangelist createChangelist​(IChangelist newChangelist)
                             throws ConnectionException,
                                    RequestException,
                                    AccessException
        Description copied from interface: IClient
        Create a new changelist for this Perforce client in the associated Perforce server. The newly-created changelist has no files associated with it (regardless of whether the passed-in changelist spec has files associated with it); if you wish to add files to the new changelist, you need to do a reopen on them explictly after the new changelist is returned.

        The new changelist is returned if the command is successful; this changelist object will include the new changelist ID.

        Specified by:
        createChangelist in interface IClient
        Parameters:
        newChangelist - non-null specification for the new changelist; if the newChangelist's ID is not IChangelist.DEFAULT, it is ignored.
        Returns:
        the new changelist, or null if there was an error or the new changelist is inaccessible.
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        RequestException - if the Perforce server encounters an error during its processing of the request
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IClient.createChangelist(com.perforce.p4java.core.IChangelist)

      • addFiles

        public java.util.List<IFileSpec> addFiles​(java.util.List<IFileSpec> fileSpecs,
                                          boolean noUpdate,
                                          int changeListId,
                                          java.lang.String fileType,
                                          boolean useWildcards)
                                   throws ConnectionException,
                                          AccessException
        Description copied from interface: IClient
        Open one or more Perforce client workspace files for adding to the Perforce server.
        Specified by:
        addFiles in interface IClient
        Parameters:
        fileSpecs - non-null list of files to be opened, in Perforce client or depot or local path format.
        noUpdate - if true, don't actually do the open, just return the files that would have been opened for addition.
        changeListId - if positive, the opened files are put into the pending changelist identified by changeListId; this changelist must have been previously created. If zero or negative, the file is opened in the 'default' (unnumbered) changelist.
        fileType - if non-null, the files are added as that filetype. See 'p4 help filetypes' to attempt to make any sense of Perforce file types.
        useWildcards - if true, filenames that contain wildcards are permitted. See the main Perforce documentation for file adding for details.
        Returns:
        a non-null but possibly-empty list of IFileSpec objects representing the opened files. Not all fields in these specs will be valid or set.
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IClient.addFiles(java.util.List, boolean, int, java.lang.String, boolean)

      • deleteFiles

        public java.util.List<IFileSpec> deleteFiles​(java.util.List<IFileSpec> fileSpecs,
                                             int changeListId,
                                             boolean noUpdate)
                                      throws ConnectionException,
                                             AccessException
        Description copied from interface: IClient
        Open Perforce client workspace files for deletion from a Perforce depot.
        Specified by:
        deleteFiles in interface IClient
        Parameters:
        fileSpecs - non-null list of files to be opened
        changeListId - if positive, the opened files are put into the pending changelist identified by changeListId; this changelist must have been previously created. If zero or negative, the file is opened in the 'default' (unnumbered) changelist.
        noUpdate - if true, don't actually do the open, just return the files that would have been opened for deletion.
        Returns:
        a non-null but possibly-empty list of IFileSpec objects representing the opened files. Not all fields in these specs will be valid or set
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IClient.deleteFiles(java.util.List, int, boolean)

      • editFiles

        public java.util.List<IFileSpec> editFiles​(java.util.List<IFileSpec> fileSpecs,
                                           boolean noUpdate,
                                           boolean bypassClientUpdate,
                                           int changeListId,
                                           java.lang.String fileType)
                                    throws RequestException,
                                           ConnectionException,
                                           AccessException
        Description copied from interface: IClient
        Open one or more Perforce client workspace files for editing.
        Specified by:
        editFiles in interface IClient
        Parameters:
        fileSpecs - non-null list of files to be opened, in Perforce client or depot or local path format.
        noUpdate - if true, don't actually do the open, just return the files that would have been opened for edit.
        bypassClientUpdate - if true, the edit bypasses any client file update. Equivalent to the new 2009.2 and later "-k" option. If set true with a Perforce server earlier than 2009.2, will produce a suitable RequestException. Note: this option can cause havoc if you don't use care...
        changeListId - if positive, the opened files are put into the pending changelist identified by changeListId; this changelist must have been previously created. If zero or negative, the file is opened in the 'default' (unnumbered) changelist.
        fileType - if non-null, the file is opened as that filetype. Otherwise, the filetype of the previous revision is reused. If the filetype given is a partial filetype, that partial filetype is combined with the previous revision's filetype. See 'p4 help filetypes' to attempt to make any sense of this..
        Returns:
        a non-null but possibly-empty list of IFileSpec objects representing the opened files. Not all fields in these specs will be valid or set.
        Throws:
        RequestException - if the Perforce server encounters an error during its processing of the request
        ConnectionException - if the Perforce server is unreachable or is not connected.
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IClient.editFiles(java.util.List, boolean, boolean, int, java.lang.String)

      • revertFiles

        public java.util.List<IFileSpec> revertFiles​(java.util.List<IFileSpec> fileSpecs,
                                             boolean noUpdate,
                                             int changeListId,
                                             boolean revertOnlyUnchanged,
                                             boolean noRefresh)
                                      throws ConnectionException,
                                             AccessException
        Description copied from interface: IClient
        Revert a open Perforce client workspace files back to the revision previously synced from the Perforce depot, discarding any pending changelists or integrations that have been made so far.
        Specified by:
        revertFiles in interface IClient
        Parameters:
        fileSpecs - non-null (but possibly-empty) list of files to be reverted
        noUpdate - if true, don't actually do the revert, just return the files that would have been reverted
        changeListId - if positive, revert only those files in the pending changelist given in changeListId.
        revertOnlyUnchanged - if true, revert only those files which are opened for edit or integrate and are unchanged or missing.
        noRefresh - if true, bypass the client file refresh of the reverted files.
        Returns:
        a non-null but possibly-empty list of IFileSpec objects representing the reverted files. Not all fields in these specs will be valid or set.
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IClient.revertFiles(java.util.List, boolean, int, boolean, boolean)

      • revertFiles

        public java.util.List<IFileSpec> revertFiles​(java.util.List<IFileSpec> fileSpecs,
                                             RevertFilesOptions opts)
                                      throws P4JavaException
        Description copied from interface: IClient
        Revert open Perforce client workspace files back to the revision previously synced from the Perforce depot, discarding any pending changelists or integrations that have been made so far.
        Specified by:
        revertFiles in interface IClient
        Parameters:
        fileSpecs - non-null (but possibly-empty) list of files to be reverted
        opts - possibly-null RevertFilesOptions object specifying method options.
        Returns:
        a non-null but possibly-empty list of IFileSpec objects representing the reverted files. Not all fields in these specs will be valid or set.
        Throws:
        P4JavaException - if an error occurs processing this method and its parameters
        See Also:
        IClient.revertFiles(java.util.List, com.perforce.p4java.option.client.RevertFilesOptions)

      • undoFiles

        public java.util.List<IFileSpec> undoFiles​(java.util.List<IFileSpec> fileSpecs,
                                           int changelistId,
                                           boolean listOnly)
                                    throws ConnectionException,
                                           AccessException
        Description copied from interface: IClient
        Undo one or more previously submitted files. The 'undone' changes remain a part of the history, but the new revisions submitted after 'p4 undo' will reverse their effect.

        If a single revision is specified, the specified revision is undone. If a revision range is specified, the entire range is undone.

        Specified by:
        undoFiles in interface IClient
        Parameters:
        fileSpecs - if non-empty, undo the specified files; otherwise undo all qualifying files
        changelistId - - if not IChangelist.UNKNOWN, the files are opened in the numbered pending changelist instead of the 'default' changelist.
        listOnly - – if true, don't actually perform the move, just return what would happen if the move was performed
        Returns:
        list of IFileSpec objects representing the results of this undo
        Throws:
        ConnectionException - - if the Perforce server is unreachable or is not connected.
        AccessException - – if the Perforce server denies access to the caller

      • undoFiles

        public java.util.List<IFileSpec> undoFiles​(java.util.List<IFileSpec> fileSpecs,
                                           UndoFilesOptions opts)
                                    throws P4JavaException
        Description copied from interface: IClient
        Undo one or more previously submitted files. The 'undone' changes remain a part of the history, but the new revisions submitted after 'p4 undo' will reverse their effect.

        If a single revision is specified, the specified revision is undone. If a revision range is specified, the entire range is undone.

        Specified by:
        undoFiles in interface IClient
        Parameters:
        fileSpecs - if non-empty, undo the specified files; otherwise undo all qualifying files
        opts - possibly-null UndoFilesOptions object object specifying method options.
        Returns:
        non-null but possibly-empty list of qualifying files to undo. Not all fields in individual file specs will be valid or make sense to be accessed.
        Throws:
        P4JavaException - if an error occurs processing this method and its parameters.

      • haveList

        public java.util.List<IFileSpec> haveList​(java.util.List<IFileSpec> fileSpecs)
                                   throws ConnectionException,
                                          AccessException
        Description copied from interface: IClient
        Return a list of all Perforce-managed files and versions that the Perforce server believes this Perforce client workspace has as of the latest sync. If fileSpecs is given, this method returns, only information on those files is returned.

        Note that this method will return an empty list unless the client is the IServer object's current client.

        Only the depotFile, revision, clientPath, and localPath fields of the returned file specs are guaranteed to be valid.

        Specified by:
        haveList in interface IClient
        Parameters:
        fileSpecs - file specs; if empty or null, return all qualifying files
        Returns:
        non-null (but possibly empty) list of IFileSpec objects for the passed-in arguments.
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.t
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IClient.haveList(java.util.List)

      • graphHaveList

        public java.util.List<IFileSpec> graphHaveList​(java.util.List<IFileSpec> fileSpecs)
                                        throws ConnectionException,
                                               AccessException
        Description copied from interface: IClient
        Return a list of all Perforce-managed repos that the Perforce server believes this Perforce client workspace has as of the latest sync. If fileSpecs is given, this method returns, only information on those files is returned.

        Note that this method will return an empty list unless the client is the IServer object's current client.

        Only the sha, repo name, and branch name fields of the returned file specs are guaranteed to be valid.

        Specified by:
        graphHaveList in interface IClient
        Parameters:
        fileSpecs - file specs; if empty or null, return all qualifying files
        Returns:
        non-null (but possibly empty) list of IFileSpec objects for the passed-in arguments.
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.t
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IClient.graphHaveList(java.util.List)

      • reopenFiles

        public java.util.List<IFileSpec> reopenFiles​(java.util.List<IFileSpec> fileSpecs,
                                             int changeListId,
                                             java.lang.String fileType)
                                      throws ConnectionException,
                                             AccessException
        Description copied from interface: IClient
        Reopen Perforce files in a new changelist.
        Specified by:
        reopenFiles in interface IClient
        Parameters:
        fileSpecs - non-null list of files to be reopened
        changeListId - the new changelist ID to be used
        fileType - if non-null, the file is reopened as that filetype. If the filetype given is a partial filetype, that partial filetype is combined with the current filetype. See 'p4 help filetypes' to attempt to make any sense of this..
        Returns:
        list of IFileSpec for each specified file
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IClient.reopenFiles(java.util.List, int, java.lang.String)

      • where

        public java.util.List<IFileSpec> where​(java.util.List<IFileSpec> fileSpecs)
                                throws ConnectionException,
                                       AccessException
        Description copied from interface: IWhereDelegator
        For each of the passed-in file specs, show how the named file maps through the client view.

        Note that this method will return an empty list unless the client is the IServer object's current client.

        The returned IFiles contain all three of the depot, client, and local file paths of the corresponding fileSpec array element where appropriate, or the usual server-generated error message if there was no corresponding mapping. The main exception to this is the case when no filespecs are given (i.e. the fileSpecs array is null or empty), when the mappings for '...' (all files in the current directory and below) are returned (if they exist).

        Specified by:
        where in interface IWhereDelegator
        Parameters:
        fileSpecs - a list of Perforce file specifications; can be empty or even null (see explanation above).
        Returns:
        a non-null (but possibly empty) list of IFileSpec for the input filespecs.
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IWhereDelegator.where(java.util.List)

      • localWhere

        public java.util.List<IFileSpec> localWhere​(java.util.List<IFileSpec> fileSpecs)
        Description copied from interface: IWhereDelegator
        For each of the passed-in file specs, show how the named file maps through the client view.

        Note that this method will return an empty list unless the client is the IServer object's current client.

        The returned IFiles contain all three of the depot, client, and local file paths of the corresponding fileSpec array element where appropriate, or the usual server-generated error message if there was no corresponding mapping. The main exception to this is the case when no filespecs are given (i.e. the fileSpecs array is null or empty), when the mappings for '...' (all files in the current directory and below) are returned (if they exist).

        Assumes depot syntax is used for original path.

        Specified by:
        localWhere in interface IWhereDelegator
        Parameters:
        fileSpecs - a list of Perforce file specifications; can be empty or even null (see explanation above).
        Returns:
        a non-null (but possibly empty) list of IFileSpec for the input filespecs.
        See Also:
        IWhereDelegator.localWhere(java.util.List)

      • openedFiles

        public java.util.List<IFileSpec> openedFiles​(java.util.List<IFileSpec> fileSpecs,
                                             int maxFiles,
                                             int changeListId)
                                      throws ConnectionException,
                                             AccessException
        Description copied from interface: IClient
        If one or more Perforce file specs is passed-in, return the opened / locked status of each file (if known) within an IFileSpec object; otherwise return a list of all files known to be open for this Perforce client workspace.

        The returned list can be modified with the other arguments as described below.

        Specified by:
        openedFiles in interface IClient
        Parameters:
        fileSpecs - if non-empty, determine the status of the specified files; otherwise return all qualifying files known to be open
        maxFiles - if positive, return only the first maxFiles qualifying files.
        changeListId - if positive, return only files associated with the given changelist ID.
        Returns:
        non-null but possibly-empty list of qualifying open files. Not all fields in individual file specs will be valid or make sense to be accessed.
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IClient.openedFiles(java.util.List, int, int)

      • openedFiles

        public java.util.List<IFileSpec> openedFiles​(java.util.List<IFileSpec> fileSpecs,
                                             OpenedFilesOptions opts)
                                      throws P4JavaException
        Description copied from interface: IClient
        Return a list of files open for this client, optionally restricted to a specific path and / or changelist.

        Note that if a non-null OpenedFilesOptions object is passed to this method, the object's clientName field is ignored and the name of the client whose openedFiles method is being called is used instead; similarly, any allClient options (a.k.a "-a" flags) are also ignored.

        Specified by:
        openedFiles in interface IClient
        Parameters:
        fileSpecs - if non-empty, determine the status of the specified files; otherwise return all qualifying files known to be open
        opts - possibly-null OpenedFilesOptions object object specifying method options.
        Returns:
        non-null but possibly-empty list of qualifying open files. Not all fields in individual file specs will be valid or make sense to be accessed.
        Throws:
        P4JavaException - if an error occurs processing this method and its parameters.
        See Also:
        IClient.openedFiles(java.util.List, com.perforce.p4java.option.server.OpenedFilesOptions)

      • integrateFiles

        public java.util.List<IFileSpec> integrateFiles​(int changeListId,
                                                boolean showActionsOnly,
                                                IntegrationOptions integOpts,
                                                java.lang.String branchSpec,
                                                IFileSpec fromFile,
                                                IFileSpec toFile)
                                         throws ConnectionException,
                                                AccessException
        Description copied from interface: IClient
        Integrate ("merge") from one Perforce filespec to another. The semantics of Perforce merges are complex and are not explained here; please consult the main Perforce documentation for file merges and the IntegrationOptions Javdoc comments for details of the less-commonly-used options.
        Specified by:
        integrateFiles in interface IClient
        Parameters:
        changeListId - if not IChangelist.UNKNOWN, use this as the target changelist
        showActionsOnly - if true, don't actually do the integration, just return the actions that would have been done
        integOpts - detailed integration objects. If null, the method will use default option values as described for the IntegrationOptions constructor, all of which are safe for straightforward merge use.
        branchSpec - if not null, use this as the integration branch specification (as in the -b option to integ).
        fromFile - if not null, use this as the source Perforce filespec
        toFile - if not null, use this as the target Perforce filespec
        Returns:
        non-null list of IFileSpec objects describing the intended or actual integration actions.
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IClient.integrateFiles(int, boolean, com.perforce.p4java.core.file.IntegrationOptions, java.lang.String, com.perforce.p4java.core.file.IFileSpec, com.perforce.p4java.core.file.IFileSpec)

      • integrateFiles

        public java.util.List<IFileSpec> integrateFiles​(IFileSpec fromFile,
                                                java.util.List<IFileSpec> toFiles,
                                                IntegrateFilesOptions opts)
                                         throws P4JavaException
        Description copied from interface: IClient
        Integrate one set of files (the 'source') into another (the 'target'). The semantics of Perforce integrate are complex and are not explained here; please consult the main Perforce documentation for file integrations and the IntegrateFilesOptions Javdoc comments for details of the less-commonly-used options.

        Note that depending on the specific options passed-in the fromFile can be null or one file spec; the toFiles list can be null, one or more file specs.

        Specified by:
        integrateFiles in interface IClient
        Parameters:
        fromFile - if not null, use this as the source file.
        toFiles - if not null, use this as the list of target files.
        opts - possibly-null IntegrateFilesOptions object specifying method options.
        Returns:
        non-null (but possibly empty) list of affected files and / or error messages.
        Throws:
        P4JavaException - if an error occurs processing this method and its parameters.
        See Also:
        IClient.integrateFiles(com.perforce.p4java.core.file.IFileSpec, java.util.List, com.perforce.p4java.option.client.IntegrateFilesOptions)

      • resolveFilesAuto

        public java.util.List<IFileSpec> resolveFilesAuto​(java.util.List<IFileSpec> fileSpecs,
                                                  boolean safeMerge,
                                                  boolean acceptTheirs,
                                                  boolean acceptYours,
                                                  boolean showActionsOnly,
                                                  boolean forceResolve)
                                           throws ConnectionException,
                                                  AccessException
        Description copied from interface: IClient
        Automatically resolve the results of a previousPerforce file integration.

        Note that this is currently a very limited version of the full Perforce resolve feature, corresponding only to (some of) the various auto-resolve features, meaning this method will never invoke (or need to invoke) end user interaction. More extensive versions of the resolve command will be surfaced as needed.

        This method notionally returns an IFileSpec, as it's closely related to the integ method and shares many of its return values, but there are several limitations in the use of the returned IFileSpecs. In general, what is returned from this method is a mixture of resolution info messages (i.e. messages from the server that spell out what would or did happen during the resolve), and "true" filespecs. In the latter case, the filespec has a very limited set of valid fields: only client path, from file, and the from revisions are guaranteed to be valid. In the former case, since the info messages do NOT correspond one-to-one with the input file specs that caused the messages, consumers need to explicitly search each returned info message string for the relevant file path or name. This is an unfortunate artifact of the Perforce server's implementation of this command.

        Note: results and behavior are undefined if clashing or inconsistent options are used with this method. In general, the behavior of (e.g.) setting both acceptYours and acceptTheirs true will be whatever the Perforce server makes of it (usually an error), but that's not guaranteed....

        Note also that having safeMerge, acceptTheirs, acceptYours, and forceResolve all set to false results in "-am" behavior.

        Specified by:
        resolveFilesAuto in interface IClient
        Parameters:
        fileSpecs - files to be resolved; if null or empty, all files marked as needing resolution will be processed
        safeMerge - if true, only do "safe" resolves, as documented for the p4 "-as" option
        acceptTheirs - if true, automatically accept "their" changes, as documented for the p4 "-at" option
        acceptYours - if true, automatically accept "your" changes, as documented for the p4 "-ay" option
        showActionsOnly - if true, don't do the actual resolve, just return the actions that would have been performed for the resolve
        forceResolve - forces auto-mode resolve to accept the merged file even if there are conflicts. This option results in a merged file that may contain Perforce conflict markers; these markers should be edited out of the file manually before it's submitted (unless you actually want them there...).
        Returns:
        non-null but possibly-empty list of integration file specs for the resolve; see note above on the semantics of this list.
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IClient.resolveFilesAuto(java.util.List, boolean, boolean, boolean, boolean, boolean)

      • resolveFilesAuto

        public java.util.List<IFileSpec> resolveFilesAuto​(java.util.List<IFileSpec> fileSpecs,
                                                  ResolveFilesAutoOptions opts)
                                           throws P4JavaException
        Description copied from interface: IClient
        Automatically resolve the results of a previousPerforce file integration.

        Note that this is currently a very limited version of the full Perforce resolve feature, corresponding only to (some of) the various auto-resolve features, meaning this method will never invoke (or need to invoke) end user interaction. More extensive versions of the resolve command will be surfaced as needed.

        This method notionally returns an IFileSpec, as it's closely related to the integ method and shares many of its return values, but there are several limitations in the use of the returned IFileSpecs. In general, what is returned from this method is a mixture of resolution info messages (i.e. messages from the server that spell out what would or did happen during the resolve), and "true" filespecs. In the latter case, the filespec has a very limited set of valid fields: only client path, from file, and the from revisions are guaranteed to be valid. In the former case, since the info messages do NOT correspond one-to-one with the input file specs that caused the messages, consumers need to explicitly search each returned info message string for the relevant file path or name. This is an unfortunate artifact of the Perforce server's implementation of this command.

        Note: results and behavior are undefined if clashing or inconsistent options are used with this method. In general, the behavior of (e.g.) setting both acceptYours and acceptTheirs true will be whatever the Perforce server makes of it (usually an error), but that's not guaranteed....

        Note also that having safeMerge, acceptTheirs, acceptYours, and forceResolve all set to false in the associated ResolveFilesAutoOptions object results in "-am" behavior.

        Specified by:
        resolveFilesAuto in interface IClient
        Parameters:
        fileSpecs - files to be resolved; if null or empty, all files marked as needing resolution will be processed
        opts - possibly-null ResolveFilesAutoOptions object specifying method option
        Returns:
        non-null but possibly-empty list of integration file specs for the resolve; see note above on the semantics of this list
        Throws:
        P4JavaException - if an error occurs processing this method and its parameters
        See Also:
        IClient.resolveFilesAuto(java.util.List, com.perforce.p4java.option.client.ResolveFilesAutoOptions)

      • resolveStreamAuto

        public java.lang.String resolveStreamAuto​(ResolveFilesAutoOptions opts)
                                   throws P4JavaException
        Description copied from interface: IClient
        Automatically resolve the results of a previous Perforce file integration. Allows for resolving Streams.

        Note that this is currently a very limited version of the full Perforce resolve feature, corresponding only to (some of) the various auto-resolve features, meaning this method will never invoke (or need to invoke) end user interaction. More extensive versions of the resolve command will be surfaced as needed.

        Note: results and behavior are undefined if clashing or inconsistent options are used with this method. In general, the behavior of (e.g.) setting both acceptYours and acceptTheirs true will be whatever the Perforce server makes of it (usually an error), but that's not guaranteed....

        Note also that having safeMerge, acceptTheirs, acceptYours, and forceResolve all set to false in the associated ResolveFilesAutoOptions object results in "-am" behavior.

        Specified by:
        resolveStreamAuto in interface IClient
        Parameters:
        opts - possibly-null ResolveFilesAutoOptions object specifying method option
        Returns:
        Resolve Status
        Throws:
        P4JavaException - if an error occurs processing this method and its parameters

      • resolveFile

        public IFileSpec resolveFile​(IFileSpec targetFile,
                             java.io.InputStream sourceStream)
                      throws ConnectionException,
                             RequestException,
                             AccessException
        Description copied from interface: IClient
        Resolve a file integration by using the contents of the sourceStream InputStream as the resolve result.

        Note that this method assumes that the target and source resolve makes sense, and does little or no sanity- or error-checking. In particular, it will happily accept binary and text integration resolves whether they make sense or not; you should check the getHowResolved() method on the returned filespec to ensure that it did what you expected (typically this means checking that it was resolved using the "edit from" resolution rather than, say "ignored").

        Use of this method will normally result in an integration edit record in the target file's history whether you've actually done an edit or not, so it is up to the consumer to weed out the various straight copy resolve cases and only use this for cases of more complex merges that actually did involve an edit (in reality or not).

        Note that the IFileSpec returned will generally not have a valid depot or client file paths -- you must use the toFile and fromFile methods on the returns here.

        Specified by:
        resolveFile in interface IClient
        Parameters:
        targetFile - non-null file to be resolved.
        sourceStream - non-null InputStream containing the resolved file's new contents.
        Returns:
        possibly-null IFileSpec representing the result of the resolve
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        RequestException - if the Perforce server encounters an error during its processing of the request
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IClient.resolveFile(com.perforce.p4java.core.file.IFileSpec, java.io.InputStream)

      • resolveFile

        public IFileSpec resolveFile​(IFileSpec targetFileSpec,
                             java.io.InputStream sourceStream,
                             boolean useTextualMerge,
                             int startFromRev,
                             int endFromRev)
                      throws ConnectionException,
                             RequestException,
                             AccessException
        Description copied from interface: IClient
        Resolve a file integration by using the contents of the sourceStream InputStream as the resolve result.

        Note that this method assumes that the target and source resolve makes sense, and does little or no sanity- or error-checking. In particular, it will happily accept binary and text integration resolves whether they make sense or not; you should check the getHowResolved() method on the returned filespec to ensure that it did what you expected (typically this means checking that it was resolved using the "edit from" resolution rather than, say "ignored").

        Use of this method will normally result in an integration edit record in the target file's history whether you've actually done an edit or not, so it is up to the consumer to weed out the various straight copy resolve cases and only use this for cases of more complex merges that actually did involve an edit (in reality or not).

        Note that the IFileSpec returned will generally not have a valid depot or client file paths -- you must use the toFile and fromFile methods on the returns here.

        Specified by:
        resolveFile in interface IClient
        Parameters:
        targetFileSpec - non-null file to be resolved.
        sourceStream - non-null InputStream containing the resolved file's new contents.
        useTextualMerge - attempt a textual merge even for binary files
        startFromRev - oldest revision to be resolved, or -1 for no limit
        endFromRev - newest revision to be resolved, or -1 for no limit
        Returns:
        possibly-null IFileSpec representing the result of the resolve
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        RequestException - if the Perforce server encounters an error during its processing of the request
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IClient.resolveFile(com.perforce.p4java.core.file.IFileSpec, java.io.InputStream)

      • resolvedFiles

        public java.util.List<IFileSpec> resolvedFiles​(java.util.List<IFileSpec> fileSpecs,
                                               boolean showBaseRevision)
                                        throws ConnectionException,
                                               AccessException
        Description copied from interface: IClient
        Return a list of files resolved but not submitted for this client. Note that the returned list has only the localPath field set (i.e. depot, client, and generic paths are not set). This reflects the returned values from the server itself.
        Specified by:
        resolvedFiles in interface IClient
        Parameters:
        fileSpecs - optional filespecs to be processed
        showBaseRevision - if true, reports the revision used as the base during resolve (this seems to have no effect).
        Returns:
        list of files that have been resolved but not yet submitted
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IClient.resolvedFiles(java.util.List, boolean)

      • lockFiles

        public java.util.List<IFileSpec> lockFiles​(java.util.List<IFileSpec> fileSpecs,
                                           int changeListId)
                                    throws ConnectionException,
                                           AccessException
        Description copied from interface: IClient
        Lock an opened file against changelist submission.

        The open files named are locked in the Perforce depot, preventing any user other than the current user on the current client from submitting changes to the files. If a file is already locked then the lock request is rejected. If no file specs are given then lock all files currently open in the changelist number given if it is IChangelist.DEFAULT or > 0.

        Note that the file specs returned are only partially filled out; the Perforce server seems to only return path information for this command.

        Specified by:
        lockFiles in interface IClient
        Parameters:
        fileSpecs - candidate file specs
        changeListId - if IChangelist.DEFAULT or larger than zero, lock all files associated this changelist ID
        Returns:
        non-null but possibly-empty list of locked file specs or errors
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IClient.lockFiles(java.util.List, int)

      • lockFiles

        public java.util.List<IFileSpec> lockFiles​(java.util.List<IFileSpec> fileSpecs,
                                           LockFilesOptions opts)
                                    throws P4JavaException
        Description copied from interface: IClient
        Lock an opened file against changelist submission.

        The open files named are locked in the Perforce depot, preventing any user other than the current user on the current client from submitting changes to the files. If a file is already locked then the lock request is rejected. If no file specs are given then lock all files currently open in the changelist number given if it is IChangelist.DEFAULT or > 0.

        Note that the file specs returned are only partially filled out; the Perforce server seems to only return path information for this command.

        Specified by:
        lockFiles in interface IClient
        Parameters:
        fileSpecs - candidate file specs
        opts - possibly-null LockFilesOptions object specifying method options
        Returns:
        non-null but possibly-empty list of locked file specs or errors
        Throws:
        P4JavaException - if an error occurs processing this method and its parameters
        See Also:
        IClient.lockFiles(java.util.List, com.perforce.p4java.option.client.LockFilesOptions)

      • unlockFiles

        public java.util.List<IFileSpec> unlockFiles​(java.util.List<IFileSpec> fileSpecs,
                                             int changeListId,
                                             boolean force)
                                      throws ConnectionException,
                                             AccessException
        Description copied from interface: IClient
        Release locked files but leave them open.

        If the files are open in a specific pending changelist other than 'default', then the changeListId parameter is required to specify the pending changelist. If no file name is given then all files in the designated changelist are unlocked.

        Note that the file specs returned are only partially filled out; the Perforce server seems to only return path information for this command.

        Specified by:
        unlockFiles in interface IClient
        Parameters:
        fileSpecs - candidate file specs
        changeListId - if IChangelist.DEFAULT or larger than zero, lock all files associated this changelist ID
        force - force the lock on non-owned filespecs. Requires appropriate permissions.
        Returns:
        non-null but possibly-empty list of unlocked file specs or errors
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IClient.unlockFiles(java.util.List, int, boolean)

      • getDiffFiles

        public java.util.List<IFileSpec> getDiffFiles​(java.util.List<IFileSpec> fileSpecs,
                                              int maxFiles,
                                              boolean diffNonTextFiles,
                                              boolean openedDifferentMissing,
                                              boolean openedForIntegrate,
                                              boolean unopenedMissing,
                                              boolean unopenedDifferent,
                                              boolean unopenedWithStatus,
                                              boolean openedSame)
                                       throws ConnectionException,
                                              RequestException,
                                              AccessException
        Description copied from interface: IClient
        Return a list of files that differ in some (arbitrarily complex) way from depot. See the help documentation for the p4 diff command using the "-sx" (-sa, -sl, etc.) options for a full discussion of the options used below.

        Note that this method returns lists of files, and is not useful to get the diffs themselves (at least not directly).

        Note that the diff status returned for the unopenedWithStatus option is retrievable from the filespec with the getDiffStatus() method.

        Note that you must have at least one of the various "-s" options set to true.

        Specified by:
        getDiffFiles in interface IClient
        Parameters:
        fileSpecs - candidate file specs; may be null.
        maxFiles - max files
        diffNonTextFiles - include non-text files in the diff lists
        openedDifferentMissing - corresponds to the "-sa" option for the p4 command line.
        openedForIntegrate - corresponds to the "-sb" option for the p4 command line.
        unopenedMissing - corresponds to the "-sd" option for the p4 command line.
        unopenedDifferent - corresponds to the "-se" option for the p4 command line.
        unopenedWithStatus - corresponds to the "-sl" option for the p4 command line.
        openedSame - corresponds to the "-sr" option for the p4 command line.
        Returns:
        non-null but possibly-empty list of qualifying filepecs.
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        RequestException - if the Perforce server encounters an error during its processing of the request
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IClient.getDiffFiles(java.util.List, int, boolean, boolean, boolean, boolean, boolean, boolean, boolean)

      • getDiffFiles

        public java.util.List<IFileSpec> getDiffFiles​(java.util.List<IFileSpec> fileSpecs,
                                              GetDiffFilesOptions opts)
                                       throws P4JavaException
        Description copied from interface: IClient
        Return a list of files that differ in some (arbitrarily complex) way from depot. See the help documentation for the p4 diff command using the "-sx" (-sa, -sl, etc.) options for a full discussion of the options used below.

        Note that this method returns lists of files, and is not useful to get the diffs themselves (at least not directly).

        Note that the diff status returned for the unopenedWithStatus option is retrievable from the filespec with the getDiffStatus() method.

        Note that you must have at least one of the various "-s" options set to true.

        Specified by:
        getDiffFiles in interface IClient
        Parameters:
        fileSpecs - candidate file specs; may be null.
        opts - possibly-null GetDiffFilesOptions object specifying method options
        Returns:
        non-null but possibly-empty list of qualifying filepecs.
        Throws:
        P4JavaException - if an error occurs processing this method and its parameters
        See Also:
        IClient.getDiffFiles(java.util.List, com.perforce.p4java.option.client.GetDiffFilesOptions)

      • shelveFiles

        public java.util.List<IFileSpec> shelveFiles​(java.util.List<IFileSpec> fileSpecs,
                                             int changelistId,
                                             ShelveFilesOptions opts)
                                      throws P4JavaException
        Description copied from interface: IClient
        Shelve files in a changelist.
        Specified by:
        shelveFiles in interface IClient
        Parameters:
        fileSpecs - list of files to be shelved; if null or empty, shelve all files in the changelist
        changelistId - changelistId ID of the changelist containing the files to be shelved. Can not be IChangelist.DEFAULT or IChangelist.UNKNOWN (both of which will cause server usage errors to be returned if used).
        opts - possibly-null ShelveFilesOptions object specifying method options
        Returns:
        non-null but possibly empty list of file specs representing the server's response
        Throws:
        P4JavaException - if an error occurs processing this method and its parameters
        See Also:
        IClient.shelveFiles(java.util.List, int, com.perforce.p4java.option.client.ShelveFilesOptions)

      • shelveChangelist

        public java.util.List<IFileSpec> shelveChangelist​(int changelistId,
                                                  java.util.List<IFileSpec> fileSpecs,
                                                  boolean forceUpdate,
                                                  boolean replace,
                                                  boolean discard)
                                           throws ConnectionException,
                                                  RequestException,
                                                  AccessException
        Description copied from interface: IClient
        Update/replace/delete shelved file(s) from a pending changelist.
        Specified by:
        shelveChangelist in interface IClient
        Parameters:
        changelistId - ID of the changelist containing the files to be shelved. Can not be IChangelist.DEFAULT or IChangelist.UNKNOWN (both of which will cause server usage errors to be returned if used).
        fileSpecs - list of files to be shelved; if null or empty, shelve all files in the changelist
        forceUpdate - if true, update the named shelved files.
        replace - if true, replace the named shelved files.
        discard - if truem discard the named shelved files.
        Returns:
        non-null but possibly empty list of file specs representing the server's response.
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        RequestException - if the Perforce server encounters an error during its processing of the request
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IClient.shelveChangelist(int, java.util.List, boolean, boolean, boolean)

      • unshelveChangelist

        public java.util.List<IFileSpec> unshelveChangelist​(int shelveChangelistId,
                                                    java.util.List<IFileSpec> fileSpecs,
                                                    int clientChangelistId,
                                                    boolean forceOverwrite,
                                                    boolean previewOnly)
                                             throws ConnectionException,
                                                    RequestException,
                                                    AccessException
        Description copied from interface: IClient
        Unshelve file(s) from a shelved changelist
        Specified by:
        unshelveChangelist in interface IClient
        Parameters:
        shelveChangelistId - id of changelist containing shelved files to unshelve (-s)
        fileSpecs - optional list of file specs to limit unshelving to
        clientChangelistId - id of changelist to unshelve the files into (-c)
        forceOverwrite - force clobbering of files currently writeable but unopened (-f)
        previewOnly - don't actually unshelve but get the file specs that would be unshelved (-n)
        Returns:
        non-null but possibly empty list of file specs representing the server's response.
        Throws:
        ConnectionException - if the Perforce server is unreachable or is not connected.
        RequestException - if the Perforce server encounters an error during its processing of the request
        AccessException - if the Perforce server denies access to the caller
        See Also:
        IClient.unshelveChangelist(int, java.util.List, int, boolean, boolean)

      • submitShelvedChangelist

        public java.util.List<IFileSpec> submitShelvedChangelist​(int shelvedChangelistId)
                                                  throws P4JavaException
        Description copied from interface: IClient
        Submit a shelved changelist without transferring files or modifying the workspace. The shelved change must be owned by the person submitting the change, but the client may be different. However, files shelved to a stream target may only be submitted by a stream client that is mapped to the target stream. In addition, files shelved to a non-stream target cannot be submitted by a stream client. To submit a shelved change, all files in the shelved change must be up to date and resolved. No files may be open in any workspace at the same change number. Client submit options (ie revertUnchanged, etc) will be ignored. If the submit is successful, the shelved change and files are cleaned up, and are no longer available to be unshelved or submitted.

        This performs a 'p4 submit -e shelvedChange#' command when called.

        Specified by:
        submitShelvedChangelist in interface IClient
        Parameters:
        shelvedChangelistId - the shelved changelist to be submited.
        Returns:
        non-null but possibly empty list of file specs representing the server's response.
        Throws:
        P4JavaException - if an error occurs processing this method and its parameters.
        See Also:
        IClient.submitShelvedChangelist(int)

      • mergeFiles

        public java.util.List<IFileSpec> mergeFiles​(IFileSpec fromFile,
                                            java.util.List<IFileSpec> toFiles,
                                            MergeFilesOptions opts)
                                     throws P4JavaException
        Description copied from interface: IClient
        Merges changes from one set of files (the 'source') into another (the 'target'). It is a simplified form of the 'p4 integrate' command. The semantics of Perforce merges are complex and are not explained here; please consult the main Perforce documentation for file merges and the MergeFilesOptions Javdoc comments for details of the less-commonly-used options.

        Note that depending on the specific options passed-in the fromFile can be null or one file spec; the toFiles list can be null, one or more file specs.

        Specified by:
        mergeFiles in interface IClient
        Parameters:
        fromFile - if not null, use this as the source file.
        toFiles - if not null, use this as the list of target files.
        opts - possibly-null MergeFilesOptions object specifying method options
        Returns:
        non-null list of IFileSpec objects describing the intended or actual merge actions
        Throws:
        P4JavaException - if an error occurs processing this method and its parameters
        See Also:
        IClient.mergeFiles(com.perforce.p4java.core.file.IFileSpec, java.util.List, com.perforce.p4java.option.client.MergeFilesOptions)

      • reconcileFiles

        public java.util.List<IFileSpec> reconcileFiles​(java.util.List<IFileSpec> fileSpecs,
                                                ReconcileFilesOptions opts)
                                         throws P4JavaException
        Description copied from interface: IClient
        Open files for add, delete, and/or edit to reconcile client with workspace changes made outside of Perforce.

        'p4 reconcile' finds unopened files in a client's workspace and detects the following:

        1. files in depot missing from workspace, but still on have list.

        2. files on workspace that are not in depot.

        3. files modified in workpace that are not opened for edit.

        By default, the files matching each condition above in the path are reconciled by opening files for delete (scenario 1), add (scenario 2), and/or edit (scenario 3). The -e, -a, and -d flags may be used to limit to a subset of these operations. If no file arguments are given, reconcile and status default to the current working directory.

        Specified by:
        reconcileFiles in interface IClient
        Parameters:
        fileSpecs - non-null list of files to be opened, in Perforce client or depot or local path format.
        opts - possibly-null ReconcileFilesOptions object specifying method options.
        Returns:
        a non-null but possibly-empty list of IFileSpec objects representing the opened files. Not all fields in these specs will be valid or set.
        Throws:
        P4JavaException - if an error occurs processing this method and its parameters
        See Also:
        IClient.reconcileFiles(java.util.List, com.perforce.p4java.option.client.ReconcileFilesOptions)

      • reconcileFiles

        public void reconcileFiles​(java.util.List<IFileSpec> fileSpecs,
                           ReconcileFilesOptions opts,
                           IStreamingCallback callback,
                           int key)
                    throws P4JavaException
        Description copied from interface: IClient
        Open files for add, delete, and/or edit to reconcile client with workspace changes made outside of Perforce.

        'p4 reconcile' finds unopened files in a client's workspace and detects the following:

        1. files in depot missing from workspace, but still on have list.

        2. files on workspace that are not in depot.

        3. files modified in workpace that are not opened for edit.

        By default, the files matching each condition above in the path are reconciled by opening files for delete (scenario 1), add (scenario 2), and/or edit (scenario 3). The -e, -a, and -d flags may be used to limit to a subset of these operations. If no file arguments are given, reconcile and status default to the current working directory.

        Specified by:
        reconcileFiles in interface IClient
        Parameters:
        fileSpecs - non-null list of files to be opened, in Perforce client or depot or local path format.
        opts - possibly-null ReconcileFilesOptions object specifying method options.
        callback - a non-null IStreamingCallback to be used to process the incoming results.
        key - an opaque integer key that is passed to the IStreamingCallback callback methods to identify the action as being associated with this specific call. representing the opened files. Not all fields in these specs will be valid or set.
        Throws:
        P4JavaException - if an error occurs processing this method and its parameters
        See Also:
        IClient.reconcileFiles(List, ReconcileFilesOptions, IStreamingCallback, int)

      • populateFiles

        public java.util.List<IFileSpec> populateFiles​(IFileSpec fromFile,
                                               java.util.List<IFileSpec> toFiles,
                                               PopulateFilesOptions opts)
                                        throws P4JavaException
        Description copied from interface: IClient
        Branches a set of files (the 'source') into another depot location (the 'target') in a single step. The new files are created immediately, without requiring a 'p4 submit' or a client workspace.

        Note that depending on the specific options passed-in the fromFile can be null or one file spec; the toFiles list can be null, one or more file specs. The full semantics of this operation are found in the main 'p4 help populate' documentation.

        Specified by:
        populateFiles in interface IClient
        Parameters:
        fromFile - if not null, use this as the source file.
        toFiles - if not null, use this as the list of target files.
        opts - possibly-null PopulateFilesOptions object specifying method options.
        Returns:
        non-null (but possibly empty) list of affected files and / or error messages.
        Throws:
        P4JavaException - if an error occurs processing this method and its parameters.
        See Also:
        IClient.populateFiles(com.perforce.p4java.core.file.IFileSpec, java.util.List, com.perforce.p4java.option.client.PopulateFilesOptions)

      • setStreamParentView

        public java.lang.String setStreamParentView​(IStreamSummary.ParentView parentview,
                                            boolean sourceComments)
                                     throws P4JavaException
        Description copied from interface: IClient
        Changes the parent view of clients, current stream. It will change the stream state to opened, and add it to the default change.
        Specified by:
        setStreamParentView in interface IClient
        Parameters:
        parentview - NOINHERIT or INHERIT
        sourceComments - If true add inline source comments to ViewMaps when changing the ParentView field from inherit to noinherit.
        Returns:
        response
        Throws:
        P4JavaException - on error