Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.perforce.p4java.option.client
Class EditFilesOptions

java.lang.Object
  extended by com.perforce.p4java.option.Options
      extended by com.perforce.p4java.option.client.EditFilesOptions

public class EditFilesOptions
extends Options

Options subclass for use with IClient editFiles method(s).

See Also:
IClient.editFiles(java.util.List, com.perforce.p4java.option.client.EditFilesOptions)

Field Summary
protected  boolean bypassClientUpdate
          If true, bypass updating the client.
protected  int changelistId
          If positive, the opened files are put into the pending changelist identified by changelistId (this changelist must have been previously created for this to succeed).
protected  String charset
          If non-null, the files are edited using that charset; corresponds to the undoc '-Q' flag.
protected  String fileType
          If non-null, the files are added as that filetype.
protected  boolean noUpdate
          If true, don't actually do the edit, just return the files that would have been opened for edit.
static String OPTIONS_SPECS
          Options: -n, -k, -c[changelist], -t[filetype], -Q[charset]
 
Fields inherited from class com.perforce.p4java.option.Options
immutable, optionList, OPTPFX
 
Constructor Summary
EditFilesOptions()
          Default constructor.
EditFilesOptions(boolean noUpdate, boolean bypassClientUpdate, int changelistId, String fileType)
          Explicit-value constructor.
EditFilesOptions(String... options)
          Strings-based constructor; see 'p4 help [command]' for possible options.
 
Method Summary
 int getChangelistId()
           
 String getCharset()
           
 String getFileType()
           
 boolean isBypassClientUpdate()
           
 boolean isNoUpdate()
           
 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.
 EditFilesOptions setBypassClientUpdate(boolean bypassClientUpdate)
           
 EditFilesOptions setChangelistId(int changelistId)
           
 EditFilesOptions setCharset(String charset)
           
 EditFilesOptions setFileType(String fileType)
           
 EditFilesOptions setNoUpdate(boolean noUpdate)
           
 
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: -n, -k, -c[changelist], -t[filetype], -Q[charset]

See Also:
Constant Field Values

noUpdate

protected boolean noUpdate
If true, don't actually do the edit, just return the files that would have been opened for edit. Corresponds to the -n flag.

bypassClientUpdate

protected boolean bypassClientUpdate
If true, bypass updating the client. Corresponds to the -k flag.

changelistId

protected int changelistId
If positive, the opened files are put into the pending changelist identified by changelistId (this changelist must have been previously created for this to succeed). If zero or negative, the file is opened in the 'default' (unnumbered) changelist. Corresponds to the -c flag.

fileType

protected String fileType
If non-null, the files are added as that filetype. See 'p4 help filetypes' to attempt to make any sense of Perforce file types. Corresponds to the -t flag.

charset

protected String charset
If non-null, the files are edited using that charset; corresponds to the undoc '-Q' flag. Please see the 'Versioned character set' section of the 'p4 help undoc' command for more info.

Note that you must set the server.filecharset configurable to 1 in an unicode Perforce server in order to version the charset of individual unicode files along with the filetype.

Constructor Detail

EditFilesOptions

public EditFilesOptions()
Default constructor.

EditFilesOptions

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

EditFilesOptions

public EditFilesOptions(boolean noUpdate,
                        boolean bypassClientUpdate,
                        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)

isNoUpdate

public boolean isNoUpdate()

setNoUpdate

public EditFilesOptions setNoUpdate(boolean noUpdate)

isBypassClientUpdate

public boolean isBypassClientUpdate()

setBypassClientUpdate

public EditFilesOptions setBypassClientUpdate(boolean bypassClientUpdate)

getChangelistId

public int getChangelistId()

setChangelistId

public EditFilesOptions setChangelistId(int changelistId)

getFileType

public String getFileType()

setFileType

public EditFilesOptions setFileType(String fileType)

getCharset

public String getCharset()

setCharset

public EditFilesOptions setCharset(String charset)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2015 Perforce Software. All Rights Reserved.