Field Detail

• OPTIONS_SPECS

  public static final java.lang.String OPTIONS_SPECS

  Options: [-A] [-n name [-s sequence] [-u user | -g group]] [-F filter -T taglist -m max]

  See Also:

  Constant Field Values

• listAll

  protected boolean listAll

  If true, specifies that properties for all users and groups should be listed. This option requires the user to have 'admin' access granted by 'p4 protect'. Corresponds to the -A flag.

• name

  protected java.lang.String name

  If not null, use this as the name of this property. Corresponds to the -n flag.

• sequence

  protected int sequence

  If greater than zero, use this as the sequence number of this property. If the sequence is not specified, it defaults to 1. Corresponds to the -s flag.

• user

  protected java.lang.String user

  If not null, use this as the user to whom this property applies. Corresponds to the -u flag.

• group

  protected java.lang.String group

  If not null, use this as the user group to which this property applies. Corresponds to the -g flag.

• filter

  protected java.lang.String filter

  If non-null, limits output to properties matching the filter pattern. The filter is composed of an exact field name and a field value pattern. (i.e. -F"name=test-property*"). This option can only be used with tagged format (ztag). Corresponds to '-F' flag.

• fields

  protected java.lang.String fields

  If non-null, limit the fields that are returned to the tagged format output fields. Separate multiple tagged format output fields with commas (i.e. -T"name,sequence,value,time"). This option can only be used with tagged format (-ztag). Corresponds to '-T' flag.

• max

  protected int max

  If greater than zero, limits output to the first 'max' number of properties. Corresponds to -m flag.

Constructor Detail

• GetPropertyOptions

  public GetPropertyOptions()

  Default constructor.

• GetPropertyOptions

  public GetPropertyOptions​(java.lang.String... options)

  Strings-based constructor; see 'p4 help [command]' for possible 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.

  Parameters:

  options - options

  See Also:

  Options(java.lang.String...)

• GetPropertyOptions

  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)

  Explicit value constructor.

  Parameters:

  listAll - listAll

  name - name

  sequence - sequence

  user - user

  group - group

  filter - filter

  fields - fields

  max - max

Method Detail

• processOptions

  public java.util.List<java.lang.String> processOptions​(IServer server)
                                                  throws OptionsException

  Description copied from class: Options
  Turn this (specific) options object into a list of strings to be sent to the Perforce server as options for a specific command. As a side effect, set the option list associated with this Option to the result.

  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.

  Specified by:

  processOptions in class Options

  Parameters:

  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...

  Returns:

  non-null (but possibly empty) string list representing the normalized Perforce server arguments corresponding to the state of this specific options object.

  Throws:

  OptionsException - if an error occurs in options processing that is not some species of ConnectionException, RequestException, AccessException, etc.

  See Also:

  Options.processOptions(com.perforce.p4java.server.IServer)

• isListAll

  public boolean isListAll()

• setListAll

  public GetPropertyOptions setListAll​(boolean listAll)

• getName

  public java.lang.String getName()

• setName

  public GetPropertyOptions setName​(java.lang.String name)

• getSequence

  public int getSequence()

• setSequence

  public GetPropertyOptions setSequence​(int sequence)

• getUser

  public java.lang.String getUser()

• setUser

  public GetPropertyOptions setUser​(java.lang.String user)

• getGroup

  public java.lang.String getGroup()

• setGroup

  public GetPropertyOptions setGroup​(java.lang.String group)

• getFilter

  public java.lang.String getFilter()

• setFilter

  public GetPropertyOptions setFilter​(java.lang.String filter)

• getFields

  public java.lang.String getFields()

• setFields

  public GetPropertyOptions setFields​(java.lang.String fields)

• getMax

  public int getMax()

• setMax

  public GetPropertyOptions setMax​(int max)