com.perforce.p4java.option.client
Class SyncOptions

java.lang.Object
  com.perforce.p4java.option.Options
      com.perforce.p4java.option.client.SyncOptions

public class SyncOptions
extends Options

Simple default options object for IClient.sync.

Field Summary

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

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

immutable, optionList, OPTPFX

Constructor Summary

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(String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.

Method Summary

boolean	isClientBypass()
boolean	isForceUpdate()
boolean	isNoUpdate()
boolean	isQuiet()
boolean	isSafetyCheck()
boolean	isServerBypass()
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.
SyncOptions	setClientBypass(boolean clientBypass)
SyncOptions	setForceUpdate(boolean forceUpdate)
SyncOptions	setNoUpdate(boolean noUpdate)
SyncOptions	setQuiet(boolean quiet)
SyncOptions	setSafetyCheck(boolean safetyCheck)
SyncOptions	setServerBypass(boolean serverBypass)

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

applyRule, 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

Options: -f, -n, -k, -p, -q, -s

See Also:

Constant Field Values

forceUpdate

protected boolean forceUpdate

If true, force the update (corresponds to p4 -f flag)

noUpdate

protected boolean noUpdate

If true, don't actually do the update (corresponds to p4 -n flag)

clientBypass

protected boolean clientBypass

If true, bypass the client (corresponds to p4 -k flag)

serverBypass

protected boolean serverBypass

If true, bypass the server (corresponds to p4 -p flag)

quiet

protected boolean quiet

If true, suppresses normal output messages. Messages regarding errors or exceptional conditions are not suppressed. (corresponds to p4 -q flag)

safetyCheck

protected boolean safetyCheck

If true, do a safety check before sending content to the client workspace (corresponds to p4 -s flag)

Constructor Detail

SyncOptions

public SyncOptions()

Default constructor.

SyncOptions

public SyncOptions(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.

See Also:

Options.Options(java.lang.String...)

SyncOptions

public SyncOptions(boolean forceUpdate,
                   boolean noUpdate,
                   boolean clientBypass,
                   boolean serverBypass)

Explicit value constructor.

SyncOptions

public SyncOptions(boolean forceUpdate,
                   boolean noUpdate,
                   boolean clientBypass,
                   boolean serverBypass,
                   boolean safetyCheck)

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)

isForceUpdate

public boolean isForceUpdate()

setForceUpdate

public SyncOptions setForceUpdate(boolean forceUpdate)

isNoUpdate

public boolean isNoUpdate()

setNoUpdate

public SyncOptions setNoUpdate(boolean noUpdate)

isClientBypass

public boolean isClientBypass()

setClientBypass

public SyncOptions setClientBypass(boolean clientBypass)

isServerBypass

public boolean isServerBypass()

setServerBypass

public SyncOptions setServerBypass(boolean serverBypass)

isQuiet

public boolean isQuiet()

setQuiet

public SyncOptions setQuiet(boolean quiet)

isSafetyCheck

public boolean isSafetyCheck()

setSafetyCheck

public SyncOptions setSafetyCheck(boolean safetyCheck)