com.perforce.p4java.option.server
Class UpdateUserGroupOptions

java.lang.Object
  com.perforce.p4java.option.Options
      com.perforce.p4java.option.server.UpdateUserGroupOptions

public class UpdateUserGroupOptions
extends Options

Combined Options class for user group create / update / delete methods. Note that not all methods honor all options -- see the individual Javadoc for explanations.

Field Summary

static String	OPTIONS_SPECS Recognized p4 group options; these include only -a.
protected boolean	updateIfOwner If true, allow a user without 'super' access to modify the group only if that user is an 'owner' of that group.

Fields inherited from class com.perforce.p4java.option.Options

immutable, optionList, OPTPFX

Constructor Summary

UpdateUserGroupOptions()
Default constructor -- sets all fields to zero, false, or null.

UpdateUserGroupOptions(boolean updateIfOwner)
Explicit-value constructor.

UpdateUserGroupOptions(String... options)
String-based constructor; possible values are: -a.

Method Summary

boolean	isUpdateIfOwner()
List<String>	processOptions(IServer server) Turn this (specific) options object into a list of strings to be sent to the Perforce server as options for a specific command.
UpdateUserGroupOptions	setUpdateIfOwner(boolean updateIfOwner)

Methods inherited from class com.perforce.p4java.option.Options

applyRule, applyRule, applyRule, getOptions, isImmutable, processFields, setImmutable, setOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPTIONS_SPECS

public static final String OPTIONS_SPECS

Recognized p4 group options; these include only -a.

See Also:

Constant Field Values

updateIfOwner

protected boolean updateIfOwner

If true, allow a user without 'super' access to modify the group only if that user is an 'owner' of that group. Corresponds to -a flag.

Constructor Detail

UpdateUserGroupOptions

public UpdateUserGroupOptions()

Default constructor -- sets all fields to zero, false, or null.

UpdateUserGroupOptions

public UpdateUserGroupOptions(String... options)

String-based constructor; possible values are: -a.

Parameters:

options - string options

UpdateUserGroupOptions

public UpdateUserGroupOptions(boolean updateIfOwner)

Explicit-value constructor.

Method Detail

processOptions

public List<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)

isUpdateIfOwner

public boolean isUpdateIfOwner()

setUpdateIfOwner

public UpdateUserGroupOptions setUpdateIfOwner(boolean updateIfOwner)