com.perforce.p4java.option.Options
com.perforce.p4java.option.client.AddFilesOptions
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
public class AddFilesOptions
IClient addFiles method Options definitions.
IClient.addFiles(java.util.List, com.perforce.p4java.option.client.AddFilesOptions)| Field Summary | |
|---|---|
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 added using that charset; corresponds to the undoc '-Q' flag. |
protected String |
fileType
If non-null, the files are added as that filetype. |
protected boolean |
noIgnoreChecking
If true, informs the client that it should not perform any ignore checking. |
protected boolean |
noUpdate
If true, don't actually do the add, just return the files that would have been opened for addition. |
static String |
OPTIONS_SPECS
Options: -n, -c[changelist], -t[filetype], -f, -I, -Q[charset] |
protected boolean |
useWildcards
If true, filenames that contain wildcards are permitted. |
| Fields inherited from class com.perforce.p4java.option.Options |
|---|
immutable, optionList, OPTPFX |
| Constructor Summary | |
|---|---|
AddFilesOptions()
Default constructor. |
|
AddFilesOptions(boolean noUpdate,
int changelistId,
String fileType,
boolean useWildcards)
Explicit-value constructor. |
|
AddFilesOptions(boolean noUpdate,
int changelistId,
String fileType,
boolean useWildcards,
boolean noIgnoreChecking)
Explicit-value constructor. |
|
AddFilesOptions(String... options)
Strings-based constructor; see 'p4 help [command]' for possible options. |
|
| Method Summary | |
|---|---|
int |
getChangelistId()
|
String |
getCharset()
|
String |
getFileType()
|
boolean |
isNoIgnoreChecking()
|
boolean |
isNoUpdate()
|
boolean |
isUseWildcards()
|
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. |
AddFilesOptions |
setChangelistId(int changelistId)
|
AddFilesOptions |
setCharset(String charset)
|
AddFilesOptions |
setFileType(String fileType)
|
AddFilesOptions |
setNoIgnoreChecking(boolean noIgnoreChecking)
|
AddFilesOptions |
setNoUpdate(boolean noUpdate)
|
AddFilesOptions |
setUseWildcards(boolean useWildcards)
|
| 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 |
|---|
public static final String OPTIONS_SPECS
protected boolean noUpdate
protected int changelistId
protected String fileType
protected boolean useWildcards
protected boolean noIgnoreChecking
protected String charset
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 |
|---|
public AddFilesOptions()
public AddFilesOptions(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.Options(java.lang.String...)
public AddFilesOptions(boolean noUpdate,
int changelistId,
String fileType,
boolean useWildcards)
public AddFilesOptions(boolean noUpdate,
int changelistId,
String fileType,
boolean useWildcards,
boolean noIgnoreChecking)
| Method Detail |
|---|
public List<String> processOptions(IServer server)
throws OptionsException
OptionsThe 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 Optionsserver - 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 isNoUpdate()
public AddFilesOptions setNoUpdate(boolean noUpdate)
public int getChangelistId()
public AddFilesOptions setChangelistId(int changelistId)
public String getFileType()
public AddFilesOptions setFileType(String fileType)
public boolean isUseWildcards()
public AddFilesOptions setUseWildcards(boolean useWildcards)
public boolean isNoIgnoreChecking()
public AddFilesOptions setNoIgnoreChecking(boolean noIgnoreChecking)
public String getCharset()
public AddFilesOptions setCharset(String charset)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||