Field Detail

• OPTIONS_SPECS

  public static final java.lang.String OPTIONS_SPECS

  Options: -a, -c[changelist], -C[client], -u[user], -m[max], -s, -x, -g

  See Also:

  Constant Field Values

• allClients

  protected boolean allClients

  If true, list opened files in all clients. Normally only files opened by the current client are listed.

• clientName

  protected java.lang.String clientName

  If not null, restrict the list of files to those opened on the named client.

• maxFiles

  protected int maxFiles

  If positive, limit output to the first 'maxFiles' number of files.

• userName

  protected java.lang.String userName

  If not null, restrict the list of files to those opened by the named user.

• changelistId

  protected int changelistId

  If non-negative, restrict the list to files opened under the given changelist#. Normally files in any changelist (including the default) are listed.

• shortOutput

  protected boolean shortOutput

  If true, produce 'short' (no revision number or file type) and optimized output when used with the -a (all clients) option. For large repositories '-a' can take a long time when compared to '-a -s' options.

• exclusiveOpened

  protected boolean exclusiveOpened

  In multi-server environments, list all open files that have the +l filetype (exclusive open) over all servers. This option implies the -a option. Similar to -x option

• openedOnCommitServer

  protected boolean openedOnCommitServer

  List files that are opened on the commit server in a multi-server installation. This allows a user on an edge server to track files that might be locked globally on the commit server. Similar to -g option

Constructor Detail

• OpenedFilesOptions

  public OpenedFilesOptions()

  Default constructor.

• OpenedFilesOptions

  public OpenedFilesOptions​(java.lang.String... options)

  Strings-based constructor; see 'p4 help [command]' for possible options.

  WARNING: you should not pass more than one option or argument in each string parameter. Each option or argument should be passed-in as its own separate string parameter, without any spaces between the option and the option value (if any).

  NOTE: setting options this way always bypasses the internal options values, and getter methods against the individual values corresponding to the strings passed in to this constructor will not normally reflect the string's setting. Do not use this constructor unless you know what you're doing and / or you do not also use the field getters and setters.

  Parameters:

  options - options

  See Also:

  Options(java.lang.String...)

• OpenedFilesOptions

  public OpenedFilesOptions​(boolean allClients,
                            java.lang.String clientName,
                            int maxFiles,
                            java.lang.String userName,
                            int changelistId)

  Explicit-value constructor.

  Parameters:

  allClients - allClients

  clientName - clientName

  maxFiles - maxFiles

  userName - userName

  changelistId - changelistId

Method Detail

• processOptions

  public java.util.List<java.lang.String> processOptions​(IServer server)
                                                  throws OptionsException

  Description copied from class: Options
  Turn this (specific) options object into a list of strings to be sent to the Perforce server as options for a specific command. As a side effect, set the option list associated with this Option to the result.

  The method is used by the server object to generate the string-based arguments expected by the Perforce server corresponding to the state of this method-specific options object. Will return an empty list if there are no "interesting" options set or available. May simply return the superclass options string list if is non-null, but that behaviour is neither guaranteed nor required.

  Note that this method is not intended to be called directly by users but by the underlying P4Java plumbing; odd results may occur if this method is called in other contexts.

  Specified by:

  processOptions in class Options

  Parameters:

  server - possibly-null IServer representing the Perforce server the options are to be used against. If this parameter is null, it is acceptable to throw an OptionsException, but it is also possible to ignore it and do the best you can with what you've got...

  Returns:

  non-null (but possibly empty) string list representing the normalized Perforce server arguments corresponding to the state of this specific options object.

  Throws:

  OptionsException - if an error occurs in options processing that is not some species of ConnectionException, RequestException, AccessException, etc.

  See Also:

  Options.processOptions(com.perforce.p4java.server.IServer)

• isAllClients

  public boolean isAllClients()

• setAllClients

  public OpenedFilesOptions setAllClients​(boolean allClients)

• getClientName

  public java.lang.String getClientName()

• setClientName

  public OpenedFilesOptions setClientName​(java.lang.String clientName)

• getMaxFiles

  public int getMaxFiles()

• setMaxFiles

  public OpenedFilesOptions setMaxFiles​(int maxFiles)

• getUserName

  public java.lang.String getUserName()

• setUserName

  public OpenedFilesOptions setUserName​(java.lang.String userName)

• getChangelistId

  public int getChangelistId()

• setChangelistId

  public OpenedFilesOptions setChangelistId​(int changelistId)

• isShortOutput

  public boolean isShortOutput()

• setShortOutput

  public OpenedFilesOptions setShortOutput​(boolean shortOutput)

• isExclusiveOpened

  public boolean isExclusiveOpened()

• setExclusiveOpened

  public OpenedFilesOptions setExclusiveOpened​(boolean exclusiveOpened)

• isOpenedOnCommitServer

  public boolean isOpenedOnCommitServer()

• setOpenedOnCommitServer

  public OpenedFilesOptions setOpenedOnCommitServer​(boolean openedOnCommitServer)