public class GetPropertyOptions extends Options
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
fields
If non-null, limit the fields that are returned to the tagged format
output fields.
|
protected java.lang.String |
filter
If non-null, limits output to properties matching the filter pattern.
|
protected java.lang.String |
group
If not null, use this as the user group to which this property applies.
|
protected boolean |
listAll
If true, specifies that properties for all users and groups should be
listed.
|
protected int |
max
If greater than zero, limits output to the first 'max' number of
properties.
|
protected java.lang.String |
name
If not null, use this as the name of this property.
|
static java.lang.String |
OPTIONS_SPECS
Options: [-A] [-n name [-s sequence] [-u user | -g group]] [-F filter -T taglist -m max]
|
protected int |
sequence
If greater than zero, use this as the sequence number of this property.
|
protected java.lang.String |
user
If not null, use this as the user to whom this property applies.
|
immutable, optionList
Constructor and Description |
---|
GetPropertyOptions()
Default constructor.
|
GetPropertyOptions(boolean listAll,
java.lang.String name,
int sequence,
java.lang.String user,
java.lang.String group,
java.lang.String filter,
java.lang.String fields,
int max)
Explicit value constructor.
|
GetPropertyOptions(java.lang.String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getFields() |
java.lang.String |
getFilter() |
java.lang.String |
getGroup() |
int |
getMax() |
java.lang.String |
getName() |
int |
getSequence() |
java.lang.String |
getUser() |
boolean |
isListAll() |
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.
|
GetPropertyOptions |
setFields(java.lang.String fields) |
GetPropertyOptions |
setFilter(java.lang.String filter) |
GetPropertyOptions |
setGroup(java.lang.String group) |
GetPropertyOptions |
setListAll(boolean listAll) |
GetPropertyOptions |
setMax(int max) |
GetPropertyOptions |
setName(java.lang.String name) |
GetPropertyOptions |
setSequence(int sequence) |
GetPropertyOptions |
setUser(java.lang.String user) |
getOptions, isImmutable, processFields, setImmutable, setOptions
public static final java.lang.String OPTIONS_SPECS
protected boolean listAll
protected java.lang.String name
protected int sequence
protected java.lang.String user
protected java.lang.String group
protected java.lang.String filter
protected java.lang.String fields
protected int max
public GetPropertyOptions()
public GetPropertyOptions(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 GetPropertyOptions(boolean listAll, java.lang.String name, int sequence, java.lang.String user, java.lang.String group, java.lang.String filter, java.lang.String fields, int max)
listAll
- listAllname
- namesequence
- sequenceuser
- usergroup
- groupfilter
- filterfields
- fieldsmax
- maxpublic 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 boolean isListAll()
public GetPropertyOptions setListAll(boolean listAll)
public java.lang.String getName()
public GetPropertyOptions setName(java.lang.String name)
public int getSequence()
public GetPropertyOptions setSequence(int sequence)
public java.lang.String getUser()
public GetPropertyOptions setUser(java.lang.String user)
public java.lang.String getGroup()
public GetPropertyOptions setGroup(java.lang.String group)
public java.lang.String getFilter()
public GetPropertyOptions setFilter(java.lang.String filter)
public java.lang.String getFields()
public GetPropertyOptions setFields(java.lang.String fields)
public int getMax()
public GetPropertyOptions setMax(int max)