com.perforce.p4java.option.client
Class LabelSyncOptions

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

public class LabelSyncOptions
extends Options

Label sync options subclass for use with IClient.labelSync.

See Also:

IClient.labelSync(java.util.List, java.lang.String, com.perforce.p4java.option.client.LabelSyncOptions)

Field Summary

protected boolean	addFiles If true, add the files in fileSpecs to the label (c.f.
protected boolean	deleteFiles If true, delete the files in fileSpecs from the label (c.f.
protected boolean	noUpdate If true, don't actually do the update (c.f.
static String	OPTIONS_SPECS Recognized p4 sync options; these include -n, -a, and -d.

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

immutable, optionList, OPTPFX

Constructor Summary

LabelSyncOptions()
Default constructor -- sets all fields to false.

LabelSyncOptions(boolean noUpdate, boolean addFiles, boolean deleteFiles)
Explicit-value constructor.

LabelSyncOptions(String... options)
String-based constructor; recognizes -n, -d, and -a.

Method Summary

boolean	isAddFiles()
boolean	isDeleteFiles()
boolean	isNoUpdate()
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.
LabelSyncOptions	setAddFiles(boolean addFiles)
LabelSyncOptions	setDeleteFiles(boolean deleteFiles)
LabelSyncOptions	setNoUpdate(boolean noUpdate)

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 sync options; these include -n, -a, and -d.

See Also:

Constant Field Values

noUpdate

protected boolean noUpdate

If true, don't actually do the update (c.f. the p4 -n flag)

addFiles

protected boolean addFiles

If true, add the files in fileSpecs to the label (c.f. the p4 -a flag)

deleteFiles

protected boolean deleteFiles

If true, delete the files in fileSpecs from the label (c.f. the p4 -d flag)

Constructor Detail

LabelSyncOptions

public LabelSyncOptions()

Default constructor -- sets all fields to false.

LabelSyncOptions

public LabelSyncOptions(String... options)

String-based constructor; recognizes -n, -d, and -a.

Parameters:

options - options strings.

LabelSyncOptions

public LabelSyncOptions(boolean noUpdate,
                        boolean addFiles,
                        boolean deleteFiles)

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)

isNoUpdate

public boolean isNoUpdate()

setNoUpdate

public LabelSyncOptions setNoUpdate(boolean noUpdate)

isAddFiles

public boolean isAddFiles()

setAddFiles

public LabelSyncOptions setAddFiles(boolean addFiles)

isDeleteFiles

public boolean isDeleteFiles()

setDeleteFiles

public LabelSyncOptions setDeleteFiles(boolean deleteFiles)