Field Detail

• OPTIONS_SPECS

  public static final java.lang.String OPTIONS_SPECS

  Options: -m[max], -i, -v, -g, -u, -o

  See Also:

  Constant Field Values

• maxGroups

  protected int maxGroups

  If positive, return only the first maxGroups groups. Corresponds to the -m flag.

• indirect

  protected boolean indirect

  If true, also display groups that the specified user or group belongs to indirectly via subgroups. Corresponds to the -i flag.

• displayValues

  protected boolean displayValues

  If true, display the MaxResults, MaxScanRows, MaxLockTime, and Timeout values for the named group. Corresponds to the -v flag.

• groupName

  protected boolean groupName

  If true, indicates that the 'name' argument is a group. Corresponds to the -g flag.

• userName

  protected boolean userName

  If true, indicates that the 'name' argument is a user. Corresponds to the -u flag.

• ownerName

  protected boolean ownerName

  If true, indicates that the 'name' argument is an owner. Corresponds to the -o flag.

Constructor Detail

• GetUserGroupsOptions

  public GetUserGroupsOptions()

  Default constructor.

• GetUserGroupsOptions

  public GetUserGroupsOptions(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...)

• GetUserGroupsOptions

  public GetUserGroupsOptions(int maxGroups,
                              boolean indirect,
                              boolean displayValues)

  Explicit-value constructor.

  Parameters:

  maxGroups - maxGroups

  indirect - indirect

  displayValues - displayValues

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)

• getMaxGroups

  public int getMaxGroups()

• setMaxGroups

  public GetUserGroupsOptions setMaxGroups(int maxGroups)

• isIndirect

  public boolean isIndirect()

• setIndirect

  public GetUserGroupsOptions setIndirect(boolean indirect)

• isDisplayValues

  public boolean isDisplayValues()

• setDisplayValues

  public GetUserGroupsOptions setDisplayValues(boolean displayValues)

• isGroupName

  public boolean isGroupName()

• setGroupName

  public GetUserGroupsOptions setGroupName(boolean groupName)

• isUserName

  public boolean isUserName()

• setUserName

  public GetUserGroupsOptions setUserName(boolean userName)

• isOwnerName

  public boolean isOwnerName()

• setOwnerName

  public GetUserGroupsOptions setOwnerName(boolean ownerName)