Class SwitchClientViewOptions
- java.lang.Object
-
- com.perforce.p4java.option.Options
-
- com.perforce.p4java.option.server.SwitchClientViewOptions
-
public class SwitchClientViewOptions extends Options
Options object for the IOptionsServer switchClientView method.
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
force
If true, tell the server to attempt to force switching of view with opened files; corresponds to the -f flag.static java.lang.String
OPTIONS_SPECS
Options: -f-
Fields inherited from class com.perforce.p4java.option.Options
immutable, optionList
-
-
Constructor Summary
Constructors Constructor Description SwitchClientViewOptions()
Default constructor.SwitchClientViewOptions(boolean force)
Explicit value constructor.SwitchClientViewOptions(java.lang.String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
isForce()
java.util.List<java.lang.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.SwitchClientViewOptions
setForce(boolean force)
-
Methods inherited from class com.perforce.p4java.option.Options
getOptions, isImmutable, processFields, setImmutable, setOptions
-
-
-
-
Field Detail
-
OPTIONS_SPECS
public static final java.lang.String OPTIONS_SPECS
Options: -f- See Also:
- Constant Field Values
-
force
protected boolean force
If true, tell the server to attempt to force switching of view with opened files; corresponds to the -f flag.
-
-
Constructor Detail
-
SwitchClientViewOptions
public SwitchClientViewOptions()
Default constructor.
-
SwitchClientViewOptions
public SwitchClientViewOptions(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...)
-
SwitchClientViewOptions
public SwitchClientViewOptions(boolean force)
Explicit value constructor.- Parameters:
force
- force option
-
-
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 classOptions
- 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)
-
isForce
public boolean isForce()
-
setForce
public SwitchClientViewOptions setForce(boolean force)
-
-