public class ShelveFilesOptions extends Options
Modifier and Type | Field and Description |
---|---|
protected boolean |
deleteFiles
If true, delete incoming files from the shelf; corresponds to the -d flag.
|
protected boolean |
forceShelve
If true, force the shelve operation; corresponds to the -f flag
|
static java.lang.String |
OPTIONS_SPECS
Options: -f, -r, -d, -p
|
protected boolean |
promotesShelvedChangeIfDistributedConfigured
If true, promotes a shelved change from an edge server to a commit
server where it can be accessed by other edge servers participating
in the distributed configuration.
|
protected boolean |
replaceFiles
If true, allow the incoming files to replace the shelved files;
corresponds to the -r flag.
|
immutable, optionList
Constructor and Description |
---|
ShelveFilesOptions()
Default constructor..
|
ShelveFilesOptions(boolean forceShelve,
boolean replaceFiles,
boolean deleteFiles,
boolean promotesShelvedChangeIfDistributedConfigured)
Explicit-value constructor.
|
ShelveFilesOptions(java.lang.String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.
|
Modifier and Type | Method and Description |
---|---|
boolean |
isDeleteFiles() |
boolean |
isForceShelve() |
boolean |
isPromotesShelvedChangeIfDistributedConfigured() |
boolean |
isReplaceFiles() |
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.
|
ShelveFilesOptions |
setDeleteFiles(boolean deleteFiles) |
ShelveFilesOptions |
setForceShelve(boolean forceShelve) |
ShelveFilesOptions |
setPromotesShelvedChangeIfDistributedConfigured(boolean promotesShelvedChangeIfDistributedConfigured) |
ShelveFilesOptions |
setReplaceFiles(boolean replaceFiles) |
getOptions, isImmutable, processFields, setImmutable, setOptions
public static final java.lang.String OPTIONS_SPECS
protected boolean forceShelve
protected boolean replaceFiles
protected boolean promotesShelvedChangeIfDistributedConfigured
protected boolean deleteFiles
public ShelveFilesOptions()
public ShelveFilesOptions(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 ShelveFilesOptions(boolean forceShelve, boolean replaceFiles, boolean deleteFiles, boolean promotesShelvedChangeIfDistributedConfigured)
forceShelve
- forceShelvereplaceFiles
- replaceFilesdeleteFiles
- deleteFilespromotesShelvedChangeIfDistributedConfigured
- promotesShelvedChangeIfDistributedConfiguredpublic 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 isForceShelve()
public ShelveFilesOptions setForceShelve(boolean forceShelve)
public boolean isReplaceFiles()
public ShelveFilesOptions setReplaceFiles(boolean replaceFiles)
public boolean isPromotesShelvedChangeIfDistributedConfigured()
public ShelveFilesOptions setPromotesShelvedChangeIfDistributedConfigured(boolean promotesShelvedChangeIfDistributedConfigured)
public boolean isDeleteFiles()
public ShelveFilesOptions setDeleteFiles(boolean deleteFiles)