public class GetDepotsOptions extends Options
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
caseInsensitiveNameFilter
If non-null, limits output to depots whose name matches (case-insensitive)
the nameFilter pattern.
|
protected java.lang.String |
nameFilter
If not-null, limits qualifying depots to those matching the nameFilter pattern.
|
static java.lang.String |
OPTIONS_SPECS
p4 depots [-t type] [[-e|-E] nameFilter]
|
protected IDepot.DepotType |
type
If not-null, limits qualifying depots to those matching type.
|
immutable, optionList
Constructor and Description |
---|
GetDepotsOptions()
Default constructor; sets all fields to null, zero, or false.
|
GetDepotsOptions(java.lang.String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCaseInsensitiveNameFilter() |
java.lang.String |
getNameFilter() |
IDepot.DepotType |
getType() |
java.util.List<java.lang.String> |
processOptions(IServer server)
Explicit-value constructor.
|
void |
setCaseInsensitiveNameFilter(java.lang.String caseInsensitiveNameFilter) |
GetDepotsOptions |
setNameFilter(java.lang.String nameFilter) |
GetDepotsOptions |
setType(IDepot.DepotType type) |
getOptions, isImmutable, processFields, setImmutable, setOptions
public static final java.lang.String OPTIONS_SPECS
protected IDepot.DepotType type
protected java.lang.String nameFilter
protected java.lang.String caseInsensitiveNameFilter
public GetDepotsOptions()
public GetDepotsOptions(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 java.util.List<java.lang.String> processOptions(IServer server) throws OptionsException
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.public IDepot.DepotType getType()
public GetDepotsOptions setType(IDepot.DepotType type)
public java.lang.String getNameFilter()
public java.lang.String getCaseInsensitiveNameFilter()
public GetDepotsOptions setNameFilter(java.lang.String nameFilter)
public void setCaseInsensitiveNameFilter(java.lang.String caseInsensitiveNameFilter)