com.perforce.p4java.option.server
Class ObliterateFilesOptions

java.lang.Object
  com.perforce.p4java.option.Options
      com.perforce.p4java.option.server.ObliterateFilesOptions

public class ObliterateFilesOptions
extends Options

Options-based method options for IOptionsServer obliterateFiles method(s).

See Also:

IOptionsServer.obliterateFiles(java.util.List, com.perforce.p4java.option.server.ObliterateFilesOptions)

Field Summary

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

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

immutable, optionList, OPTPFX

Constructor Summary

ObliterateFilesOptions()
Default constructor.

ObliterateFilesOptions(boolean executeObliterate, boolean skipArchiveSearchRemoval, boolean branchedFirstHeadRevOnly, boolean skipHaveSearch)
Explicit-value constructor.

ObliterateFilesOptions(String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.

Method Summary

boolean	isBranchedFirstHeadRevOnly()
boolean	isExecuteObliterate()
boolean	isSkipArchiveSearchRemoval()
boolean	isSkipHaveSearch()
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.
ObliterateFilesOptions	setBranchedFirstHeadRevOnly(boolean branchedFirstHeadRevOnly)
ObliterateFilesOptions	setExecuteObliterate(boolean executeObliterate)
ObliterateFilesOptions	setSkipArchiveSearchRemoval(boolean skipArchiveSearchRemoval)
ObliterateFilesOptions	setSkipHaveSearch(boolean skipHaveSearch)

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: -y, -a, -b, -h

See Also:

Constant Field Values

executeObliterate

protected boolean executeObliterate

If true, the '-y' flag executes the obliterate operation. By default, obliterate displays a preview of the results.

skipArchiveSearchRemoval

protected boolean skipArchiveSearchRemoval

If true, the '-a' flag skips the archive search and removal phase. This phase of obliterate can take a very long time for sites with big archive maps (db.archmap). However, file content is not removed; if the file was a branch, then it's most likely that the archival search is not necessary. This option is safe to use with the '-b' option.

Note: this is an 'undoc' flag; use 'p4 help undoc' for more details

branchedFirstHeadRevOnly

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. This flag is useful for removing old branches while keeping files of interest (files that were modified).

Note: this is an 'undoc' flag; use 'p4 help undoc' for more details

skipHaveSearch

protected boolean skipHaveSearch

If true, the '-h' flag instructs obliterate not to search db.have for all possible matching records to delete. Usually, db.have is one of the largest tables in a repository and consequently this search takes a long time. Do not use this flag when obliterating branches or namespaces for reuse, because the old content on any client will not match the newly-added repository files.

Note: this is an 'undoc' flag; use 'p4 help undoc' for more details

Constructor Detail

ObliterateFilesOptions

public ObliterateFilesOptions()

Default constructor.

ObliterateFilesOptions

public ObliterateFilesOptions(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...)

ObliterateFilesOptions

public ObliterateFilesOptions(boolean executeObliterate,
                              boolean skipArchiveSearchRemoval,
                              boolean branchedFirstHeadRevOnly,
                              boolean skipHaveSearch)

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)

isExecuteObliterate

public boolean isExecuteObliterate()

setExecuteObliterate

public ObliterateFilesOptions setExecuteObliterate(boolean executeObliterate)

isSkipArchiveSearchRemoval

public boolean isSkipArchiveSearchRemoval()

setSkipArchiveSearchRemoval

public ObliterateFilesOptions setSkipArchiveSearchRemoval(boolean skipArchiveSearchRemoval)

isBranchedFirstHeadRevOnly

public boolean isBranchedFirstHeadRevOnly()

setBranchedFirstHeadRevOnly

public ObliterateFilesOptions setBranchedFirstHeadRevOnly(boolean branchedFirstHeadRevOnly)

isSkipHaveSearch

public boolean isSkipHaveSearch()

setSkipHaveSearch

public ObliterateFilesOptions setSkipHaveSearch(boolean skipHaveSearch)