Package com.perforce.p4java.server.delegator

Interface IFileAnnotateDelegator

All Known Subinterfaces:
IOptionsServer, IServer, IStreamingServer
All Known Implementing Classes:
FileAnnotateDelegator, NtsServerImpl, OneShotServerImpl, RpcServer, Server
public interface IFileAnnotateDelegator
Interface to handle the Annotate command.

  • Method Details

    • getFileAnnotations

      List<IFileAnnotation> getFileAnnotations(List<IFileSpec> fileSpecs, @Nonnull DiffType diffType, boolean allResults, boolean useChangeNumbers, boolean followBranches) throws ConnectionException, RequestException, AccessException
      Parameters:
      fileSpecs - non-null list of file specs to be annotated.
      diffType - If non-null, use the DiffType value to determine whitespace options.
      allResults - If true, include both deleted files and lines no longer present at the head revision; corresponds to the -a flag.
      useChangeNumbers - If true, annotate with change numbers rather than revision numbers with each line; correspond to the -c flag.
      followBranches - If true, follow branches; corresponds to the -f flag.
      Returns:
      list of file annotations
      Throws:
      ConnectionException - connection errors
      RequestException - server request errors
      AccessException - access restrictions

    • getFileAnnotations

      List<IFileAnnotation> getFileAnnotations(List<IFileSpec> fileSpecs, GetFileAnnotationsOptions opts) throws P4JavaException
      Get a list of revision annotations for the specified files.
      Parameters:
      fileSpecs - non-null list of file specs to be annotated.
      opts - GetFileAnnotationsOptions object describing optional parameters; if null, no options are set.
      Returns:
      non-null (but possibly-empty) list of IFileAnnotation objects representing version annotations for the passed-in file specs.
      Throws:
      P4JavaException - if any error occurs in the processing of this method.