Interface IFilesDelegator

All Known Subinterfaces:
IOptionsServer, IServer, IStreamingServer
All Known Implementing Classes:
FilesDelegator, NtsServerImpl, OneShotServerImpl, RpcServer, Server

public interface IFilesDelegator
Interface for an implementation for 'p4 files'.
  • Method Summary

    Modifier and Type
    Method
    Description
    getDepotFiles(List<IFileSpec> fileSpecs, boolean allRevs)
    List all Perforce depot files known to the Perforce server that conform to the passed-in wild-card file specification(s).
    List all Perforce depot files known to the Perforce server that conform to the passed-in wild-card file specification(s).
  • Method Details

    • getDepotFiles

      List<IFileSpec> getDepotFiles(@Nonnull List<IFileSpec> fileSpecs, boolean allRevs) throws ConnectionException, AccessException
      List all Perforce depot files known to the Perforce server that conform to the passed-in wild-card file specification(s).

      If client file names are given as file spec arguments the current Perforce client view mapping is used to list the corresponding depot files, if the client and view exist (if not, the results are undefined).

      Normally, the head revision of each matching file is listed, but you can change this by specifying specific revisions or revision ranges. If the file spec argument includes a revision, then all files as of that revision are returned. If the file spec argument has a revision range, then only files selected by that revision range are returned, and the highest revision in the range is used for each file. If GetDepotFilesOptions.allRevs is true, all revisions within the specific range, rather than just the highest revision in the range, are returned.

      See 'p4 help revisions' for help specifying revisions.

      Note that the IFileSpec objects returned will have null client and local path components.

      Parameters:
      fileSpecs - the file specs
      allRevs - the all revs
      Returns:
      the depot files
      Throws:
      ConnectionException - the connection exception
      AccessException - the access exception
    • getDepotFiles

      List<IFileSpec> getDepotFiles(@Nonnull List<IFileSpec> fileSpecs, GetDepotFilesOptions opts) throws P4JavaException
      List all Perforce depot files known to the Perforce server that conform to the passed-in wild-card file specification(s).

      If client file names are given as file spec arguments the current Perforce client view mapping is used to list the corresponding depot files, if the client and view exist (if not, the results are undefined).

      Normally, the head revision of each matching file is listed, but you can change this by specifying specific revisions or revision ranges. If the file spec argument includes a revision, then all files as of that revision are returned. If the file spec argument has a revision range, then only files selected by that revision range are returned, and the highest revision in the range is used for each file. If GetDepotFilesOptions.allRevs is true, all revisions within the specific range, rather than just the highest revision in the range, are returned.

      See 'p4 help revisions' for help specifying revisions.

      Note that the IFileSpec objects returned will have null client and local path components.

      Parameters:
      fileSpecs - a non-null list of one or more IFileSpecs to be used to qualify Perforce depot files
      opts - GetDepotFilesOptions describing the associated options; if null, no options are set.
      Returns:
      a non-null (but possible empty) list of all qualifying depot files
      Throws:
      P4JavaException - if any error occurs in the processing of this method.