com.perforce.p4java.option.client
Class ReopenFilesOptions

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

public class ReopenFilesOptions
extends Options

Options-based method options for IClient reopenFiles method(s).

Recognized options (depending non server version, etc.): -c changelist# -t filetype

Field Summary

protected int	changelistId The changelist to be reopened to; if non-negative, specifies which changelist to reopen onto
protected String	fileType If not null, the file is reopened as the given filetype.
static String	OPTIONS_SPECS Recognized p4 opened options; these include -c changelist# -t filetype.

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

immutable, optionList, OPTPFX

Constructor Summary

ReopenFilesOptions()
Default constructor; sets all fields to null, false, zero, or IChangelist.UNKNOWN.

ReopenFilesOptions(int changeListId, String fileType)
Explicit-value constructor.

ReopenFilesOptions(String... options)
String-based constructor; possible values are: -c changelist# -t filetype.

Method Summary

int	getChangelistId()
String	getFileType()
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.
ReopenFilesOptions	setChangelistId(int changeListId)
ReopenFilesOptions	setFileType(String fileType)

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 opened options; these include -c changelist# -t filetype.

See Also:

Constant Field Values

changelistId

protected int changelistId

The changelist to be reopened to; if non-negative, specifies which changelist to reopen onto

fileType

protected String fileType

If not null, the file is reopened as the given filetype.

Constructor Detail

ReopenFilesOptions

public ReopenFilesOptions()

Default constructor; sets all fields to null, false, zero, or IChangelist.UNKNOWN.

ReopenFilesOptions

public ReopenFilesOptions(String... options)

String-based constructor; possible values are: -c changelist# -t filetype.

Parameters:

options - string options

ReopenFilesOptions

public ReopenFilesOptions(int changeListId,
                          String fileType)

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)

getChangelistId

public int getChangelistId()

setChangelistId

public ReopenFilesOptions setChangelistId(int changeListId)

getFileType

public String getFileType()

setFileType

public ReopenFilesOptions setFileType(String fileType)