com.perforce.p4java.option.Options
com.perforce.p4java.option.server.GetBranchSpecsOptions
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
public class GetBranchSpecsOptions
Options class for IOptionsServer.getBranchSpecs method.
IOptionsServer.getBranchSpecs(com.perforce.p4java.option.server.GetBranchSpecsOptions)| Field Summary | |
|---|---|
protected String |
caseInsensitiveNameFilter
If non-null, limits output to branches whose name matches (case-insensitive) the nameFilter pattern. |
protected int |
maxResults
If greater than zero, limit output to the first maxResults number of branches. |
protected String |
nameFilter
If non-null, limits output to branches whose name matches the nameFilter pattern. |
static String |
OPTIONS_SPECS
Options: -u[user], -e[nameFilter], -E[nameFilter], -m[max], -t |
protected boolean |
showTime
If true, displays the time as well as the date. |
protected String |
userName
If non-null, limit qualifying branches to those owned by the named user. |
| Fields inherited from class com.perforce.p4java.option.Options |
|---|
immutable, optionList, OPTPFX |
| Constructor Summary | |
|---|---|
GetBranchSpecsOptions()
Default constructor; sets all fields to null, zero, or false. |
|
GetBranchSpecsOptions(boolean showTime,
String userName,
String caseInsensitiveNameFilter,
int maxResults)
Explicit-value constructor. |
|
GetBranchSpecsOptions(String... options)
Strings-based constructor; see 'p4 help [command]' for possible options. |
|
GetBranchSpecsOptions(String userName,
String nameFilter,
int maxResults)
Explicit-value constructor. |
|
GetBranchSpecsOptions(String userName,
String nameFilter,
int maxResults,
boolean showTime)
Explicit-value constructor. |
|
| Method Summary | |
|---|---|
String |
getCaseInsensitiveNameFilter()
|
int |
getMaxResults()
|
String |
getNameFilter()
|
String |
getUserName()
|
boolean |
isShowTime()
|
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. |
GetBranchSpecsOptions |
setCaseInsensitiveNameFilter(String caseInsensitiveNameFilter)
|
GetBranchSpecsOptions |
setMaxResults(int maxResults)
|
GetBranchSpecsOptions |
setNameFilter(String nameFilter)
|
GetBranchSpecsOptions |
setShowTime(boolean showTime)
|
GetBranchSpecsOptions |
setUserName(String userName)
|
| 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 String userName
protected String nameFilter
protected String caseInsensitiveNameFilter
protected int maxResults
protected boolean showTime
| Constructor Detail |
|---|
public GetBranchSpecsOptions()
public GetBranchSpecsOptions(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 GetBranchSpecsOptions(String userName,
String nameFilter,
int maxResults)
public GetBranchSpecsOptions(String userName,
String nameFilter,
int maxResults,
boolean showTime)
public GetBranchSpecsOptions(boolean showTime,
String userName,
String caseInsensitiveNameFilter,
int maxResults)
| 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 String getUserName()
public GetBranchSpecsOptions setUserName(String userName)
public String getNameFilter()
public GetBranchSpecsOptions setNameFilter(String nameFilter)
public String getCaseInsensitiveNameFilter()
public GetBranchSpecsOptions setCaseInsensitiveNameFilter(String caseInsensitiveNameFilter)
public int getMaxResults()
public GetBranchSpecsOptions setMaxResults(int maxResults)
public boolean isShowTime()
public GetBranchSpecsOptions setShowTime(boolean showTime)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||