com.perforce.p4java.option.Options
com.perforce.p4java.option.server.GetChangelistsOptions
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
public class GetChangelistsOptions
Options class for IOptionsServer getChangelists method(s).
IOptionsServer.getChangelists(java.util.List, com.perforce.p4java.option.server.GetChangelistsOptions)| Field Summary | |
|---|---|
protected String |
clientName
If non-null, restrict the results to changelists associated with the given client. |
protected boolean |
includeIntegrated
If true, also include any changelists integrated into the specified files (if any). |
protected boolean |
longDesc
If true, produce a non-truncated long version of the description. |
protected int |
maxMostRecent
If positive, restrict the list to the maxMostRecent most recent changelists. |
static String |
OPTIONS_SPECS
Options: -i, -l, -c[client], -m[max], -s[status], -u[user], -f, -L |
protected boolean |
truncateDescriptions
If true, truncate the changelist descriptions to 250 characters if longer; corresponds to -L. |
protected IChangelist.Type |
type
If not null, restrict output to pending, shelved or submitted changelists. |
protected String |
userName
If non-null, restrict the results to changelists associated with the given user name. |
protected boolean |
viewRestricted
If true, enables admins to see restricted changes. |
| Fields inherited from class com.perforce.p4java.option.Options |
|---|
immutable, optionList, OPTPFX |
| Constructor Summary | |
|---|---|
GetChangelistsOptions()
Default constructor. |
|
GetChangelistsOptions(int maxMostRecent,
String clientName,
String userName,
boolean includeIntegrated,
IChangelist.Type type,
boolean longDesc)
Explicit-value constructor. |
|
GetChangelistsOptions(int maxMostRecent,
String clientName,
String userName,
boolean includeIntegrated,
IChangelist.Type type,
boolean longDesc,
boolean viewRestricted)
Explicit-value constructor. |
|
GetChangelistsOptions(int maxMostRecent,
String clientName,
String userName,
boolean includeIntegrated,
IChangelist.Type type,
boolean longDesc,
boolean viewRestricted,
boolean truncateDescriptions)
Explicit-value constructor. |
|
GetChangelistsOptions(String... options)
Strings-based constructor; see 'p4 help [command]' for possible options. |
|
| Method Summary | |
|---|---|
String |
getClientName()
|
int |
getMaxMostRecent()
|
IChangelist.Type |
getType()
|
String |
getUserName()
|
boolean |
isIncludeIntegrated()
|
boolean |
isLongDesc()
|
boolean |
isTruncateDescriptions()
|
boolean |
isViewRestricted()
|
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. |
GetChangelistsOptions |
setClientName(String clientName)
|
GetChangelistsOptions |
setIncludeIntegrated(boolean includeIntegrated)
|
GetChangelistsOptions |
setLongDesc(boolean longDesc)
|
GetChangelistsOptions |
setMaxMostRecent(int maxMostRecent)
|
GetChangelistsOptions |
setTruncateDescriptions(boolean truncateDescriptions)
|
GetChangelistsOptions |
setType(IChangelist.Type type)
|
GetChangelistsOptions |
setUserName(String userName)
|
GetChangelistsOptions |
setViewRestricted(boolean viewRestricted)
|
| 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 int maxMostRecent
protected String clientName
protected String userName
protected boolean includeIntegrated
protected IChangelist.Type type
protected boolean longDesc
protected boolean viewRestricted
protected boolean truncateDescriptions
| Constructor Detail |
|---|
public GetChangelistsOptions()
public GetChangelistsOptions(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 GetChangelistsOptions(int maxMostRecent,
String clientName,
String userName,
boolean includeIntegrated,
IChangelist.Type type,
boolean longDesc)
public GetChangelistsOptions(int maxMostRecent,
String clientName,
String userName,
boolean includeIntegrated,
IChangelist.Type type,
boolean longDesc,
boolean viewRestricted)
public GetChangelistsOptions(int maxMostRecent,
String clientName,
String userName,
boolean includeIntegrated,
IChangelist.Type type,
boolean longDesc,
boolean viewRestricted,
boolean truncateDescriptions)
| 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 int getMaxMostRecent()
public GetChangelistsOptions setMaxMostRecent(int maxMostRecent)
public String getClientName()
public GetChangelistsOptions setClientName(String clientName)
public String getUserName()
public GetChangelistsOptions setUserName(String userName)
public boolean isIncludeIntegrated()
public GetChangelistsOptions setIncludeIntegrated(boolean includeIntegrated)
public IChangelist.Type getType()
public GetChangelistsOptions setType(IChangelist.Type type)
public boolean isLongDesc()
public GetChangelistsOptions setLongDesc(boolean longDesc)
public boolean isViewRestricted()
public GetChangelistsOptions setViewRestricted(boolean viewRestricted)
public boolean isTruncateDescriptions()
public GetChangelistsOptions setTruncateDescriptions(boolean truncateDescriptions)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||