public class ObliterateFilesOptions extends Options
Modifier and Type | Field and Description |
---|---|
protected boolean |
branchedFirstHeadRevOnly
If true, the '-b' flag restricts files in the argument range to those
that are branched and are both the first revision and the head revision.
|
protected boolean |
executeObliterate
If true, the '-y' flag executes the obliterate operation.
|
static java.lang.String |
OPTIONS_SPECS
Options: -y, -a, -b, -h
|
protected boolean |
skipArchiveSearchRemoval
If true, the '-a' flag skips the archive search and removal phase.
|
protected boolean |
skipHaveSearch
If true, the '-h' flag instructs obliterate not to search db.have for all
possible matching records to delete.
|
immutable, optionList
Constructor and Description |
---|
ObliterateFilesOptions()
Default constructor.
|
ObliterateFilesOptions(boolean executeObliterate,
boolean skipArchiveSearchRemoval,
boolean branchedFirstHeadRevOnly,
boolean skipHaveSearch)
Explicit-value constructor.
|
ObliterateFilesOptions(java.lang.String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.
|
Modifier and Type | Method and Description |
---|---|
boolean |
isBranchedFirstHeadRevOnly() |
boolean |
isExecuteObliterate() |
boolean |
isSkipArchiveSearchRemoval() |
boolean |
isSkipHaveSearch() |
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.
|
ObliterateFilesOptions |
setBranchedFirstHeadRevOnly(boolean branchedFirstHeadRevOnly) |
ObliterateFilesOptions |
setExecuteObliterate(boolean executeObliterate) |
ObliterateFilesOptions |
setSkipArchiveSearchRemoval(boolean skipArchiveSearchRemoval) |
ObliterateFilesOptions |
setSkipHaveSearch(boolean skipHaveSearch) |
getOptions, isImmutable, processFields, setImmutable, setOptions
public static final java.lang.String OPTIONS_SPECS
protected boolean executeObliterate
protected boolean skipArchiveSearchRemoval
Note: this is an 'undoc' flag; use 'p4 help undoc' for more details
protected boolean branchedFirstHeadRevOnly
Note: this is an 'undoc' flag; use 'p4 help undoc' for more details
protected boolean skipHaveSearch
Note: this is an 'undoc' flag; use 'p4 help undoc' for more details
public ObliterateFilesOptions()
public ObliterateFilesOptions(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 ObliterateFilesOptions(boolean executeObliterate, boolean skipArchiveSearchRemoval, boolean branchedFirstHeadRevOnly, boolean skipHaveSearch)
executeObliterate
- executeObliterateskipArchiveSearchRemoval
- skipArchiveSearchRemovalbranchedFirstHeadRevOnly
- branchedFirstHeadRevOnlyskipHaveSearch
- skipHaveSearchpublic 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 isExecuteObliterate()
public ObliterateFilesOptions setExecuteObliterate(boolean executeObliterate)
public boolean isSkipArchiveSearchRemoval()
public ObliterateFilesOptions setSkipArchiveSearchRemoval(boolean skipArchiveSearchRemoval)
public boolean isBranchedFirstHeadRevOnly()
public ObliterateFilesOptions setBranchedFirstHeadRevOnly(boolean branchedFirstHeadRevOnly)
public boolean isSkipHaveSearch()
public ObliterateFilesOptions setSkipHaveSearch(boolean skipHaveSearch)