Method Detail

• getLabels

  java.util.List<ILabelSummary> getLabels​(java.lang.String user,
                                          int maxLabels,
                                          java.lang.String nameFilter,
                                          java.util.List<IFileSpec> fileList)
                                   throws ConnectionException,
                                          RequestException,
                                          AccessException

  Get a list of Perforce labels, optionally tied to a specific set of files.

  Note that the ILabel objects returned here do not have views associated with them (i.e. the getViewMapping() method will return an empty list. If you need to get the view mapping for a specific label, use the getLabel() method.

  Parameters:

  user - if non-null, limit labels to those owned by the named user

  maxLabels - if larger than zero, return only the first maxLabels (or fewer) qualifying labels

  nameFilter - if not null, limits output to labels whose name matches the nameFilter pattern, e.g. -e 'svr-dev-rel*'

  fileList - if not null, limits its report to labels that contain those files

  Returns:

  non-null (but possibly-empty) list of qualifying Perforce labels

  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

• getLabels

  java.util.List<ILabelSummary> getLabels​(java.util.List<IFileSpec> fileList,
                                          GetLabelsOptions opts)
                                   throws P4JavaException

  Get a list of Perforce labels, optionally tied to a specific set of files.

  Note that the ILabel objects returned here do not have views associated with them (i.e. the getViewMapping() method will return an empty list. If you need to get the view mapping for a specific label, use the getLabel() method.

  Parameters:

  fileList - if not null, limits its report to labels that contain those files

  opts - GetLabelsOptions object describing optional parameters; if null, no options are set.

  Returns:

  non-null (but possibly-empty) list of qualifying Perforce labels

  Throws:

  P4JavaException - if any error occurs in the processing of this method.