com.perforce.p4java.option.client
Class UnshelveFilesOptions

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

public class UnshelveFilesOptions
extends Options

Options class for the IClient.unshelveFiles method and associated convenience methods.

See Also:

IClient.unshelveFiles(java.util.List, int, int, com.perforce.p4java.option.client.UnshelveFilesOptions)

Field Summary

protected boolean	forceUnshelve If true, force the unshelve operation; corresponds to the -f flag
static String	OPTIONS_SPECS Recognized p4 shelve options; these include -f, -n.
protected boolean	preview If true, preview what would be unshelved without actually changing any files or metadata; corresponds to the -n flag.

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

immutable, optionList, OPTPFX

Constructor Summary

UnshelveFilesOptions()
Default constructor -- sets all fields to false;

UnshelveFilesOptions(boolean forceUnshelve, boolean preview)
Explicit-value constructor.

UnshelveFilesOptions(String... options)
String-based constructor; possible values are: -f, n.

Method Summary

boolean	isForceUnshelve()
boolean	isPreview()
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.
UnshelveFilesOptions	setForceUnshelve(boolean forceUnshelve)
UnshelveFilesOptions	setPreview(boolean preview)

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 shelve options; these include -f, -n.

See Also:

Constant Field Values

forceUnshelve

protected boolean forceUnshelve

If true, force the unshelve operation; corresponds to the -f flag

preview

protected boolean preview

If true, preview what would be unshelved without actually changing any files or metadata; corresponds to the -n flag.

Constructor Detail

UnshelveFilesOptions

public UnshelveFilesOptions()

Default constructor -- sets all fields to false;

UnshelveFilesOptions

public UnshelveFilesOptions(String... options)

String-based constructor; possible values are: -f, n.

Parameters:

options - string options

UnshelveFilesOptions

public UnshelveFilesOptions(boolean forceUnshelve,
                            boolean preview)

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)

isForceUnshelve

public boolean isForceUnshelve()

setForceUnshelve

public UnshelveFilesOptions setForceUnshelve(boolean forceUnshelve)

isPreview

public boolean isPreview()

setPreview

public UnshelveFilesOptions setPreview(boolean preview)