public class GetBranchSpecsOptions extends Options
Modifier and Type | Field and Description |
---|---|
protected java.lang.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 java.lang.String |
nameFilter
If non-null, limits output to branches whose name matches
the nameFilter pattern.
|
static java.lang.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 java.lang.String |
userName
If non-null, limit qualifying branches to those owned by the named user.
|
immutable, optionList
Constructor and Description |
---|
GetBranchSpecsOptions()
Default constructor; sets all fields to null, zero, or false.
|
GetBranchSpecsOptions(boolean showTime,
java.lang.String userName,
java.lang.String caseInsensitiveNameFilter,
int maxResults)
Explicit-value constructor.
|
GetBranchSpecsOptions(java.lang.String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.
|
GetBranchSpecsOptions(java.lang.String userName,
java.lang.String nameFilter,
int maxResults)
Explicit-value constructor.
|
GetBranchSpecsOptions(java.lang.String userName,
java.lang.String nameFilter,
int maxResults,
boolean showTime)
Explicit-value constructor.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCaseInsensitiveNameFilter() |
int |
getMaxResults() |
java.lang.String |
getNameFilter() |
java.lang.String |
getUserName() |
boolean |
isShowTime() |
java.util.List<java.lang.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(java.lang.String caseInsensitiveNameFilter) |
GetBranchSpecsOptions |
setMaxResults(int maxResults) |
GetBranchSpecsOptions |
setNameFilter(java.lang.String nameFilter) |
GetBranchSpecsOptions |
setShowTime(boolean showTime) |
GetBranchSpecsOptions |
setUserName(java.lang.String userName) |
getOptions, isImmutable, processFields, setImmutable, setOptions
public static final java.lang.String OPTIONS_SPECS
protected java.lang.String userName
protected java.lang.String nameFilter
protected java.lang.String caseInsensitiveNameFilter
protected int maxResults
protected boolean showTime
public GetBranchSpecsOptions()
public GetBranchSpecsOptions(java.lang.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
- optionsOptions(java.lang.String...)
public GetBranchSpecsOptions(java.lang.String userName, java.lang.String nameFilter, int maxResults)
userName
- userNamenameFilter
- nameFiltermaxResults
- maxResultspublic GetBranchSpecsOptions(java.lang.String userName, java.lang.String nameFilter, int maxResults, boolean showTime)
userName
- userNamenameFilter
- nameFiltermaxResults
- maxResultsshowTime
- showTimepublic GetBranchSpecsOptions(boolean showTime, java.lang.String userName, java.lang.String caseInsensitiveNameFilter, int maxResults)
showTime
- showTimeuserName
- userNamecaseInsensitiveNameFilter
- caseInsensitiveNameFiltermaxResults
- maxResultspublic java.util.List<java.lang.String> processOptions(IServer server) throws OptionsException
Options
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.
processOptions
in class Options
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...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 java.lang.String getUserName()
public GetBranchSpecsOptions setUserName(java.lang.String userName)
public java.lang.String getNameFilter()
public GetBranchSpecsOptions setNameFilter(java.lang.String nameFilter)
public java.lang.String getCaseInsensitiveNameFilter()
public GetBranchSpecsOptions setCaseInsensitiveNameFilter(java.lang.String caseInsensitiveNameFilter)
public int getMaxResults()
public GetBranchSpecsOptions setMaxResults(int maxResults)
public boolean isShowTime()
public GetBranchSpecsOptions setShowTime(boolean showTime)