public class SyncOptions extends Options
Modifier and Type | Field and Description |
---|---|
protected boolean |
clientBypass
If true, bypass the client (corresponds to p4 -k flag)
|
protected boolean |
forceUpdate
If true, force the update (corresponds to p4 -f flag)
|
protected boolean |
noUpdate
If true, don't actually do the update (corresponds to p4 -n flag)
|
static java.lang.String |
OPTIONS_SPECS
Options: -f, -n, -k, -p, -q, -s
|
protected boolean |
quiet
If true, suppresses normal output messages.
|
protected boolean |
safetyCheck
If true, do a safety check before sending content to the client
workspace (corresponds to p4 -s flag)
|
protected boolean |
serverBypass
If true, bypass the server (corresponds to p4 -p flag)
|
immutable, optionList
Constructor and Description |
---|
SyncOptions()
Default constructor.
|
SyncOptions(boolean forceUpdate,
boolean noUpdate,
boolean clientBypass,
boolean serverBypass)
Explicit value constructor.
|
SyncOptions(boolean forceUpdate,
boolean noUpdate,
boolean clientBypass,
boolean serverBypass,
boolean safetyCheck)
Explicit value constructor.
|
SyncOptions(java.lang.String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.
|
Modifier and Type | Method and Description |
---|---|
boolean |
isClientBypass() |
boolean |
isForceUpdate() |
boolean |
isNoUpdate() |
boolean |
isQuiet() |
boolean |
isSafetyCheck() |
boolean |
isServerBypass() |
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.
|
SyncOptions |
setClientBypass(boolean clientBypass) |
SyncOptions |
setForceUpdate(boolean forceUpdate) |
SyncOptions |
setNoUpdate(boolean noUpdate) |
SyncOptions |
setQuiet(boolean quiet) |
SyncOptions |
setSafetyCheck(boolean safetyCheck) |
SyncOptions |
setServerBypass(boolean serverBypass) |
getOptions, isImmutable, processFields, setImmutable, setOptions
public static final java.lang.String OPTIONS_SPECS
protected boolean forceUpdate
protected boolean noUpdate
protected boolean clientBypass
protected boolean serverBypass
protected boolean quiet
protected boolean safetyCheck
public SyncOptions()
public SyncOptions(java.lang.String... 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.
options
- optionsOptions(java.lang.String...)
public SyncOptions(boolean forceUpdate, boolean noUpdate, boolean clientBypass, boolean serverBypass)
forceUpdate
- forceUpdatenoUpdate
- noUpdateclientBypass
- clientBypassserverBypass
- serverBypasspublic SyncOptions(boolean forceUpdate, boolean noUpdate, boolean clientBypass, boolean serverBypass, boolean safetyCheck)
forceUpdate
- forceUpdatenoUpdate
- noUpdateclientBypass
- clientBypassserverBypass
- serverBypasssafetyCheck
- safetyCheckpublic java.util.List<java.lang.String> processOptions(IServer server) throws OptionsException
Options
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.
processOptions
in class Options
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...OptionsException
- if an error occurs in options processing that is not some
species of ConnectionException, RequestException,
AccessException, etc.Options.processOptions(com.perforce.p4java.server.IServer)
public boolean isForceUpdate()
public SyncOptions setForceUpdate(boolean forceUpdate)
public boolean isNoUpdate()
public SyncOptions setNoUpdate(boolean noUpdate)
public boolean isClientBypass()
public SyncOptions setClientBypass(boolean clientBypass)
public boolean isServerBypass()
public SyncOptions setServerBypass(boolean serverBypass)
public boolean isQuiet()
public SyncOptions setQuiet(boolean quiet)
public boolean isSafetyCheck()
public SyncOptions setSafetyCheck(boolean safetyCheck)